You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/copy-database.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ However, the command will output Cypher statements, which you can run to recreat
13
13
====
14
14
* `neo4j-admin database copy` preserves the node IDs (unless `--compact-node-store` is used), but the relationships get new IDs.
15
15
* `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].
17
17
It must be run directly on the databases that are associated with that Composite database.
18
18
* `neo4j-admin database copy` is an IOPS-intensive process.
19
19
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
273
273
274
274
[TIP]
275
275
====
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].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/offline-backup.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,6 +117,6 @@ The command creates a file called _<database>.dump_ where `<database>` is the da
117
117
118
118
[NOTE]
119
119
====
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].
121
121
It must be run directly on the databases that are associated with that Composite database.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/planning.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ The recommended way to restore a database in a cluster is to xref:clustering/dat
96
96
97
97
[NOTE]
98
98
====
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].
100
100
They must be run directly on the databases that are associated with that Composite database.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/restore-backup.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Restoring a database backup to a previous Neo4j version is not supported.
15
15
16
16
You must create the database (using `CREATE DATABASE` against the `system` database) after the restore operation finishes, unless you are replacing an existing database.
17
17
`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].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/backup-restore/restore-dump.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,6 @@ For more information, see xref:clustering/databases.adoc#cluster-seed[Seed a clu
121
121
122
122
[NOTE]
123
123
====
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].
125
125
It must be run directly on the databases that are associated with that Composite database.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/databases.adoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ If a database is no longer needed, the command `DROP DATABASE` deletes the datab
9
9
10
10
== `CREATE DATABASE`
11
11
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).
13
13
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.
14
14
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:
15
15
@@ -60,7 +60,7 @@ It is not possible to automatically transition to a topology with a single prima
60
60
61
61
However, it is possible to _manually_ do this transition.
62
62
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.
64
64
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.
65
65
See xref:clustering/databases.adoc#cluster-seed[Seed a cluster] further on for information on seeding.
66
66
@@ -253,7 +253,7 @@ Some seed providers may also want to pass credentials into the provider.
253
253
These are specified with the `seedCredentials` option.
254
254
Seed credentials are securely passed from the Cypher command to each server hosting the database.
255
255
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].
257
257
If this configuration is not performed, the `seedCredential` option fails.
258
258
259
259
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
322
322
== Handling errors
323
323
324
324
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.
326
326
327
327
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.
328
328
Refer to the xref:clustering/disaster-recovery.adoc[disaster recovery guide] for those situations.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/disaster-recovery.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ Once the `system` database is verified available, and all servers are online, th
153
153
The steps here aim to make the unavailable databases available.
154
154
155
155
. 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.
157
157
. Run `SHOW DATABASES`.
158
158
If all databases are in desired states on all servers (`requestedStatus`=`currentStatus`), disaster recovery is complete.
159
159
// . For each database that remains unavailable, refer to <<unavailable-databases, Managing unavailable databases in a cluster>>.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/setup/analytics-cluster.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,6 +268,6 @@ If you want to follow along with the startup, you can see the messages in xref:c
268
268
== Running analytic queries
269
269
270
270
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.
272
272
273
273
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].
0 commit comments