|
| 1 | +:description: The page describes the neo4j-admin command `dbms unbind-system-db`. |
| 2 | +[role=enterprise-edition new-5.0] |
| 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 | +[CAUTION] |
| 9 | +==== |
| 10 | +Executing the `neo4j-admin dbms unbind-system-db` command does not affect the cluster state of other standard databases. |
| 11 | +However, since all servers in the DBMS need to be shut down to run the command, downtime will occur for all databases inside of the DBMS. |
| 12 | +==== |
| 13 | +[[unbind-system-db-syntax]] |
| 14 | +== Syntax |
| 15 | + |
| 16 | +The `neo4j-admin dbms unbind-system-db` command has the following syntax: |
| 17 | + |
| 18 | +---- |
| 19 | +neo4j-admin dbms unbind-system-db [-h] [--expand-commands] [--verbose] [--archive-cluster-state[=true|false]] |
| 20 | + [--additional-config=<file>] [--archive-path=<path>] |
| 21 | +---- |
| 22 | + |
| 23 | + |
| 24 | +[[unbind-system-db-description]] |
| 25 | +== Description |
| 26 | + |
| 27 | +Removes and archives cluster state for `system` database. |
| 28 | + |
| 29 | +[[unbind-system-db-options]] |
| 30 | +== Options |
| 31 | + |
| 32 | + |
| 33 | +The `neo4j-admin dbms unbind-system-db` command has the following options: |
| 34 | + |
| 35 | +.`neo4j-admin dbms unbind-system-db` options |
| 36 | +[options="header", cols="5m,6a,2m"] |
| 37 | +|=== |
| 38 | +| Option |
| 39 | +| Description |
| 40 | +| Default |
| 41 | + |
| 42 | +|--additional-config=<file> |
| 43 | +|Configuration file with additional configuration. |
| 44 | +| |
| 45 | + |
| 46 | +|--archive-cluster-state[=true\|false] |
| 47 | +|Enable or disable the cluster state archiving. |
| 48 | +|false |
| 49 | + |
| 50 | +|--archive-path=<path> |
| 51 | +|Destination (file or folder) of the cluster state archive. |
| 52 | +| |
| 53 | + |
| 54 | +|--expand-commands |
| 55 | +|Allow command expansion in config value evaluation. |
| 56 | +| |
| 57 | + |
| 58 | +|-h, --help |
| 59 | +|Show this help message and exit. |
| 60 | +| |
| 61 | + |
| 62 | +|--verbose |
| 63 | +|Enable verbose output. |
| 64 | +| |
| 65 | +|=== |
| 66 | + |
| 67 | +[[unbind-system-db-limitations]] |
| 68 | +== Limitations |
| 69 | + |
| 70 | +The Neo4j process must be shut down on all servers before running the `neo4j-admin dbms unbind-system-db` command. |
| 71 | + |
| 72 | +[[unbind-system-db-usage]] |
| 73 | +== Usage |
| 74 | + |
| 75 | +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. |
| 76 | + |
| 77 | +You must shut down all cluster members before running the command on each of them. |
| 78 | +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]. |
| 79 | + |
| 80 | +The `neo4j-admin dbms unbind-system-db` command does not affect the cluster state of the standard databases. |
| 81 | +However, since all servers in the DBMS must be shut down before the command is issued, downtime is expected for all databases within the DBMS. |
| 82 | + |
0 commit comments