Skip to content

Commit 9445cd0

Browse files
renetapopovaJPryce-Aklundhloveleif
authored
Migrate Database Management and Alias management pages from Cypher Ma… (#1139)
…nual to Operations Manual (#826) First attempt to migrate Administration chapter in Cypher Manual to Operations Manual. Note, this PR does not contain examples about clustering, server management, and the rbac commands, as these pages in the Cypher Manual will be added to more relevant pages in the operations manual. Includes updates from the following Cypher Manual PRs making changes to the impacted pages: - neo4j/docs-cypher#653 (5.10) - neo4j/docs-cypher#680 (5.11) - neo4j/docs-cypher#649 (5.11) --------- Co-authored-by: Jens Pryce-Åklundh <[email protected]> Co-authored-by: Love Kristofer Leifland <[email protected]>
1 parent bd09869 commit 9445cd0

34 files changed

+2586
-409
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,16 +102,23 @@
102102
*** xref:configuration/configuration-settings.adoc#_transaction_settings[Transaction settings]
103103
*** xref:configuration/configuration-settings.adoc#_transaction_log_settings[Transaction log settings]
104104
105-
* xref:manage-databases/index.adoc[]
106-
** xref:manage-databases/introduction.adoc[]
107-
** xref:manage-databases/configuration.adoc[]
108-
** xref:manage-databases/queries.adoc[]
109-
** xref:manage-databases/errors.adoc[]
110-
** xref:manage-databases/remote-alias.adoc[]
111-
** xref:composite-databases/index.adoc[]
112-
*** xref:composite-databases/administration.adoc[]
113-
*** xref:composite-databases/sharding-with-copy.adoc[]
114-
*** xref:composite-databases/queries.adoc[]
105+
* xref:database-administration/index.adoc[]
106+
** Standard databases
107+
*** xref:database-administration/standard-databases/naming-databases.adoc[]
108+
*** xref:database-administration/standard-databases/manage-databases.adoc[]
109+
*** xref:database-administration/standard-databases/configuration-parameters.adoc[]
110+
*** xref:database-administration/standard-databases/errors.adoc[]
111+
** Database aliases
112+
*** xref:database-administration/aliases/naming-aliases.adoc[]
113+
*** xref:database-administration/aliases/manage-aliases-standard-databases.adoc[]
114+
*** xref:database-administration/aliases/manage-aliases-composite-databases.adoc[]
115+
*** xref:database-administration/aliases/remote-database-alias-configuration.adoc[]
116+
** Composite databases
117+
*** xref:database-administration/composite-databases/concepts.adoc[]
118+
*** xref:database-administration/composite-databases/manage-composite-databases.adoc[]
119+
*** xref:database-administration/composite-databases/querying-composite-databases.adoc[]
120+
*** xref:database-administration/composite-databases/sharding-with-copy.adoc[]
121+
** xref:database-administration/syntax.adoc[]
115122
116123
* xref:database-internals/index.adoc[]
117124
** xref:database-internals/transaction-management.adoc[]

modules/ROOT/pages/backup-restore/copy-database.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ However, the command will output Cypher statements, which you can run to recreat
1313
====
1414
* `neo4j-admin database copy` preserves the node IDs (unless `--compact-node-store` is used), but the relationships get new IDs.
1515
* `neo4j-admin database copy` is not supported for use on the `system` database.
16-
* `neo4j-admin database copy` is not supported for use on xref:composite-databases/index.adoc[Composite databases].
16+
* `neo4j-admin database copy` is not supported for use on xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
1717
It must be run directly on the databases that are associated with that Composite database.
1818
* `neo4j-admin database copy` is an IOPS-intensive process.
1919
For more information, see <<copy-estimating-iops, Estimating the processing time>>.
@@ -273,7 +273,7 @@ Labels are processed independently, i.e., the filter ignores any node with a lab
273273

274274
[TIP]
275275
====
276-
For a detailed example of how to use `neo4j-admin database copy` to filter out data for sharding a database, see xref:composite-databases/sharding-with-copy.adoc[Sharding data with the `copy` command].
276+
For a detailed example of how to use `neo4j-admin database copy` to filter out data for sharding a database, see xref:database-administration/composite-databases/sharding-with-copy.adoc[Sharding data with the `copy` command].
277277
====
278278

279279
[[compact-database]]

modules/ROOT/pages/backup-restore/offline-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,6 @@ The command creates a file called _<database>.dump_ where `<database>` is the da
117117

118118
[NOTE]
119119
====
120-
`neo4j-admin database dump` cannot be applied to xref:composite-databases/index.adoc[Composite databases].
120+
`neo4j-admin database dump` cannot be applied to xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
121121
It must be run directly on the databases that are associated with that Composite database.
122122
====

modules/ROOT/pages/backup-restore/planning.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The recommended way to restore a database in a cluster is to xref:clustering/dat
9696

9797
[NOTE]
9898
====
99-
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:composite-databases/index.adoc[Composite databases].
99+
The Neo4j Admin commands `backup`, `restore`, `dump`, `load`, `copy`, and `check-consistency` are not supported for use on xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
100100
They must be run directly on the databases that are associated with that Composite database.
101101
====
102102

modules/ROOT/pages/backup-restore/restore-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Restoring a database backup to a previous Neo4j version is not supported.
1515

1616
You must create the database (using `CREATE DATABASE` against the `system` database) after the restore operation finishes, unless you are replacing an existing database.
1717
`neo4j-admin database restore` must be invoked as the `neo4j` user to ensure the appropriate file permissions.
18-
For more information, see xref:manage-databases/configuration.adoc#manage-databases-administration[Administrative commands].
18+
For more information, see xref:database-administration/standard-databases/manage-databases.adoc[Manage databases].
1919

2020
[NOTE]
2121
====

modules/ROOT/pages/backup-restore/restore-dump.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,6 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Seed a clu
121121

122122
[NOTE]
123123
====
124-
`neo4j-admin database load` cannot be applied to xref:composite-databases/index.adoc[Composite databases].
124+
`neo4j-admin database load` cannot be applied to xref:database-administration/composite-databases/manage-composite-databases.adoc[Composite databases].
125125
It must be run directly on the databases that are associated with that Composite database.
126126
====

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If a database is no longer needed, the command `DROP DATABASE` deletes the datab
99

1010
== `CREATE DATABASE`
1111

12-
The command to create a database in a cluster is not significantly different from the command to create a database in a non-clustered environment (see link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/administration/databases[Cypher Manual -> Database management] for more information on database management on single servers).
12+
The command to create a database in a cluster is not significantly different from the command to create a database in a non-clustered environment (see xref::database-administration/standard-databases/manage-databases.adoc[Database management] for more information on database management on single servers).
1313
The difference in a clustered environment is that the topology can be specified, i.e. how many primaries and secondaries are desired for the database.
1414
To create a database `foo` with 3 servers hosting the database in primary mode and 2 servers in secondary mode, the command looks like this:
1515

@@ -60,7 +60,7 @@ It is not possible to automatically transition to a topology with a single prima
6060

6161
However, it is possible to _manually_ do this transition.
6262
The first step is to back up the database, see xref:backup-restore/index.adoc[Backup and restore] for more information.
63-
Once the database is backed up, the next step is to drop the database, see xref:manage-databases/configuration.adoc#manage-databases-administration[Administrative commands] for more information.
63+
Once the database is backed up, the next step is to drop the database, see xref:database-administration/standard-databases/manage-databases.adoc[Manage databases] for more information.
6464
The last step is to either seed a cluster from the backup with the new topology, or to restore the backup on a single server.
6565
See xref:clustering/databases.adoc#cluster-seed[Seed a cluster] further on for information on seeding.
6666

@@ -253,7 +253,7 @@ Some seed providers may also want to pass credentials into the provider.
253253
These are specified with the `seedCredentials` option.
254254
Seed credentials are securely passed from the Cypher command to each server hosting the database.
255255
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
256-
This is identical to the configuration required by remote aliases, see xref:manage-databases/remote-alias.adoc#remote-alias-config-DBMS_admin-A[Configuration of DBMS with remote database alias].
256+
This is identical to the configuration required by remote aliases, see xref:database-administration/aliases/remote-database-alias-configuration.adoc#remote-alias-config-DBMS_admin-A[Configuration of DBMS with remote database alias].
257257
If this configuration is not performed, the `seedCredential` option fails.
258258

259259
For example, in the case of `S3SeedProvider`(the default provider): `seedCredentials: [accessKey];[secretKey]` where `accessKey` and `secretKey` are provided by AWS.
@@ -322,7 +322,7 @@ See xref:clustering/clustering-advanced/default-database.adoc[Default database i
322322
== Handling errors
323323

324324
Databases can get into error states.
325-
Typically you can observe this with the `SHOW DATABASES` command, and use the xref:manage-databases/errors.adoc[error handling guidance] to help.
325+
Typically you can observe this with the `SHOW DATABASES` command, and use the xref:database-administration/standard-databases/errors.adoc[error handling guidance] to help.
326326

327327
In more serious cases you may be dealing with a disaster situation, where the whole DBMS may not be responding correctly, or some specific databases cannot be restored without downtime.
328328
Refer to the xref:clustering/disaster-recovery.adoc[disaster recovery guide] for those situations.

modules/ROOT/pages/clustering/disaster-recovery.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Once the `system` database is verified available, and all servers are online, th
153153
The steps here aim to make the unavailable databases available.
154154

155155
. If you have previously dropped databases as part of this guide, re-create each one from backup.
156-
See the xref:manage-databases/configuration.adoc#manage-databases-administration[Administrative commands] section for more information on how to create a database.
156+
See the xref:database-administration/standard-databases/manage-databases.adoc[Manage databases] section for more information on how to create a database.
157157
. Run `SHOW DATABASES`.
158158
If all databases are in desired states on all servers (`requestedStatus`=`currentStatus`), disaster recovery is complete.
159159
// . For each database that remains unavailable, refer to <<unavailable-databases, Managing unavailable databases in a cluster>>.

modules/ROOT/pages/clustering/setup/analytics-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,6 @@ If you want to follow along with the startup, you can see the messages in xref:c
268268
== Running analytic queries
269269

270270
If running large normal Cypher queries, it is possible to use server tags to identify the large servers, and a routing policy to direct the read queries towards those servers.
271-
See xref:clustering/clustering-advanced/multi-data-center-routing.adoc[here] for more details.
271+
See xref:clustering/clustering-advanced/multi-data-center-routing.adoc[Multi-data center routing] for more details.
272272

273273
If using GDS, follow the guidance in link:https://neo4j.com/docs/graph-data-science/current/production-deployment/neo4j-cluster/[Neo4j Graph Data Science Library Manual -> GDS with Neo4j cluster].

modules/ROOT/pages/composite-databases/administration.adoc

Lines changed: 0 additions & 102 deletions
This file was deleted.

0 commit comments

Comments
 (0)