Skip to content

Commit

Permalink
Update warning on how and when to use the unbind command (#2000) (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
NataliaIvakina authored Dec 18, 2024
1 parent ea59730 commit 0ff6474
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions modules/ROOT/pages/tools/neo4j-admin/unbind.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@

You can use the `neo4j-admin server unbind` command to remove and archive the cluster state of a cluster server so that it can rebind to a cluster.

[WARNING]
====
Due to the new clustering architecture in Neo4j 5.x, the behavior of the `unbind` command has changed significantly compared to Neo4j 4.4.
Running the `unbind` command on any number of servers may result in the loss of cluster quorum, severely affecting clustering functionality.
Therefore, it is strongly recommended to consult with Neo4j Support before using the `unbind` command.
In Neo4j 5.x, use the `unbind` command only when troubleshooting **a specific server** and remember there is no guarantee that the allocator will reassign the same databases to this server, potentially resulting in orphaned database stores.
The `unbind` command preserves all database stores on the server; and when the unbound server is restarted and enabled, it is seen as an entirely new server.
====

[[unbind-command-syntax]]
== Syntax

Expand Down Expand Up @@ -69,14 +81,6 @@ You can use the `neo4j-admin server unbind` command to remove the cluster state
To remove the cluster state of a server, run the `neo4j-admin server unbind` command from the _<NEO4J_HOME>_ folder of that server.
When restarted, an unbound server rejoins the cluster as a new server and has to be enabled using the `ENABLE SERVER` command.

[WARNING]
====
Note that the `unbind` command preserves all database stores on the server.
When the unbound server is restarted and enabled, it is seen as an entirely new server.
Therefore, there is no guarantee that the allocator will pick this server to host the same databases.
This may lead to having orphaned database stores on this server.
====

=== Turn a cluster member into a standalone server

To start the Neo4j server in single (standalone) mode after unbinding it from the cluster, verify that xref:configuration/configuration-settings.adoc#config_initial.server.mode_constraint[`initial.server.mode_constraint`] is set to `NONE` in xref:configuration/neo4j-conf.adoc[The neo4j.conf file].
Expand Down

0 comments on commit 0ff6474

Please sign in to comment.