-
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| :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. | ||
|
|
||
NataliaIvakina marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [[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 on a cluster to work as expected. Furthermore, the Neo4j process must be shut down before the command is issued. | ||
AnnaSjerling marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
NataliaIvakina marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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]. | ||
|
|
||
| This does not affect the other databases cluster state. | ||
NataliaIvakina marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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. | ||
AnnaSjerling marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
NataliaIvakina marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.