diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index f7979db1e..3e130954b 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -80,8 +80,11 @@ ** xref:configuration/ports.adoc[] ** xref:configuration/connectors.adoc[] ** xref:configuration/set-initial-password.adoc[] +** xref:configuration/neo4j-admin-memrec.adoc[] ** xref:configuration/plugins.adoc[Plugins] ** xref:configuration/dynamic-settings.adoc[] +** xref:configuration/migrate-configuration.adoc[] +** xref:configuration/validate-config.adoc[] ** xref:configuration/configuration-settings.adoc[] *** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings] *** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings] @@ -103,6 +106,8 @@ *** xref:configuration/configuration-settings.adoc#_transaction_settings[Transaction settings] *** xref:configuration/configuration-settings.adoc#_transaction_log_settings[Transaction log settings] +* xref:import.adoc[] + * xref:database-administration/index.adoc[] ** xref:database-administration/syntax.adoc[] ** Standard databases @@ -112,6 +117,8 @@ *** xref:database-administration/standard-databases/listing-databases.adoc[] *** xref:database-administration/standard-databases/alter-databases.adoc[] *** xref:database-administration/standard-databases/delete-databases.adoc[] +*** xref:database-administration/standard-databases/migrate-database.adoc[] +*** xref:database-administration/standard-databases/upload-to-aura.adoc[] *** xref:database-administration/standard-databases/wait-options.adoc[] *** xref:database-administration/standard-databases/configuration-parameters.adoc[] *** xref:database-administration/standard-databases/errors.adoc[] @@ -135,6 +142,7 @@ ** xref:database-internals/transaction-logs.adoc[] ** xref:database-internals/checkpointing.adoc[] ** xref:database-internals/store-formats.adoc[] +** xref:database-internals/neo4j-admin-store-info.adoc[] * xref:clustering/index.adoc[] ** xref:clustering/introduction.adoc[] @@ -158,6 +166,7 @@ ** xref:clustering/server-syntax.adoc[] ** xref:clustering/clustering-advanced/index.adoc[] *** xref:clustering/clustering-advanced/default-database.adoc[] +*** xref:clustering/clustering-advanced/unbind.adoc[] *** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[] *** xref:clustering/clustering-advanced/reconciler.adoc[] ** xref:clustering/glossary.adoc[] @@ -168,6 +177,7 @@ ** xref:backup-restore/online-backup.adoc[] ** xref:backup-restore/aggregate.adoc[] ** xref:backup-restore/inspect.adoc[] +** xref:backup-restore/consistency-checker.adoc[] ** xref:backup-restore/restore-backup.adoc[] ** xref:backup-restore/offline-backup.adoc[] ** xref:backup-restore/restore-dump.adoc[] @@ -221,23 +231,13 @@ ** xref:monitoring/query-management.adoc[] ** xref:monitoring/connection-management.adoc[] ** xref:monitoring/background-jobs.adoc[] +** xref:monitoring/neo4j-admin-report.adoc[] // ** xref:monitoring/cluster/index.adoc[] // *** xref:monitoring/cluster/procedures.adoc[] // *** xref:monitoring/cluster/http-endpoints.adoc[] -* xref:tools/index.adoc[] -** xref:tools/neo4j-admin/index.adoc[] -*** xref:tools/neo4j-admin/consistency-checker.adoc[] -*** xref:tools/neo4j-admin/neo4j-admin-report.adoc[] -*** xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[] -*** xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[] -*** xref:tools/neo4j-admin/neo4j-admin-import.adoc[] -*** xref:tools/neo4j-admin/unbind.adoc[] -*** xref:tools/neo4j-admin/upload-to-aura.adoc[] -*** xref:tools/neo4j-admin/migrate-database.adoc[] -*** xref:tools/neo4j-admin/migrate-configuration.adoc[] -*** xref:tools/neo4j-admin/validate-config.adoc[] -** xref:tools/cypher-shell.adoc[] +* xref:neo4j-admin-neo4j-cli.adoc[] +* xref:cypher-shell.adoc[] * xref:procedures.adoc[] diff --git a/modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc b/modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc index 16f2b7f6b..8f28a12f6 100644 --- a/modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc +++ b/modules/ROOT/pages/authentication-authorization/password-and-user-recovery.adoc @@ -36,7 +36,7 @@ server.default_listen_address=127.0.0.1 + [NOTE] ==== -Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`. +Ensure, you have blocked all network connections for any individual services configured to listen to `listen_addresses`. ==== + . Start Neo4j: @@ -86,7 +86,7 @@ bin/neo4j start [[password-recovery-for-admin]] == Recover a lost password -You can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user. +You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and set a new password for the admin user. [NOTE] ==== @@ -124,7 +124,7 @@ ALTER USER neo4j SET PASSWORD 'mynewpassword' [[recover-unassigned-admin-role]] == Recover an unassigned admin role -You can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user. +You can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and grant the admin user role to an existing user. [NOTE] ==== @@ -162,7 +162,7 @@ GRANT ROLE admin TO neo4j [[recover-admin-role]] == Recover the admin role -If you have removed the admin role from your system entirely, you can use a client such as xref:tools/cypher-shell.adoc[Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities. +If you have removed the admin role from your system entirely, you can use a client such as xref:cypher-shell.adoc[][Cypher Shell] or the Neo4j Browser to connect to the xref:database-administration/index.adoc#manage-databases-system[`system`] database and recreate the role with its original capabilities. [NOTE] ==== diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc index 0aaeb0a31..39f387e62 100644 --- a/modules/ROOT/pages/backup-restore/aggregate.adoc +++ b/modules/ROOT/pages/backup-restore/aggregate.adoc @@ -67,7 +67,7 @@ Aggregates a chain of backup artifacts into a single artifact. | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc b/modules/ROOT/pages/backup-restore/consistency-checker.adoc similarity index 97% rename from modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc rename to modules/ROOT/pages/backup-restore/consistency-checker.adoc index cdce4ac05..fecff8652 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc +++ b/modules/ROOT/pages/backup-restore/consistency-checker.adoc @@ -1,6 +1,6 @@ :description: Describes the Neo4j consistency checker. [[consistency-checker]] -= Consistency checker += Check database consistency You can use the `neo4j-admin database check` command to check the consistency of a database, a dump, or a backup. The `neo4j-admin` tool is located in the _/bin_ directory. @@ -68,7 +68,7 @@ The `neo4j-admin database check` command has the following options: |Allow command expansion in config value evaluation. | -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] | Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/backup-restore/copy-database.adoc b/modules/ROOT/pages/backup-restore/copy-database.adoc index 5f6e1a2a6..6998b5127 100644 --- a/modules/ROOT/pages/backup-restore/copy-database.adoc +++ b/modules/ROOT/pages/backup-restore/copy-database.adoc @@ -81,7 +81,7 @@ The `neo4j-admin database copy` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/backup-restore/index.adoc b/modules/ROOT/pages/backup-restore/index.adoc index 9be0cbdd2..87470ae88 100644 --- a/modules/ROOT/pages/backup-restore/index.adoc +++ b/modules/ROOT/pages/backup-restore/index.adoc @@ -9,6 +9,7 @@ This chapter describes the following: * xref:backup-restore/online-backup.adoc[Back up an online database] -- How to back up an online database. * xref:backup-restore/aggregate.adoc[Aggregate a database backup chain] - How to aggregate a backup chain into a single backup. * xref:backup-restore/inspect.adoc[Inspect the metadata of a database backup file] -- How to inspect the metadata of a database backup file. +* xref:backup-restore/consistency-checker.adoc[Check database consistency] -- How to check the consistency of a database, backup, or a dump. * xref:backup-restore/restore-backup.adoc[Restore a database backup] -- How to restore a database backup in a live Neo4j deployment. * xref:backup-restore/offline-backup.adoc[Back up an offline database] -- How to back up an offline database. * xref:backup-restore/restore-dump.adoc[Restore a database dump] -- How to restore a database dump in a live Neo4j deployment. diff --git a/modules/ROOT/pages/backup-restore/inspect.adoc b/modules/ROOT/pages/backup-restore/inspect.adoc index 0d11e200c..95ead4d32 100644 --- a/modules/ROOT/pages/backup-restore/inspect.adoc +++ b/modules/ROOT/pages/backup-restore/inspect.adoc @@ -66,7 +66,7 @@ The `` parameter can also inspect backups stored in AWS S3 buckets, | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/backup-restore/offline-backup.adoc b/modules/ROOT/pages/backup-restore/offline-backup.adoc index ce8256e00..238438007 100644 --- a/modules/ROOT/pages/backup-restore/offline-backup.adoc +++ b/modules/ROOT/pages/backup-restore/offline-backup.adoc @@ -65,7 +65,7 @@ The `neo4j-admin database dump` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index 3aa04ca5d..bfc2ca3ad 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -109,7 +109,7 @@ If is "*", `neo4j-admin` will attempt to back up all databases of the | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/backup-restore/planning.adoc b/modules/ROOT/pages/backup-restore/planning.adoc index 537ccb8b8..96f15821e 100644 --- a/modules/ROOT/pages/backup-restore/planning.adoc +++ b/modules/ROOT/pages/backup-restore/planning.adoc @@ -51,7 +51,7 @@ This ensures that if for some reason your Neo4j DBMS crashes, you will be able t == Backup and restore options Neo4j supports backing up and restoring both online and offline databases. -It uses xref:tools/neo4j-admin/index.adoc[Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS. +It uses xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin tool] commands, which can be run from a live, as well as from an offline Neo4j DBMS. All `neo4j-admin` commands must be invoked as the `neo4j` user to ensure the appropriate file permissions. * `neo4j-admin database backup/restore` (Enterprise only) -– used for performing online backup (xref:backup-restore/modes.adoc#full-backup[full] and xref:backup-restore/modes.adoc#differential-backup[differential]) and restore operations. diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc index 8606948dd..648e3bdf9 100644 --- a/modules/ROOT/pages/backup-restore/restore-backup.adoc +++ b/modules/ROOT/pages/backup-restore/restore-backup.adoc @@ -66,7 +66,7 @@ neo4j-admin database restore [-h] [--expand-commands] [--verbose] [--overwrite-d | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | @@ -100,7 +100,7 @@ The restore recovers transaction logs up to, but not including, the transaction The restore recovers transactions that were committed before the provided timestamp. | -| --source-database[=source-database-name] +| --source-database[=source-database-name] |label:new[Introduced in 2025.02] A source database name. If the `--from-path` points to a folder containing backups for multiple databases, you must specify the database name to filter the artifacts. | @@ -299,7 +299,7 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Designated If you have backed up a database with the option `--include-metadata`, you can manually restore the users and roles metadata. -From the __ directory, you run the Cypher script _data/scripts/databasename/restore_metadata.cypher_, which the `neo4j-admin database restore` command outputs, using xref:tools/cypher-shell.adoc[Cypher Shell]: +From the __ directory, you run the Cypher script _data/scripts/databasename/restore_metadata.cypher_, which the `neo4j-admin database restore` command outputs, using xref:cypher-shell.adoc[][Cypher Shell]: *Using `cat` (UNIX)* [source, shell, role=nocopy noplay] diff --git a/modules/ROOT/pages/backup-restore/restore-dump.adoc b/modules/ROOT/pages/backup-restore/restore-dump.adoc index 974f44fb1..1677b7dcd 100644 --- a/modules/ROOT/pages/backup-restore/restore-dump.adoc +++ b/modules/ROOT/pages/backup-restore/restore-dump.adoc @@ -58,7 +58,7 @@ If `--info` is specified, then the database is not loaded, but information (i.e. | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/clustering/clustering-advanced/index.adoc b/modules/ROOT/pages/clustering/clustering-advanced/index.adoc index 3f71529cf..16d2f8358 100644 --- a/modules/ROOT/pages/clustering/clustering-advanced/index.adoc +++ b/modules/ROOT/pages/clustering/clustering-advanced/index.adoc @@ -7,6 +7,7 @@ This section includes information about advanced deployments of a Neo4j Cluster. * xref:clustering/clustering-advanced/default-database.adoc[Default database in a cluster] -- Details of the creation of the default database in a cluster. +* xref:clustering/clustering-advanced/unbind.adoc[Unbind a server] -- How to remove and archive the cluster state of a cluster server so that it can rebind to a cluster. * xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Information about routing in multi-data center deployments. * xref:clustering/clustering-advanced/reconciler.adoc[Reconciler] -- Details about the way database management operations are processed. diff --git a/modules/ROOT/pages/tools/neo4j-admin/unbind.adoc b/modules/ROOT/pages/clustering/clustering-advanced/unbind.adoc similarity index 95% rename from modules/ROOT/pages/tools/neo4j-admin/unbind.adoc rename to modules/ROOT/pages/clustering/clustering-advanced/unbind.adoc index bab7929f4..4319e5690 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/unbind.adoc +++ b/modules/ROOT/pages/clustering/clustering-advanced/unbind.adoc @@ -1,7 +1,7 @@ :description: How to remove cluster state data from a Neo4j server using `neo4j-admin server unbind`. [role=enterprise-edition] [[neo4j-admin-unbind]] -= Unbind a Neo4j cluster server += Unbind a server You can use the `neo4j-admin server unbind` command to remove and archive the cluster state of a cluster server so that it can rebind to a cluster. @@ -39,7 +39,7 @@ The `neo4j-admin server unbind` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/clustering/disaster-recovery.adoc b/modules/ROOT/pages/clustering/disaster-recovery.adoc index 98f846c57..9d3d7d589 100644 --- a/modules/ROOT/pages/clustering/disaster-recovery.adoc +++ b/modules/ROOT/pages/clustering/disaster-recovery.adoc @@ -122,7 +122,7 @@ It is important to get a `system` database that is as up-to-date as possible, so [NOTE] ===== This section of the disaster recovery guide uses `neo4j-admin` commands. -For more information about the used commands, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-commands[neo4j-admin commands]. +For more information about the used commands, see xref:neo4j-admin-neo4j-cli.adoc#neo4j-admin-commands[neo4j-admin commands]. ===== . Shut down the Neo4j process on all servers. diff --git a/modules/ROOT/pages/clustering/index.adoc b/modules/ROOT/pages/clustering/index.adoc index a3cde8632..2f64872ad 100644 --- a/modules/ROOT/pages/clustering/index.adoc +++ b/modules/ROOT/pages/clustering/index.adoc @@ -25,6 +25,7 @@ This chapter describes the following: * xref:clustering/server-syntax.adoc[Server commands reference] -- Reference of Cypher administrative commands to add and manage servers. * xref:clustering/clustering-advanced/index.adoc[Advanced clustering] -- Some more advanced features of Neo4j clusters. ** xref:clustering/clustering-advanced/default-database.adoc[Default database in a cluster] -- The initial default database created when the DBMS starts for the first time. +** xref:clustering/clustering-advanced/unbind.adoc[Unbind a server] -- How to remove and archive the cluster state of a cluster server so that it can rebind to a cluster. ** xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] -- Clusters on mutli-data centers. ** xref:clustering/clustering-advanced/reconciler.adoc[Reconciler] -- An internal component that observes the requested state of a server and makes changes to the server to match that state. * xref:clustering/glossary.adoc[Clustering glossary] -- A glossary of terms related to the Neo4j clustering. diff --git a/modules/ROOT/pages/configuration/command-expansion.adoc b/modules/ROOT/pages/configuration/command-expansion.adoc index d6b4c69ca..5687233ca 100644 --- a/modules/ROOT/pages/configuration/command-expansion.adoc +++ b/modules/ROOT/pages/configuration/command-expansion.adoc @@ -110,4 +110,4 @@ In this case, the execution stops and the server does not start. * Errors for incorrect values -- The returned value is not the one expected for the setting. In this case, the server does not start. -For more information, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-exit-codes[Exit codes]. +For more information, see xref:neo4j-admin-neo4j-cli.adoc#neo4j-admin-exit-codes[Exit codes]. diff --git a/modules/ROOT/pages/configuration/file-locations.adoc b/modules/ROOT/pages/configuration/file-locations.adoc index 2a5296496..d90f82b0a 100644 --- a/modules/ROOT/pages/configuration/file-locations.adoc +++ b/modules/ROOT/pages/configuration/file-locations.adoc @@ -24,7 +24,7 @@ For the Neo4j's uses of the Java Native Access (JNA) library, set `server.jvm.ad [[neo4j-bin]] === Bin -The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:tools/cypher-shell.adoc[Cypher Shell] and xref:tools/neo4j-admin/index.adoc[Neo4j Admin]. +The _bin_ directory contains the Neo4j running script and built-in tools, such as xref:cypher-shell.adoc[][Cypher Shell] and xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin]. File permissions:: Read only and execute. diff --git a/modules/ROOT/pages/configuration/index.adoc b/modules/ROOT/pages/configuration/index.adoc index da8520f73..3cd4c696b 100644 --- a/modules/ROOT/pages/configuration/index.adoc +++ b/modules/ROOT/pages/configuration/index.adoc @@ -10,8 +10,11 @@ The topics described are: * xref:configuration/ports.adoc[Ports] -- An overview of the ports relevant to a Neo4j installation. * xref:configuration/connectors.adoc[Configure network connectors] -- How to configure network connectors for Neo4j. * xref:configuration/set-initial-password.adoc[Set initial password] -- How to set an initial password. -* xref:configuration/plugins.adoc[Configure Neo4j plugins] -- How to load plugins to a Neo4j deployment. +* xref:configuration/neo4j-admin-memrec.adoc[Get initial memory recommendations] -- How to get initial memory recommendations for Neo4j. +* xref:configuration/plugins.adoc[Configure Neo4j plugins] -- How to load plugins into a Neo4j deployment. * xref:configuration/dynamic-settings.adoc[Update dynamic settings] -- How to configure certain Neo4j parameters while Neo4j is running. +* xref:configuration/migrate-configuration.adoc[Migrate configurations] -- How to migrate configuration settings from a previous version of Neo4j to a new version. +* xref:configuration/validate-config.adoc[Validate configurations] -- How to validate Neo4j and Log4j configurations. * xref:configuration/configuration-settings.adoc[Configuration settings] -- A complete reference of all configuration settings. For a complete reference of Neo4j configuration settings, see xref:configuration/configuration-settings.adoc[All configuration settings]. diff --git a/modules/ROOT/pages/tools/neo4j-admin/migrate-configuration.adoc b/modules/ROOT/pages/configuration/migrate-configuration.adoc similarity index 99% rename from modules/ROOT/pages/tools/neo4j-admin/migrate-configuration.adoc rename to modules/ROOT/pages/configuration/migrate-configuration.adoc index 8798caa87..f3026e27c 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/migrate-configuration.adoc +++ b/modules/ROOT/pages/configuration/migrate-configuration.adoc @@ -1,5 +1,5 @@ [[neo4j-admin-migrate-configuration]] -= Migrate the Neo4j configuration file += Migrate configurations :description: This chapter describes the `neo4j-admin server migrate-configuration` command. You can use the `migrate-configuration` command to migrate a legacy Neo4j configuration file to the current format. diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc b/modules/ROOT/pages/configuration/neo4j-admin-memrec.adoc similarity index 91% rename from modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc rename to modules/ROOT/pages/configuration/neo4j-admin-memrec.adoc index 4e6f6b4af..50f694b22 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-memrec.adoc +++ b/modules/ROOT/pages/configuration/neo4j-admin-memrec.adoc @@ -1,6 +1,6 @@ :description: This chapter describes the `memory-recommendation` command of Neo4j Admin. [[neo4j-admin-memrec]] -= Memory recommendations += Get initial memory recommendations You can use the `neo4j-admin server memory-recommendation` command to get an initial recommendation on how to configure the memory parameters of your Neo4j DBMS. @@ -19,7 +19,7 @@ neo4j-admin server memory-recommendation [-h] [--docker] [--expand-commands] The command prints heuristic memory settings recommendations for the Neo4j JVM heap and pagecache. It either uses the total system memory or the amount of memory specified in the `--memory` argument. The heuristic assumes that the system is dedicated to running Neo4j. -If this is not the case, then use the --memory argument to specify how much memory can be expected to be dedicated to Neo4j. +If this is not the case, then use the `--memory` argument to specify how much memory can be expected to be dedicated to Neo4j. The output is formatted such that it can be copy-pasted into the _neo4j.conf_ file. The argument `--docker` outputs environmental variables that can be passed to a Neo4j Docker container. @@ -36,7 +36,7 @@ The `neo4j-admin server memory-recommendation` command has the following options | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/tools/neo4j-admin/validate-config.adoc b/modules/ROOT/pages/configuration/validate-config.adoc similarity index 100% rename from modules/ROOT/pages/tools/neo4j-admin/validate-config.adoc rename to modules/ROOT/pages/configuration/validate-config.adoc diff --git a/modules/ROOT/pages/tools/cypher-shell.adoc b/modules/ROOT/pages/cypher-shell.adoc similarity index 100% rename from modules/ROOT/pages/tools/cypher-shell.adoc rename to modules/ROOT/pages/cypher-shell.adoc diff --git a/modules/ROOT/pages/database-administration/queries.adoc b/modules/ROOT/pages/database-administration/queries.adoc index b1fbf7cda..878bf236e 100644 --- a/modules/ROOT/pages/database-administration/queries.adoc +++ b/modules/ROOT/pages/database-administration/queries.adoc @@ -4,7 +4,7 @@ [NOTE] ==== -All commands and example queries in this section are run in xref:tools/cypher-shell.adoc[the Neo4j Cypher Shell command-line interface (CLI)]. +All commands and example queries in this section are run in xref:cypher-shell.adoc[][the Neo4j Cypher Shell command-line interface (CLI)]. Note that the `cypher-shell` queries are not case-sensitive, but must end with a semicolon. ==== diff --git a/modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc b/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc similarity index 97% rename from modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc rename to modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc index 4d869e3d6..b3752aadb 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/migrate-database.adoc +++ b/modules/ROOT/pages/database-administration/standard-databases/migrate-database.adoc @@ -51,7 +51,7 @@ The `neo4j-admin database migrate` command has the following options: | Option | Description -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. |--expand-commands diff --git a/modules/ROOT/pages/tools/neo4j-admin/upload-to-aura.adoc b/modules/ROOT/pages/database-administration/standard-databases/upload-to-aura.adoc similarity index 97% rename from modules/ROOT/pages/tools/neo4j-admin/upload-to-aura.adoc rename to modules/ROOT/pages/database-administration/standard-databases/upload-to-aura.adoc index 6fd6abe8d..268850aa6 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/upload-to-aura.adoc +++ b/modules/ROOT/pages/database-administration/standard-databases/upload-to-aura.adoc @@ -72,7 +72,7 @@ The `neo4j-admin database upload` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/database-internals/index.adoc b/modules/ROOT/pages/database-internals/index.adoc index 1655c7102..69581e104 100644 --- a/modules/ROOT/pages/database-internals/index.adoc +++ b/modules/ROOT/pages/database-internals/index.adoc @@ -25,6 +25,8 @@ The following sections describe the transactional behavior in detail and how to * xref:database-internals/transaction-logs.adoc[] * xref:database-internals/checkpointing.adoc[] * xref:database-internals/store-formats.adoc[] +* xref:database-internals/neo4j-admin-store-info.adoc[] + [NOTE] ==== diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc b/modules/ROOT/pages/database-internals/neo4j-admin-store-info.adoc similarity index 96% rename from modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc rename to modules/ROOT/pages/database-internals/neo4j-admin-store-info.adoc index 7dbe658b9..68eb0e919 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-store-info.adoc +++ b/modules/ROOT/pages/database-internals/neo4j-admin-store-info.adoc @@ -53,7 +53,7 @@ The `neo4j-admin database info` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/database-internals/store-formats.adoc b/modules/ROOT/pages/database-internals/store-formats.adoc index cc1adcea0..b22bd776b 100644 --- a/modules/ROOT/pages/database-internals/store-formats.adoc +++ b/modules/ROOT/pages/database-internals/store-formats.adoc @@ -14,7 +14,7 @@ For more information on the deprecation and timeline for the eventual removal of [NOTE] ==== -For information on store formats in Neo4j 4.4, see link:https://neo4j.com/docs/operations-manual/4.4/tools/neo4j-admin/neo4j-admin-store-info/[Tools -> Neo4j Admin -> Display store information]. +For information on store formats in Neo4j 4.4, see link:https://neo4j.com/docs/operations-manual/4.4/tools/neo4j-admin/neo4j-admin-store-info/[Neo4j Admin and Neo4j CLI -> Neo4j Admin -> Display store information]. ==== [[store-format-overview]] @@ -94,7 +94,7 @@ You can either set the store format when creating a new database or change the s `block` is the default format for all newly-created databases as long as they do not have the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] setting specified. + If you want to change it, you can set a new value for the xref:configuration/configuration-settings.adoc#config_db.format[`db.format`] configuration in the _neo4j.conf_ file. + -You can also create a new database on a specific store format by passing the new format as an argument to the command creating the database, for example, xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-full[`neo4j-admin database import full`] or xref:backup-restore/copy-database.adoc[`neo4j-admin database copy`] commands, or by using `storeFormat:` option in the Cypher command `CREATE DATABASE`. +You can also create a new database on a specific store format by passing the new format as an argument to the command creating the database, for example, xref:import.adoc#import-tool-full[`neo4j-admin database import full`] or xref:backup-restore/copy-database.adoc[`neo4j-admin database copy`] commands, or by using `storeFormat:` option in the Cypher command `CREATE DATABASE`. The following examples show how to create a new database on the `block` store format. However, the same applies to other formats. @@ -160,7 +160,7 @@ The following steps assume that you want to migrate the database called `mydb` t . Stop the database using the Cypher command `STOP DATABASE mydb`. . Change the store format of the stopped database using *one* of the following options: -* Migrate an existing database using xref:tools/neo4j-admin/migrate-database.adoc[`neo4j-admin database migrate`] command. +* Migrate an existing database using xref:database-administration/standard-databases/migrate-database.adoc[`neo4j-admin database migrate`] command. + [IMPORTANT] ==== @@ -280,7 +280,7 @@ SHOW DATABASES YIELD name, store ---- Additionally, you can use the `neo4j-admin database info` command to get detailed information about the store format of a database. -For details, see xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[Display store information]. +For details, see xref:database-internals/neo4j-admin-store-info.adoc[Display store information]. [[store-formats-entity-limits]] == Store formats and entity limits diff --git a/modules/ROOT/pages/docker/operations.adoc b/modules/ROOT/pages/docker/operations.adoc index 0bb51a825..cbed1a445 100644 --- a/modules/ROOT/pages/docker/operations.adoc +++ b/modules/ROOT/pages/docker/operations.adoc @@ -7,7 +7,7 @@ You can use the Neo4j tools when running Neo4j in a Docker container. [[docker-neo4j-admin]] == Use Neo4j Admin -The xref:tools/neo4j-admin/index.adoc[Neo4j Admin tool] can be run locally within a container using the following command: +The xref:neo4j-admin-neo4j-cli.adoc[][Neo4j Admin tool] can be run locally within a container using the following command: [source, shell] ---- @@ -16,12 +16,12 @@ docker exec --interactive --tty neo4j-admin neo4j-admin database import incremental ---- -For more information about the commands' syntax and options, see xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-full[Full import] and xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-incremental[Incremental import]. +For more information about the commands' syntax and options, see xref:import.adoc#import-tool-full[Full import] and xref:import.adoc#import-tool-incremental[Incremental import]. [discrete] [[docker-import-prerequisites]] === Prerequisites * Verify that you have created the folders that you want to mount as volumes to the Neo4j docker container. -* Verify that the CSV files that you want to load into Neo4j are formatted as per xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-header-format[CSV header format]. +* Verify that the CSV files that you want to load into Neo4j are formatted as per xref:import.adoc#import-tool-header-format[CSV header format]. * Verify that you have added the CSV files to the folder that will be mounted to _/import_ in your container. [discrete] @@ -67,7 +67,7 @@ neo4j-admin database import full --nodes=Movies=/import/movies_header.csv,/impor [[docker-neo4j-memrec]] == Use Neo4j Admin for memory recommendations -The xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[neo4j-admin server memory-recommendation] command with the argument `--docker` outputs environmental variables that can be passed to a Neo4j docker container. +The xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation] command with the argument `--docker` outputs environmental variables that can be passed to a Neo4j docker container. The following example shows how `neo4j-admin server memory-recommendation --docker` provides a memory recommendation in a docker-friendly format. .Invoke `neo4j-admin server memory-recommendation --docker` @@ -96,7 +96,7 @@ NEO4J_server_jvm_additional='-XX:+ExitOnOutOfMemoryError' [[docker-neo4j-admin-report]] == Use Neo4j Admin report -The xref:tools/neo4j-admin/neo4j-admin-report.adoc[Neo4j Admin report tool] generates a report of the status of a running Neo4j database. + +The xref:monitoring/neo4j-admin-report.adoc[Neo4j Admin report tool] generates a report of the status of a running Neo4j database. + In a containerized environment, its command `neo4j-admin server report` must be invoked using the script `neo4j-admin-report`. This ensures that the reporter is running with all the necessary file permissions required to analyze the running Neo4j processes. This script takes all the arguments of the `neo4j-admin server report` command. @@ -142,14 +142,14 @@ The `$HOME/neo4j/reports` folder should now contain a zip file of reports. [[docker-cypher-shell]] == Use Cypher Shell -The xref:tools/cypher-shell.adoc[Neo4j Cypher Shell tool] can be run locally within a container using the following command: +The xref:cypher-shell.adoc[][Neo4j Cypher Shell tool] can be run locally within a container using the following command: [source, shell] ---- docker exec --interactive --tty cypher-shell ---- -For more information about the `cypher-shell` syntax and options, see xref:tools/cypher-shell.adoc#cypher-shell-syntax[Syntax]. +For more information about the `cypher-shell` syntax and options, see xref:cypher-shell.adoc[]#cypher-shell-syntax[Syntax]. [[docker-cypher-shell-example]] === Retrieve data from a database in a Neo4j Docker container diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc b/modules/ROOT/pages/import.adoc similarity index 99% rename from modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc rename to modules/ROOT/pages/import.adoc index 275f6a36a..83abed3d7 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc +++ b/modules/ROOT/pages/import.adoc @@ -131,7 +131,7 @@ For more information, please contact Neo4j Professional Services. `neo4j-admin import` also supports the Parquet file format. You can use the parameter `--input-type=csv|parquet` to explicitly specify whether to use CSV or Parquet for the importer. If not defined, it defaults to CSV. -The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet. +The xref:import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet. [[full-import-options-table]] .`neo4j-admin database import full` options @@ -141,7 +141,7 @@ The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | @@ -426,7 +426,7 @@ If importing to a database that has not explicitly been created before the impor ==== Import data from CSV files -Assume that you have formatted your data as per xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-header-format[CSV header format] so that you have it in six different files: +Assume that you have formatted your data as per xref:import.adoc#import-tool-header-format[CSV header format] so that you have it in six different files: . `movies_header.csv` . `movies.csv` @@ -645,7 +645,7 @@ If the database into which you import does not exist prior to importing, you mus | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/installation/linux/debian.adoc b/modules/ROOT/pages/installation/linux/debian.adoc index 48b5d464f..8fe8f27a7 100644 --- a/modules/ROOT/pages/installation/linux/debian.adoc +++ b/modules/ROOT/pages/installation/linux/debian.adoc @@ -140,7 +140,7 @@ If you cannot reach `https://debian.neo4j.com`, perhaps due to a firewall, you n [NOTE] ==== -It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `apt` for installing Neo4j; xref:tools/cypher-shell.adoc[Cypher Shell] and Java (if not installed already): +It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using `apt` for installing Neo4j; xref:cypher-shell.adoc[][Cypher Shell] and Java (if not installed already): * The Cypher Shell package can be downloaded from {neo4j-download-center-uri}[Neo4j Deployment Center]. * For information on supported versions of Java, see xref:installation/requirements.adoc[System requirements]. diff --git a/modules/ROOT/pages/installation/linux/rpm.adoc b/modules/ROOT/pages/installation/linux/rpm.adoc index c80185823..26a9cea2a 100644 --- a/modules/ROOT/pages/installation/linux/rpm.adoc +++ b/modules/ROOT/pages/installation/linux/rpm.adoc @@ -139,7 +139,7 @@ If you cannot reach `\https://yum.neo4j.com/stable/{neo4j-version}` to install N [NOTE] ==== -It is important to note that using this method means that the offline machine cannot receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j, xref:tools/cypher-shell.adoc[Neo4j Cypher Shell], and Java. +It is important to note that using this method means that the offline machine cannot receive the dependencies that are normally downloaded and installed automatically when using `yum` for installing Neo4j, xref:cypher-shell.adoc[][Neo4j Cypher Shell], and Java. ==== . Download the Neo4j and Cypher Shell RPM installers from https://neo4j.com/deployment-center/[Deployment Center] or run the following to obtain the required packages: diff --git a/modules/ROOT/pages/introduction.adoc b/modules/ROOT/pages/introduction.adoc index 1e4db2305..a24dbb8c2 100644 --- a/modules/ROOT/pages/introduction.adoc +++ b/modules/ROOT/pages/introduction.adoc @@ -130,7 +130,7 @@ a| link:https://neo4j.com/docs/cdc/current/[Change Data Capture (CDC)] | | -| xref:tools/cypher-shell.adoc[Cypher Shell] +| xref:cypher-shell.adoc[][Cypher Shell] | {check-mark} | {check-mark} @@ -222,11 +222,11 @@ a| APOC 450+ link:https://neo4j.com/docs/apoc/5/[Core Procedures and Functions] | | -| xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-full[Offline import] +| xref:import.adoc#import-tool-full[Offline import] | {check-mark} | {check-mark} -| xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-incremental[Offline incremental import] +| xref:import.adoc#import-tool-incremental[Offline incremental import] | | {check-mark} diff --git a/modules/ROOT/pages/kubernetes/import-data.adoc b/modules/ROOT/pages/kubernetes/import-data.adoc index bd99a1933..370c95e67 100644 --- a/modules/ROOT/pages/kubernetes/import-data.adoc +++ b/modules/ROOT/pages/kubernetes/import-data.adoc @@ -14,7 +14,7 @@ You place all the files that you want to import in this volume. To import data from CSV files into Neo4j, use the command `neo4j-admin database import` or the Cypher query `LOAD CSV`. -* The xref:tools/neo4j-admin/neo4j-admin-import.adoc[`neo4j-admin database import`] command can be used to do batch imports of large amounts of data into a previously unused database and can only be performed once per database. +* The xref:import.adoc[`neo4j-admin database import`] command can be used to do batch imports of large amounts of data into a previously unused database and can only be performed once per database. * `LOAD CSV` Cypher statement can be used to import small to medium-sized CSV files into an existing database. `LOAD CSV` can be run as many times as needed and does not require an empty database. For a simple example, see link:https://neo4j.com/docs/getting-started/current/cypher-intro/load-csv[Getting Started Guide -> Import data]. diff --git a/modules/ROOT/pages/monitoring/index.adoc b/modules/ROOT/pages/monitoring/index.adoc index 68f746b8f..5aee62526 100644 --- a/modules/ROOT/pages/monitoring/index.adoc +++ b/modules/ROOT/pages/monitoring/index.adoc @@ -28,6 +28,5 @@ This chapter describes the following: * xref:monitoring/background-jobs.adoc[Manage background jobs] ** xref:monitoring/background-jobs.adoc#background-jobs-active[Listing active background jobs] ** xref:monitoring/background-jobs.adoc#background-jobs-failed[Listing failed job executions] -* xref:clustering/monitoring/show-databases-monitoring.adoc[Monitor the state of individual databases] - +* xref:monitoring/neo4j-admin-report.adoc[Generate a report about the system] diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-report.adoc b/modules/ROOT/pages/monitoring/neo4j-admin-report.adoc similarity index 97% rename from modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-report.adoc rename to modules/ROOT/pages/monitoring/neo4j-admin-report.adoc index c59e84749..3a93e3087 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-report.adoc +++ b/modules/ROOT/pages/monitoring/neo4j-admin-report.adoc @@ -1,7 +1,7 @@ :description: This chapter describes the `report` command of Neo4j Admin. :page-aliases: tools/neo4j-admin-report.adoc [[neo4j-admin-report]] -= Neo4j Admin report += Generate a report about the system //Check Mark :check-mark: icon:check[] @@ -134,7 +134,7 @@ The `neo4j-admin server report` command has the following options: | Description | Default -|--additional-config=footnote:[See xref:tools/neo4j-admin/index.adoc#_configuration[Tools -> Configuration] for details.] +|--additional-config=footnote:[See xref:neo4j-admin-neo4j-cli.adoc#_configuration[Neo4j Admin and Neo4j CLI -> Configuration] for details.] |Configuration file with additional configuration. | diff --git a/modules/ROOT/pages/tools/neo4j-admin/index.adoc b/modules/ROOT/pages/neo4j-admin-neo4j-cli.adoc similarity index 91% rename from modules/ROOT/pages/tools/neo4j-admin/index.adoc rename to modules/ROOT/pages/neo4j-admin-neo4j-cli.adoc index 9971e5531..db49fe6aa 100644 --- a/modules/ROOT/pages/tools/neo4j-admin/index.adoc +++ b/modules/ROOT/pages/neo4j-admin-neo4j-cli.adoc @@ -9,7 +9,7 @@ Both are installed as part of the product and can be executed with a number of commands. The `neo4j` commands are equivalent to the most important commands in the `neo4j-admin` server category. -Both `neo4j-admin` and `neo4j` commands support the <> option, which prints the command's usage and options, and the <> option, which prints the version of the command. +Both `neo4j-admin` and `neo4j` commands support the <<_help_command, `--help`>> option, which prints the command's usage and options, and the <<_version_command, `--version`>> option, which prints the version of the command. All admin command options can also be provided in a file and passed to the command using the `@` prefix. This is useful when the command line becomes too long to manage. For example, `neo4j-admin database import full @/path/to/your/ mydb`. @@ -75,15 +75,17 @@ This command is required to be run before starting the Neo4j Enterprise Edition. | `memory-recommendation` | Prints recommendations for Neo4j heap and page cache memory usage. -For details, see xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[Memory recommendations]. +For details, see xref:configuration/neo4j-admin-memrec.adoc[]. | `migrate-configuration` | Migrates server configuration from the previous major version. +For details, see xref:configuration/migrate-configuration.adoc[]. + | `report` | Produces a ZIP/TAR of the most common information needed for remote assessments. -For details, see xref:tools/neo4j-admin/neo4j-admin-report.adoc[Neo4j Admin report]. +For details, see xref:monitoring/neo4j-admin-report.adoc[]. | `restart` | Restarts the server daemon. @@ -100,11 +102,13 @@ For details, see xref:tools/neo4j-admin/neo4j-admin-report.adoc[Neo4j Admin repo | `unbind` | Removes cluster state data from a stopped Neo4j server. -For details, see xref:tools/neo4j-admin/unbind.adoc[Unbind a Neo4j cluster server]. +For details, see xref:clustering/clustering-advanced/unbind.adoc[]. | `validate-config` | Performs configuration validation without starting the server. +For details, see xref:configuration/validate-config.adoc[]. + | `windows-service` | A command whose subcommands can be used to install, uninstall, and update Neo4j as a Windows service. @@ -123,39 +127,47 @@ Replaced by `neo4j-admin backup aggregate`. | `check` | Checks the consistency of a database. -For details, see xref:tools/neo4j-admin/consistency-checker.adoc[Consistency checker]. +For details, see xref:backup-restore/consistency-checker.adoc[]. | `copy` | Copies a database and optionally applies filters. -For details, see xref:backup-restore/copy-database.adoc[Copy a database store]. +For details, see xref:backup-restore/copy-database.adoc[]. | `dump` | Dumps a database into a single-file archive. +For details, see xref:backup-restore/offline-backup.adoc[]. + | `import` | Imports a collection of CSV files. -For details, see xref:tools/neo4j-admin/neo4j-admin-import.adoc[Import]. +For details, see xref:import.adoc[]. | `info` | Prints information about a Neo4j database store. -For details, see xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[Display store information]. +For details, see xref:database-internals/neo4j-admin-store-info.adoc[]. | `load` | Loads a database from an archive created with the `dump` command. +For details, see xref:backup-restore/restore-dump.adoc[]. + | `migrate` | Migrates a database from one store format to another or between versions of the same format. +For details, see xref:database-administration/standard-databases/migrate-database.adoc[]. + | `restore` | Restores a backed up database. +For details, see xref:backup-restore/restore-backup.adoc[]. + | `upload` | Pushes a local database to a Neo4j Aura instance. -For details, see xref:tools/neo4j-admin/upload-to-aura.adoc[Upload to Neo4j AuraDB]. +For details, see xref:database-administration/standard-databases/upload-to-aura.adoc[]. .2+| `backup` diff --git a/modules/ROOT/pages/performance/memory-configuration.adoc b/modules/ROOT/pages/performance/memory-configuration.adoc index 87f268d92..126ebe5c0 100644 --- a/modules/ROOT/pages/performance/memory-configuration.adoc +++ b/modules/ROOT/pages/performance/memory-configuration.adoc @@ -93,13 +93,13 @@ Otherwise, Neo4j computes some heuristic values at startup based on the availabl [discrete] [[memory-configuration-initial]] Initial memory recommendation:: -Use the `xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[neo4j-admin server memory-recommendation]` command to get an initial recommendation for how to distribute a certain amount of memory. +Use the `xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation]` command to get an initial recommendation for how to distribute a certain amount of memory. The values may need to be adjusted to cater for each specific use case. [discrete] [[memory-configuration-database]] Inspect the memory settings of all databases in a DBMS:: -The `xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[neo4j-admin server memory-recommendation]` command is useful for inspecting the current distribution of data and indexes. +The `xref:configuration/neo4j-admin-memrec.adoc[][neo4j-admin server memory-recommendation]` command is useful for inspecting the current distribution of data and indexes. + .Use `neo4j-admin server memory-recommendation` to inspect the memory settings of all your databases ==== diff --git a/modules/ROOT/pages/tools/index.adoc b/modules/ROOT/pages/tools/index.adoc deleted file mode 100644 index 190c98b95..000000000 --- a/modules/ROOT/pages/tools/index.adoc +++ /dev/null @@ -1,24 +0,0 @@ -[[tools]] -= Tools -:description: This chapter describes the Neo4j tools _Neo4j Admin_, _Neo4j CLI_, and _Cypher Shell_. - -This chapter covers the following topics: - -* xref:tools/neo4j-admin/index.adoc[Neo4j Admin and Neo4j CLI] -- A description of the _Neo4j Admin_, _Neo4j CLI_ tools. -* Neo4j Admin commands -** xref:tools/neo4j-admin/consistency-checker.adoc[Consistency checker] -- How to check the consistency of a Neo4j database using Neo4j Admin. -** xref:tools/neo4j-admin/neo4j-admin-report.adoc[Neo4j Admin report] -- How to collect the most common information needed for remote assessments. -** xref:tools/neo4j-admin/neo4j-admin-store-info.adoc[Display store information] -- How to display information about a database store. -** xref:tools/neo4j-admin/neo4j-admin-memrec.adoc[Memory recommendations] -- How to get an initial recommendation for Neo4j memory settings. -** xref:tools/neo4j-admin/neo4j-admin-import.adoc[Import] -- How to import data into Neo4j using the command `neo4j-admin import`. -** xref:tools/neo4j-admin/unbind.adoc[Unbind a Neo4j cluster server] -- How to remove cluster state data from a Neo4j server. -** xref:tools/neo4j-admin/upload-to-aura.adoc[Upload to Neo4j Aura] -- How to upload an existing local database to a Neo4j Aura instance. -** xref:tools/neo4j-admin/migrate-database.adoc[Migrate a database] -- How to migrate a Neo4j database from one store format to another or to a later `MAJOR` version of the same format. -** xref:tools/neo4j-admin/migrate-configuration.adoc[Migrate the Neo4j configuration file] -- How to migrate a Neo4j configuration file. -** xref:tools/neo4j-admin/validate-config.adoc[Validate configurations] -- How to validate Neo4j configuration files, including the Log4j files. -* xref:tools/cypher-shell.adoc[Cypher Shell] -- How to use the Cypher Shell. -* link:https://neo4j.com/docs/browser-manual/current/[Neo4j Browser] is a tool for developers to interact with the graph. -It is the default interface for both Enterprise and Community Editions of the Neo4j database. -Neo4j Browser is bundled with Neo4j DBMS, including both Neo4j server and xref:installation/neo4j-desktop.adoc[Neo4j Desktop]. - - diff --git a/modules/ROOT/pages/tutorial/neo4j-admin-import.adoc b/modules/ROOT/pages/tutorial/neo4j-admin-import.adoc index 619c06ad7..eafc328a7 100644 --- a/modules/ROOT/pages/tutorial/neo4j-admin-import.adoc +++ b/modules/ROOT/pages/tutorial/neo4j-admin-import.adoc @@ -2,7 +2,7 @@ = Neo4j-admin import :description: This tutorial provides detailed examples to illustrate the capabilities of importing data from CSV files with the command `neo4j-admin database import`. -This tutorial provides detailed examples to illustrate the capabilities of importing data from CSV files with the command xref:tools/neo4j-admin/neo4j-admin-import.adoc[`neo4j-admin database import`]. +This tutorial provides detailed examples to illustrate the capabilities of importing data from CSV files with the command xref:import.adoc[`neo4j-admin database import`]. The import command is used for loading large amounts of data from CSV files and supports full and incremental import into a running or stopped Neo4j DBMS. [IMPORTANT] @@ -26,14 +26,14 @@ They use: * The _import_ directory of the Neo4j installation to store all the CSV files. However, the CSV files can be located in any directory of your file system. * UNIX-styled paths. -* The xref:tools/neo4j-admin/index.adoc[`neo4j-admin database import`] command. +* The xref:neo4j-admin-neo4j-cli.adoc[][`neo4j-admin database import`] command. //To create a cluster based on imported data, see <>. [TIP] .Handy tips: ==== -* The details of a CSV file header format can be found at xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-header-format[CSV header format]. +* The details of a CSV file header format can be found at xref:import.adoc#import-tool-header-format[CSV header format]. * To show available databases, use the Cypher query `SHOW DATABASES` against the `system` database. * To remove a database, use the Cypher query `DROP DATABASE database_name` against the `system` database. * To create a database, use the Cypher query `CREATE DATABASE database_name` against the `system` database. @@ -163,9 +163,9 @@ bin/neo4j stop == CSV file delimiters -You can customize the configuration options that the import tool uses (see xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-options[Options]) if your data does not fit the default format. +You can customize the configuration options that the import tool uses (see xref:import.adoc#import-tool-options[Options]) if your data does not fit the default format. -The details of a CSV file header format can be found at xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-header-format[CSV header format]. +The details of a CSV file header format can be found at xref:import.adoc#import-tool-header-format[CSV header format]. [discrete] @@ -580,7 +580,7 @@ bin/neo4j-admin database import full neo4j --nodes=import/movies5b.csv --nodes=i == Properties Nodes and relationships can have properties. -The property type is specified in the CSV header row, see xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-header-format[CSV header format]. +The property type is specified in the CSV header row, see xref:import.adoc#import-tool-header-format[CSV header format]. [discrete] @@ -631,7 +631,7 @@ This may not be the case for data sets that use sequential, auto-incremented, or Those data sets can define ID spaces where identifiers are unique within their respective ID space. In cases where the node ID is unique only within files, using ID spaces is a way to ensure uniqueness across all node files. -See xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-id-spaces[Using ID spaces]. +See xref:import.adoc#import-tool-id-spaces[Using ID spaces]. Each node processed by `neo4j-admin database import` must provide an ID if it is to be connected in any relationships. The node ID is used to find the start node and end node when creating a relationship. diff --git a/modules/ROOT/pages/tutorial/tutorial-composite-database.adoc b/modules/ROOT/pages/tutorial/tutorial-composite-database.adoc index cfd64fb08..927b9b134 100644 --- a/modules/ROOT/pages/tutorial/tutorial-composite-database.adoc +++ b/modules/ROOT/pages/tutorial/tutorial-composite-database.adoc @@ -131,7 +131,7 @@ Note that Cypher queries must end with a semicolon. + [NOTE] ==== -For more information about the Cypher Shell command-line interface (CLI) and how to use it, see xref:tools/cypher-shell.adoc[]. +For more information about the Cypher Shell command-line interface (CLI) and how to use it, see xref:cypher-shell.adoc[][]. ==== . Run the command `SHOW DATABASES` to list all available databases: +