-
Couldn't load subscription status.
- Fork 83
Document the unbind-system-db command and add details about the system db in cluster #2631
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,83 @@ | ||||||||||||||
| :description: The page describes the neo4j-admin command `dbms unbind-system-db`. | ||||||||||||||
| [role=enterprise-edition] | ||||||||||||||
|
|
||||||||||||||
| = Unbind the `system` database | ||||||||||||||
|
|
||||||||||||||
| 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. | ||||||||||||||
|
|
||||||||||||||
| [CAUTION] | ||||||||||||||
| ==== | ||||||||||||||
| Executing the `neo4j-admin dbms unbind-system-db` command does not affect the cluster state of other standard databases. | ||||||||||||||
| 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. | ||||||||||||||
| ==== | ||||||||||||||
| [[unbind-system-db-syntax]] | ||||||||||||||
| == Syntax | ||||||||||||||
|
|
||||||||||||||
| The `neo4j-admin dbms unbind-system-db` command has the following syntax: | ||||||||||||||
|
|
||||||||||||||
| ---- | ||||||||||||||
| neo4j-admin dbms unbind-system-db [-h] [--expand-commands] [--verbose] [--archive-cluster-state[=true|false]] | ||||||||||||||
| [--additional-config=<file>] [--archive-path=<path>] | ||||||||||||||
| ---- | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| [[unbind-system-db-description]] | ||||||||||||||
| == Description | ||||||||||||||
|
|
||||||||||||||
| Removes and archives cluster state for `system` database. | ||||||||||||||
|
|
||||||||||||||
| [[unbind-system-db-options]] | ||||||||||||||
| == Options | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| The `neo4j-admin dbms unbind-system-db` command has the following options: | ||||||||||||||
|
|
||||||||||||||
| .`neo4j-admin dbms unbind-system-db` options | ||||||||||||||
| [options="header", cols="5m,6a,2m"] | ||||||||||||||
| |=== | ||||||||||||||
| | Option | ||||||||||||||
| | Description | ||||||||||||||
| | Default | ||||||||||||||
|
|
||||||||||||||
| |--additional-config=<file> | ||||||||||||||
| |Configuration file with additional configuration. | ||||||||||||||
| | | ||||||||||||||
|
|
||||||||||||||
| |--archive-cluster-state[=true\|false] | ||||||||||||||
| |Enable or disable the cluster state archiving. | ||||||||||||||
| |false | ||||||||||||||
|
|
||||||||||||||
| |--archive-path=<path> | ||||||||||||||
| |Destination (file or folder) of the cluster state archive. | ||||||||||||||
| | | ||||||||||||||
|
|
||||||||||||||
| |--expand-commands | ||||||||||||||
| |Allow command expansion in config value evaluation. | ||||||||||||||
| | | ||||||||||||||
|
|
||||||||||||||
| |-h, --help | ||||||||||||||
| |Show this help message and exit. | ||||||||||||||
| | | ||||||||||||||
|
|
||||||||||||||
| |--verbose | ||||||||||||||
| |Enable verbose output. | ||||||||||||||
| | | ||||||||||||||
| |=== | ||||||||||||||
|
|
||||||||||||||
| [[unbind-system-db-limitations]] | ||||||||||||||
| == Limitations | ||||||||||||||
|
|
||||||||||||||
| The Neo4j process must be shut down on all servers before running the `neo4j-admin dbms unbind-system-db` command. | ||||||||||||||
|
|
||||||||||||||
| [[unbind-system-db-usage]] | ||||||||||||||
| == Usage | ||||||||||||||
|
|
||||||||||||||
| 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. | ||||||||||||||
|
|
||||||||||||||
| This command should be run on all remaining members of a cluster to work as expected. | ||||||||||||||
NataliaIvakina marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||
| This command should be run on all remaining members of a cluster to work as expected. | |
| You must shut down all cluster members before running the command on each of them. | |
| 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]. | |
| The `neo4j-admin dbms unbind-system-db` command does not affect the cluster state of the standard databases. | |
| However, since all servers in the DBMS must be shut down when the command is issued, downtime is expected for all databases within the DBMS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @renetapopova! I applied your suggestions. Now it reads smoother.
Uh oh!
There was an error while loading. Please reload this page.