Skip to content

Commit da87ee2

Browse files
Improve the page on managing servers in cluster (#2686)
Co-authored-by: Jack Waudby <[email protected]>
1 parent 27e4d09 commit da87ee2

File tree

9 files changed

+243
-145
lines changed

9 files changed

+243
-145
lines changed

modules/ROOT/images/server-lifecycle.svg

Lines changed: 33 additions & 0 deletions
Loading
-93 KB
Binary file not shown.
-42.4 KB
Binary file not shown.
-48 KB
Binary file not shown.
-56.8 KB
Binary file not shown.

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ The `system` database contains metadata on the DBMS and security configuration.
1616
When connected to this database you can only perform a specific set of administrative tasks, such as managing databases, servers, and access control.
1717

1818
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.
19+
To configure its mode, use the xref:configuration/configuration-settings.adoc#config_server.cluster.system_database_mode[`server.cluster.system_database_mode`] setting in the _neo4j.conf_ file.
20+
This has to be done before starting the Neo4j process.
2021

2122
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`].
2223
This setting defaults to `3`.

modules/ROOT/pages/clustering/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This chapter describes the following:
1717
* xref:clustering/servers.adoc[Managing servers in a cluster] -- How to manage the servers in a cluster.
1818
* xref:clustering/unbind.adoc[Unbind a server] -- How to remove and archive the cluster state of a cluster server so that it can rebind to a cluster.
1919
* xref:clustering/databases.adoc[Managing databases in a cluster] -- How to manage the databases in a cluster.
20+
* xref:clustering/unbind-system-database.adoc[Unbind the `system` database] -- How to remove and archive the cluster state for the `system` database.
2021
* Monitoring -- Monitoring of a cluster.
2122
** xref:clustering/monitoring/show-servers-monitoring.adoc[Monitor servers] -- The tools available for monitoring the servers in a cluster.
2223
** xref:clustering/monitoring/show-databases-monitoring.adoc[Monitor databases] -- The tools available for monitoring the databases in a cluster.
Lines changed: 50 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
:description: This section provides a summary of server management Cypher syntax.
22
[role=enterprise-edition]
33
[[server-commands-reference]]
4-
= Server commands reference
4+
= Server management command syntax
55

6-
Servers can be added and managed using a set of Cypher administration commands executed against the `system` database.
6+
Servers can be added and managed using a set of Cypher administrative commands executed against the `system` database.
77

8-
When connected to the DBMS over `bolt`, administration commands are automatically routed to the `system` database.
8+
When connected to the DBMS over `bolt`, administrative commands are automatically routed to the `system` database.
99

1010

1111
[[server-management-syntax]]
1212
== Server management command syntax
1313

1414
[NOTE]
1515
====
16-
More details about the syntax descriptions can be found xref:database-administration/syntax.adoc[here].
16+
More details about the syntax descriptions can be found on the page xref:database-administration/syntax.adoc#administration-syntax-reading[Database management command syntax -> Reading the administrative commands syntax].
1717
====
1818

19+
=== Enable a server
20+
1921
[cols="<15s,<85"]
2022
|===
2123
| Command
@@ -38,73 +40,86 @@ a| `GRANT SERVER MANAGEMENT`
3840
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
3941
|===
4042

43+
44+
=== List servers
45+
4146
[cols="<15s,<85"]
4247
|===
4348
| Command
44-
m| ALTER SERVER
49+
m| SHOW SERVERS
4550

4651
| Syntax
4752
a|
4853
[source, syntax, role=noheader]
4954
----
50-
ALTER SERVER 'name' SET OPTIONS "{" option: value[,...] "}"
55+
SHOW SERVER[S]
56+
[YIELD { * \| field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
57+
[WHERE expression]
58+
[RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
5159
----
5260

5361
| Description
54-
a| Changes the constraints for a server.
55-
For more information see xref:clustering/servers.adoc#alter-server-options[Altering server options].
62+
a| Lists all servers visible to the cluster.
63+
For more information see xref:clustering/servers.adoc#_listing_servers[Listing servers].
5664

5765
| Required privilege
58-
a| `GRANT SERVER MANAGEMENT`
66+
a| `GRANT SHOW SERVERS`
5967

6068
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
6169
|===
6270

71+
72+
=== Alter server's options
73+
6374
[cols="<15s,<85"]
6475
|===
6576
| Command
66-
m| RENAME SERVER
77+
m| ALTER SERVER
6778

6879
| Syntax
6980
a|
7081
[source, syntax, role=noheader]
7182
----
72-
RENAME SERVER 'name' TO 'newName'
83+
ALTER SERVER 'name' SET OPTIONS "{" option: value[,...] "}"
7384
----
7485

7586
| Description
76-
a| Changes the name of a server.
77-
For more information see xref:clustering/servers.adoc#_renaming_a_server[Renaming a server].
87+
a| Changes the constraints for a server.
88+
For more information see xref:clustering/servers.adoc#alter-server-options[Altering server options].
7889

7990
| Required privilege
8091
a| `GRANT SERVER MANAGEMENT`
8192

8293
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
8394
|===
8495

96+
=== Rename a server
8597

8698
[cols="<15s,<85"]
8799
|===
88100
| Command
89-
m| DEALLOCATE DATABASES
101+
m| RENAME SERVER
90102

91103
| Syntax
92104
a|
93105
[source, syntax, role=noheader]
94106
----
95-
[DRYRUN] DEALLOCATE DATABASE[S] FROM SERVER[S] 'name'[, ...]
107+
RENAME SERVER 'name' TO 'newName'
96108
----
97109

98110
| Description
99-
a| Removes all databases from the given servers.
100-
For more information see xref:clustering/servers.adoc#_deallocating_databases_from_a_server[Deallocating databases from server].
111+
a| Changes the name of a server.
112+
For more information see xref:clustering/servers.adoc#_renaming_a_server[Renaming a server].
101113

102114
| Required privilege
103115
a| `GRANT SERVER MANAGEMENT`
104116

105117
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
106118
|===
107119

120+
121+
=== Remove a server
122+
108123
[cols="<15s,<85"]
109124
|===
110125
| Command
@@ -127,51 +142,55 @@ a| `GRANT SERVER MANAGEMENT`
127142
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
128143
|===
129144

145+
146+
=== Reallocate databases in a cluster
147+
130148
[cols="<15s,<85"]
131149
|===
132150
| Command
133-
m| SHOW SERVERS
151+
m| REALLOCATE DATABASES
134152

135153
| Syntax
136154
a|
137155
[source, syntax, role=noheader]
138156
----
139-
SHOW SERVER[S]
140-
[YIELD { * \| field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
141-
[WHERE expression]
142-
[RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
157+
[DRYRUN] REALLOCATE DATABASE[S]
143158
----
144159

145160
| Description
146-
a| Lists all servers visible to the cluster.
147-
For more information see xref:clustering/servers.adoc#_listing_servers[Listing servers].
161+
a| Re-balances databases among the servers in the cluster.
162+
For more information see xref:clustering/servers.adoc#_hosting_databases_on_added_servers[Hosting databases on added servers].
163+
164+
Note that is a cluster-level command, not a server-level command.
148165

149166
| Required privilege
150-
a| `GRANT SHOW SERVERS`
167+
a| `GRANT SERVER MANAGEMENT`
151168

152169
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
153170
|===
154171

172+
173+
=== Deallocate databases from a server
174+
155175
[cols="<15s,<85"]
156176
|===
157177
| Command
158-
m| REALLOCATE DATABASES
178+
m| DEALLOCATE DATABASES
159179

160180
| Syntax
161181
a|
162182
[source, syntax, role=noheader]
163183
----
164-
[DRYRUN] REALLOCATE DATABASE[S]
184+
[DRYRUN] DEALLOCATE DATABASE[S] FROM SERVER[S] 'name'[, ...]
165185
----
166186

167187
| Description
168-
a| Re-balances databases among the servers in the cluster.
169-
For more information see xref:clustering/servers.adoc#_hosting_databases_on_added_servers[Hosting databases on added servers].
170-
171-
Note that is a cluster-level command, not a server-level command.
188+
a| Removes all user databases from the given servers.
189+
For more information see xref:clustering/servers.adoc#_deallocating_databases_from_a_server[Deallocating databases from server].
172190

173191
| Required privilege
174192
a| `GRANT SERVER MANAGEMENT`
175193

176194
(see xref:authentication-authorization/dbms-administration.adoc#access-control-dbms-administration-privilege-management[SERVER MANAGEMENT privileges])
177195
|===
196+

0 commit comments

Comments
 (0)