diff --git a/docs/asciidoc/functions.adoc b/docs/asciidoc/functions.adoc index a74a91b5bd..28a05ae822 100644 --- a/docs/asciidoc/functions.adoc +++ b/docs/asciidoc/functions.adoc @@ -1,6 +1,6 @@ [[user-defined-functions]] = User Defined Functions -:description: This chapter describes gives an overview of user defined features, and summarises the functions in the APOC library. +:description: This chapter describes gives an overview of user defined features, and summarises the functions in the APOC Extended library. diff --git a/docs/asciidoc/jmh.adoc b/docs/asciidoc/jmh.adoc index f0738b8cc2..e2b32cb72d 100644 --- a/docs/asciidoc/jmh.adoc +++ b/docs/asciidoc/jmh.adoc @@ -1,7 +1,7 @@ [[jmh]] = Usage of JMH in apoc -The APOC library uses http://openjdk.java.net/projects/code-tools/jmh/[JMH] for micro benchmarking. You'll find the +The APOC Extended library uses http://openjdk.java.net/projects/code-tools/jmh/[JMH] for micro benchmarking. You'll find the source code for the benchmarks in src/jmh/main. We use the https://github.com/melix/jmh-gradle-plugin[Gradle JMH plugin] to configure JMH and run the benchmarks. diff --git a/docs/asciidoc/modules/ROOT/pages/config/index.adoc b/docs/asciidoc/modules/ROOT/pages/config/index.adoc index 1d83dc6182..9d2ea2136f 100644 --- a/docs/asciidoc/modules/ROOT/pages/config/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/config/index.adoc @@ -1,6 +1,6 @@ [[config]] = Configuration Options -:description: This chapter gives an overview of all the configuration options used by the APOC library. +:description: This chapter gives an overview of all the configuration options used by the APOC Extended library. @@ -17,7 +17,7 @@ The order of this table matches their config option precedence. E.g. any env set [NOTE] ==== -APOC internally relies on Apache commons-config for resolving config settings. +APOC Extended internally relies on Apache commons-config for resolving config settings. The meta-configuration is located in `src/main/resources/apoc-config.xml`. ==== diff --git a/docs/asciidoc/modules/ROOT/pages/cypher-execution/index.adoc b/docs/asciidoc/modules/ROOT/pages/cypher-execution/index.adoc index 639ca6341e..11084ffaf2 100644 --- a/docs/asciidoc/modules/ROOT/pages/cypher-execution/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/cypher-execution/index.adoc @@ -1,6 +1,6 @@ [[cypher-execution]] = Cypher Execution -:description: This chapter describes Cypher Execution procedures in the APOC library. +:description: This chapter describes Cypher Execution procedures in the APOC Extended library. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/bolt-neo4j.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/bolt-neo4j.adoc index 07a13b6f81..57c1af02cf 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/bolt-neo4j.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/bolt-neo4j.adoc @@ -76,7 +76,7 @@ In addition, the `apoc.bolt.load.fromLocal` can have: == Install Dependencies -The Bolt procedures have dependencies on a client library that is not included in the APOC Library. +The Bolt procedures have dependencies on a client library that is not included in the APOC Extended library. You can download it from https://repo1.maven.org/maven2/org/neo4j/driver/neo4j-java-driver-slim/4.4.5/neo4j-java-driver-slim-4.4.5.jar[mvnrepository] or https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-bolt-dependencies-{apoc-release}.jar[apoc repository]. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/couchbase.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/couchbase.adoc index e383beebc7..4690753098 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/couchbase.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/couchbase.adoc @@ -24,7 +24,7 @@ include::example$generated-documentation/apoc.couchbase.query.adoc[] (Tested with CB Enterprise 5.5.3) -The Couchbase procedures have dependencies on a client library that is not included in the APOC Library. +The Couchbase procedures have dependencies on a client library that is not included in the APOC Extended library. This dependency is included in https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-couchbase-dependencies-{apoc-release}.jar[apoc-couchbase-dependencies-{apoc-release}.jar^], which can be downloaded from the https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/tag/{apoc-release}[releases page^]. Once that file is downloaded, it should be placed in the `plugins` directory and the Neo4j Server restarted. diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/index.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/index.adoc index 1069b58e21..37a061603f 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/index.adoc @@ -1,10 +1,10 @@ [[database-integration]] = Database Integration -:description: This chapter describes data integration procedures in the APOC library. +:description: This chapter describes data integration procedures in the APOC Extended library. -The APOC library adds support for integrating with other databases, including relational databases (via JDBC), MongoDB, Elastic, and Couchbase. +The APOC Extended library adds support for integrating with other databases, including relational databases (via JDBC), MongoDB, Elastic, and Couchbase. It also has support for importing data from LDAP directories and executing queries against other Neo4j databases. For more information on how to use these procedures, see: diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/redis.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/redis.adoc index 6c44529207..ea30f0a41e 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-integration/redis.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-integration/redis.adoc @@ -43,7 +43,7 @@ Here is a list of all available Redis procedures: [[redis-dependencies]] == Install Dependencies -The Redis procedures have dependencies on a client library that is not included in the APOC Library. +The Redis procedures have dependencies on a client library that is not included in the APOC Extended library. You can download it from https://github.com/lettuce-io/lettuce-core/releases/tag/6.1.1.RELEASE[the lettuce-core repository](except for `netty` jars because they are already included within neo4j) or https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-redis-dependencies-{apoc-release}.jar[apoc repository] Once that file is downloaded, it should be placed in the `plugins` directory and the Neo4j Server restarted. diff --git a/docs/asciidoc/modules/ROOT/pages/database-introspection/index.adoc b/docs/asciidoc/modules/ROOT/pages/database-introspection/index.adoc index 9f44d95413..1f62a701fc 100644 --- a/docs/asciidoc/modules/ROOT/pages/database-introspection/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/database-introspection/index.adoc @@ -4,7 +4,7 @@ -The APOC library adds extra tools for introspecting the database. +The APOC Extended library adds extra tools for introspecting the database. For more on these procedures, see: diff --git a/docs/asciidoc/modules/ROOT/pages/export/index.adoc b/docs/asciidoc/modules/ROOT/pages/export/index.adoc index 5887770570..46db56d004 100644 --- a/docs/asciidoc/modules/ROOT/pages/export/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/export/index.adoc @@ -1,13 +1,13 @@ [[export]] = Export -:description: This chapter describes procedures in the APOC library that can be used to export data from Neo4j. +:description: This chapter describes procedures in the APOC Extended library that can be used to export data from Neo4j. Neo4j supports exporting whole databases via the https://neo4j.com/docs/operations-manual/current/backup/performing/[backup^] and https://neo4j.com/docs/operations-manual/current/tools/dump-load/[dump^] commands. -It doesn't have support for exporting sub graphs or exporting data into standard data formats, which is where the APOC library comes in. +It doesn't have support for exporting sub graphs or exporting data into standard data formats, which is where the APOC Extended library comes in. -APOC adds support for exporting data into various data formats, including JSON, CSV, GraphML, and Cypher script. +APOC Extended adds support for exporting data into various data formats, including JSON, CSV, GraphML, and Cypher script. In addition to exporting data in these formats, we can choose to export the whole database, specified nodes and relationships, a virtual graph, or the results of a Cypher query. diff --git a/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc b/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc index e59eeeb776..4f5c08b8fa 100644 --- a/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/general-considerations/index.adoc @@ -1,12 +1,12 @@ [[general-considerations]] = General considerations -:description: This chapter describes a list of information to consider using the APOC library. +:description: This chapter describes a list of information to consider using the APOC Extended library. -To use the APOC library it's necessary to consider the following issues. +To use the APOC Extended library, it is necessary to consider the following issues. .Memory tracker -The APOC procedures (and in general, the Neo4j procedures), currently are not detected by Neo4j Memory Tracker. +The APOC Extended procedures (and in general, the Neo4j procedures), currently are not detected by Neo4j Memory Tracker. This means that, for example, the apoc.path.expand procedure doesn't stop if `dbms.memory.transaction.database_max_size` is reached, and we cannot use the `SHOW TRANSACTIONS yield currentQuery, estimatedUsedHeapMemory` command to monitor the memory usage of the query. diff --git a/docs/asciidoc/modules/ROOT/pages/graph-updates/index.adoc b/docs/asciidoc/modules/ROOT/pages/graph-updates/index.adoc index 0457750dc0..847f5a54ca 100644 --- a/docs/asciidoc/modules/ROOT/pages/graph-updates/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/graph-updates/index.adoc @@ -4,7 +4,7 @@ -The APOC library adds extra functionality for writing to the database. +The APOC Extended library adds extra functionality for writing to the database. For more information on how to use these procedures, see: diff --git a/docs/asciidoc/modules/ROOT/pages/import/index.adoc b/docs/asciidoc/modules/ROOT/pages/import/index.adoc index f9d44ee830..64acac8815 100644 --- a/docs/asciidoc/modules/ROOT/pages/import/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/import/index.adoc @@ -1,10 +1,10 @@ [[import]] = Import -:description: This chapter describes procedures in the APOC library that can be used to import data into Neo4j. +:description: This chapter describes procedures in the APOC Extended library that can be used to import data into Neo4j. -The APOC library adds support for importing data from various data formats, including JSON, XML, and XLS. +The APOC Extended library adds support for importing data from various data formats, including JSON, XML, and XLS. For more information on these procedures, see: diff --git a/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc b/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc index 8e54c56c40..4334c83c99 100644 --- a/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc +++ b/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc @@ -37,7 +37,7 @@ include::partial$s3-protocol.adoc[] == Using hdfs protocol -To use the hdfs protocol we need to download and copy the additional jars not included in the APOC Library. +To use the hdfs protocol we need to download and copy the additional jars not included in the APOC Extended library. We can download it from https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-redis-dependencies-{apoc-release}.jar[this link] or locally downloading the apoc repository: ---- git clone http://github.com/neo4j-contrib/neo4j-apoc-procedures diff --git a/docs/asciidoc/modules/ROOT/pages/index.adoc b/docs/asciidoc/modules/ROOT/pages/index.adoc index 4649fc9bdf..525bee16f0 100644 --- a/docs/asciidoc/modules/ROOT/pages/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/index.adoc @@ -18,11 +18,11 @@ For the officially supported APOC Core, go to the https://neo4j.com/docs/apoc/{b The guide covers the following areas: -* xref::introduction/index.adoc[] -- An Introduction to the APOC library. -* xref::installation/index.adoc[] -- Installation instructions for the library. +* xref::introduction/index.adoc[] -- An Introduction to the APOC Extended library. +* xref::installation/index.adoc[] -- Installation instructions for the APOC Extended library. * xref::usage/index.adoc[] -- A usage example. -* xref::overview/index.adoc[] -- A list of all APOC procedures and functions. -* xref::config/index.adoc[] -- Configuration options used by the library. +* xref::overview/index.adoc[] -- A list of all APOC Extended procedures and functions. +* xref::config/index.adoc[] -- Configuration options used by the APOC Extended library. * xref::import/index.adoc[] -- A detailed guide to procedures that can be used to import data from different formats including JSON, CSV, and XLS. * xref::export/index.adoc[] -- A detailed guide to procedures that can be used to export data to different formats including JSON, CSV, GraphML, and Gephi. * xref::database-integration/index.adoc[] -- A detailed guide to procedures that can be used to integrate with other databases including relational databases, MongoDB, Couchbase, and ElasticSearch. diff --git a/docs/asciidoc/modules/ROOT/pages/introduction/index.adoc b/docs/asciidoc/modules/ROOT/pages/introduction/index.adoc index dcac11a9a1..d28ecc9ff9 100644 --- a/docs/asciidoc/modules/ROOT/pages/introduction/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/introduction/index.adoc @@ -1,6 +1,6 @@ [[introduction]] = Introduction -:description: This chapter provides an introduction to the APOC library, and instructions for installation and use. +:description: This chapter provides an introduction to the APOC Extended library, and instructions for installation and use. @@ -35,7 +35,7 @@ http://matrix.wikia.com/wiki/Apoc[Apoc^] was the technician and driver on board == APOC Editions - Core and Extended -Starting from Neo4j 4.1.1, there are two available versions of the APOC Library: +Starting from Neo4j 4.1.1, there are two available versions of the APOC library: _APOC Core_ :: battle hardened procedures and functions that don't have external dependencies or require configuration. This is also the based of the functionality available in https://neo4j.com/aura[Neo4j AuraDB^] which lists the https://neo4j.com/docs/aura/current/getting-started/apoc/[available APOC surface in their docs^]. _APOC Extended_ :: contains additional procedures and functions, which is available when you self-host the database and add the apoc-extended jar. @@ -43,4 +43,4 @@ _APOC Extended_ :: contains additional procedures and functions, which is availa A list of functions and procedures in _APOC Extended_ can be found in xref::overview/index.adoc[]. -Starting from Neo4j 5.0.0, APOC core and extended are split into 2 separate repos, with only core being officially supported by Neo4j. \ No newline at end of file +Starting from Neo4j 5.0.0, APOC Core and Extended are split into 2 separate repos, with only Core being officially supported by Neo4j. \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/misc/index.adoc b/docs/asciidoc/modules/ROOT/pages/misc/index.adoc index 88d43d4f80..9cc62bfb03 100644 --- a/docs/asciidoc/modules/ROOT/pages/misc/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/misc/index.adoc @@ -1,6 +1,6 @@ [[misc]] = Miscellaneous -:description: This chapter describes miscellaneous functions and procedures in the APOC library. +:description: This chapter describes miscellaneous functions and procedures in the APOC Extended library. diff --git a/docs/asciidoc/modules/ROOT/pages/operational/index.adoc b/docs/asciidoc/modules/ROOT/pages/operational/index.adoc index 8c1dad667f..47ff1f8d5e 100644 --- a/docs/asciidoc/modules/ROOT/pages/operational/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/operational/index.adoc @@ -1,6 +1,6 @@ [[operational]] = Operational -:description: This chapter describes operational procedures in the APOC library. +:description: This chapter describes operational procedures in the APOC Extended library. diff --git a/docs/asciidoc/modules/ROOT/pages/overview/index.adoc b/docs/asciidoc/modules/ROOT/pages/overview/index.adoc index a96c63a7f3..94bda792b4 100644 --- a/docs/asciidoc/modules/ROOT/pages/overview/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/overview/index.adoc @@ -1,6 +1,6 @@ [[overview]] = Procedures & Functions -:description: This chapter provides a reference of all the procedures and functions in the APOC library. +:description: This chapter provides a reference of all the procedures and functions in the APOC Extended library. [WARNING] diff --git a/docs/asciidoc/modules/ROOT/pages/transaction/index.adoc b/docs/asciidoc/modules/ROOT/pages/transaction/index.adoc index 8cfd35de82..e55cb3cc01 100644 --- a/docs/asciidoc/modules/ROOT/pages/transaction/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/transaction/index.adoc @@ -1,6 +1,6 @@ [[transaction]] = List of procedures with its own transaction -:description: This chapter describes the list of procedures that start their own transaction in the APOC library. +:description: This chapter describes the list of procedures that start their own transaction in the APOC Extended library. The list of procedures that start their own transaction: diff --git a/docs/asciidoc/modules/ROOT/pages/virtual-resource/index.adoc b/docs/asciidoc/modules/ROOT/pages/virtual-resource/index.adoc index c5ea2db3e2..1f1e5fcabc 100644 --- a/docs/asciidoc/modules/ROOT/pages/virtual-resource/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/virtual-resource/index.adoc @@ -13,7 +13,7 @@ This is "time-series data", and you may not want to import it and persist it in accessing that information on-demand at query time and combining it seamlessly with the network topology data in your graph. ==== -The APOC library supports the definition of a catalog of virtual resources. A virtual resource is an external data source that neo4j can use to query and retrieve data on demand presenting it as virtual nodes enriching the data stored in the graph. +The APOC Extended library supports the definition of a catalog of virtual resources. A virtual resource is an external data source that neo4j can use to query and retrieve data on demand presenting it as virtual nodes enriching the data stored in the graph. The Virtual Resource Catalog feature combines two APOC elements: * The xref::import/index.adoc[apoc.load.* procedures] that query data from external sources. diff --git a/docs/asciidoc/modules/ROOT/partials/docker.adoc b/docs/asciidoc/modules/ROOT/partials/docker.adoc index 01a856861d..50de3aa6a8 100644 --- a/docs/asciidoc/modules/ROOT/partials/docker.adoc +++ b/docs/asciidoc/modules/ROOT/partials/docker.adoc @@ -11,7 +11,7 @@ This feature is intended to facilitate using APOC in development environments, b Download the APOC release matching our Neo4j version and, copy it to a local folder, and supply it as a data volume mounted at `/plugins`. -.The following downloads the APOC Library into the `plugins` directory and then mounts that folder to the Neo4j Docker container +.The following downloads the APOC Extended library into the `plugins` directory and then mounts that folder to the Neo4j Docker container [source,bash,subs=attributes] ---- mkdir plugins diff --git a/docs/asciidoc/modules/ROOT/partials/email-dependencies.adoc b/docs/asciidoc/modules/ROOT/partials/email-dependencies.adoc index ae65ed928f..a3bbc8035c 100644 --- a/docs/asciidoc/modules/ROOT/partials/email-dependencies.adoc +++ b/docs/asciidoc/modules/ROOT/partials/email-dependencies.adoc @@ -1,4 +1,4 @@ -This procedure has a dependency on an email library that is not included in the APOC Library. +This procedure has a dependency on an email library that is not included in the APOC Extended library. The dependency is included in https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-email-dependencies-{apoc-release}.jar[apoc-email-dependencies-{apoc-release}.jar^], which can be downloaded from the https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/tag/{apoc-release}[releases page^]. Once that file is downloaded, it should be placed in the `plugins` directory and the Neo4j Server restarted. \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/partials/mongodb-dependencies.adoc b/docs/asciidoc/modules/ROOT/partials/mongodb-dependencies.adoc index 78dd3f6f3c..3071660968 100644 --- a/docs/asciidoc/modules/ROOT/partials/mongodb-dependencies.adoc +++ b/docs/asciidoc/modules/ROOT/partials/mongodb-dependencies.adoc @@ -1,4 +1,4 @@ -The Mongo procedures have dependencies on a client library that is not included in the APOC Library. +The Mongo procedures have dependencies on a client library that is not included in the APOC Extended library. This dependency is included in https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-mongodb-dependencies-{apoc-release}.jar[apoc-mongodb-dependencies-{apoc-release}.jar^], which can be downloaded from the https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/tag/{apoc-release}[releases page^]. Once that file is downloaded, it should be placed in the `plugins` directory and the Neo4j Server restarted. diff --git a/docs/asciidoc/modules/ROOT/partials/nlp-dependencies.adoc b/docs/asciidoc/modules/ROOT/partials/nlp-dependencies.adoc index 85d6b2e82a..77a8816e0d 100644 --- a/docs/asciidoc/modules/ROOT/partials/nlp-dependencies.adoc +++ b/docs/asciidoc/modules/ROOT/partials/nlp-dependencies.adoc @@ -1,4 +1,4 @@ -The NLP procedures have dependencies on Kotlin and client libraries that are not included in the APOC Library. +The NLP procedures have dependencies on Kotlin and client libraries that are not included in the APOC Extended library. These dependencies are included in https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-nlp-dependencies-{apoc-release}.jar[apoc-nlp-dependencies-{apoc-release}.jar^], which can be downloaded from the https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/tag/{apoc-release}[releases page^]. Once that file is downloaded, it should be placed in the `plugins` directory and the Neo4j Server restarted. \ No newline at end of file