Skip to content

Commit 53c3c3d

Browse files
Document the unbind-system-db command and add details about the system db in cluster
1 parent 6536db1 commit 53c3c3d

File tree

5 files changed

+98
-0
lines changed

5 files changed

+98
-0
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@
160160
** xref:clustering/servers.adoc[]
161161
** xref:clustering/unbind.adoc[]
162162
** xref:clustering/databases.adoc[]
163+
** xref:clustering/unbind-system-database.adoc[]
163164
** Monitoring
164165
*** xref:clustering/monitoring/show-servers-monitoring.adoc[]
165166
*** xref:clustering/monitoring/show-databases-monitoring.adoc[]

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ To specify the initial topology, use the command `CREATE DATABASE`.
99
To change the topology once the database is created, run the `ALTER DATABASE` command.
1010
If a database is no longer needed, the command `DROP DATABASE` deletes the database from the cluster.
1111

12+
[[cluster-system-db]]
13+
== The `system` database in a cluster
14+
15+
The `system` database contains metadata on the DBMS and security configuration.
16+
When connected to this database you can only perform a specific set of administrative tasks, such as managing databases, servers, and access control.
17+
18+
In the clustered environment, the `system` database can be in a primary or secondary mode.
19+
To configure its mode, use the xref:configuration/configuration-settings.adoc#config_server.cluster.system_database_mode[`server.cluster.system_database_mode`] setting.
20+
21+
Deploying a cluster for the first time, consider configuring the xref:configuration/configuration-settings.adoc#config_dbms.cluster.minimum_initial_system_primaries_count[`dbms.cluster.minimum_initial_system_primaries_count`].
22+
This setting defaults to `3`.
23+
See xref:clustering/setup/deploy.adoc[] for details.
24+
25+
For information on how to recover the `system` database, refer to the xref:clustering/multi-region-deployment/disaster-recovery.adoc#make-the-system-database-write-available[Disaster recovery guide -> Make the `system` database write-available].
26+
27+
28+
1229
[[create-database]]
1330
== `CREATE DATABASE`
1431

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
:description: The page describes the neo4j-admin command `dbms unbind-system-db`.
2+
[role=enterprise-edition]
3+
4+
= Unbind the `system` database
5+
6+
You can use the `neo4j-admin dbms unbind-system-db` command to remove and archive the cluster state for the `system` database, so that the server can rebind to a new `system` database in the cluster.
7+
8+
[[unbind-system-db-syntax]]
9+
== Syntax
10+
11+
The `neo4j-admin dbms unbind-system-db` command has the following syntax:
12+
13+
----
14+
neo4j-admin dbms unbind-system-db [-h] [--expand-commands] [--verbose] [--archive-cluster-state[=true|false]]
15+
[--additional-config=<file>] [--archive-path=<path>]
16+
----
17+
18+
19+
[[unbind-system-db-description]]
20+
== Description
21+
22+
Removes and archives cluster state for `system` database.
23+
24+
[[unbind-system-db-options]]
25+
== Options
26+
27+
28+
The `neo4j-admin dbms unbind-system-db` command has the following options:
29+
30+
.`neo4j-admin dbms unbind-system-db` options
31+
[options="header", cols="5m,6a,2m"]
32+
|===
33+
| Option
34+
| Description
35+
| Default
36+
37+
|--additional-config=<file>
38+
|Configuration file with additional configuration.
39+
|
40+
41+
|--archive-cluster-state[=true\|false]
42+
|Enable or disable the cluster state archiving.
43+
|false
44+
45+
|--archive-path=<path>
46+
|Destination (file or folder) of the cluster state archive.
47+
|
48+
49+
|--expand-commands
50+
|Allow command expansion in config value evaluation.
51+
|
52+
53+
|-h, --help
54+
|Show this help message and exit.
55+
|
56+
57+
|--verbose
58+
|Enable verbose output.
59+
|
60+
|===
61+
62+
[[unbind-system-db-limitations]]
63+
== Limitations
64+
65+
The Neo4j process must be shut down on all servers before running the `neo4j-admin dbms unbind-system-db` command.
66+
67+
[[unbind-system-db-usage]]
68+
== Usage
69+
70+
The `neo4j-admin dbms unbind-system-db` command removes and archives cluster state for the `system` database, so that the server can rebind to a new `system` database in a cluster.
71+
72+
This command should be run on all remaining members on a cluster to work as expected. Furthermore, the Neo4j process must be shut down before the command is issued.
73+
For details, see xref:clustering/multi-region-deployment/disaster-recovery.adoc#make-the-system-database-write-available[Disaster recovery guide -> Make the `system` database write-available].
74+
75+
This does not affect the other databases cluster state.
76+
However, since all servers in the DBMS need to be shut down when the command is issued, downtime is expected for all databases inside of the DBMS.
77+

modules/ROOT/pages/database-administration/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ image::manage-dbs-community.svg[title="A default Neo4j installation.",role=popup
8383
.An installation of Neo4j with multiple active databases, named `marketing`, `sales`, and `hr`:
8484
image::manage-dbs-enterprise.svg[title="A multiple database Neo4j installation.",role=popup]
8585

86+
For details about the `system` database in a clustered environment, refer to the xref:clustering/databases.adoc#cluster-system-db[Managing databases in a cluster -> The `system` database].
87+
8688
== Composite databases
8789

8890
A Composite database is a logical grouping of multiple graphs contained in other, standard databases.

modules/ROOT/pages/neo4j-admin-neo4j-cli.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ For details, see xref:configuration/set-initial-password.adoc[Set an initial pas
5959

6060
| `unbind-system-db`
6161
| Removes and archives the cluster state of the `system` database so the instance can rebind to a new cluster state of the `system` database.
62+
For details, see xref:clustering/unbind-system-database.adoc[].
6263

6364
.13+| `server`
6465

0 commit comments

Comments
 (0)