Server commands referenceEnterprise Edition
Servers can be added and managed using a set of Cypher administration commands executed against the system database.
When connected to the DBMS over bolt, administration commands are automatically routed to the system database.
Server management command syntax
More details about the syntax descriptions can be found here.
Command
ENABLE SERVER
Syntax
ENABLE SERVER 'serverId' [OPTIONS "{" option: value[,...] "}"]Description
Adds a server that has been discovered to the cluster. For more information see Enabled state.
Required privilege
GRANT SERVER MANAGEMENT
Command
ALTER SERVER
Syntax
ALTER SERVER 'name' SET OPTIONS "{" option: value[,...] "}"Description
Changes the constraints for a server. For more information see Altering server options.
Required privilege
GRANT SERVER MANAGEMENT
Command
RENAME SERVER
Syntax
RENAME SERVER 'name' TO 'newName'Description
Changes the name of a server. For more information see Renaming a server.
Required privilege
GRANT SERVER MANAGEMENT
Command
DEALLOCATE DATABASES
Syntax
[DRYRUN] DEALLOCATE DATABASE[S] FROM SERVER[S] 'name'[, ...]Description
Removes all databases from the given servers. For more information see Deallocating databases from server.
Required privilege
GRANT SERVER MANAGEMENT
Command
DROP SERVER
Syntax
DROP SERVER 'name'Description
Removes a server not hosting any databases from the cluster. For more information see Dropping a server.
Required privilege
GRANT SERVER MANAGEMENT
Command
SHOW SERVERS
Syntax
SHOW SERVER[S]
[YIELD { * | field[, ...] } [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]
[WHERE expression]
[RETURN field[, ...] [ORDER BY field[, ...]] [SKIP n] [LIMIT n]]Description
Lists all servers visible to the cluster. For more information see Listing servers.
Required privilege
GRANT SHOW SERVERS
Command
REALLOCATE DATABASES
Syntax
[DRYRUN] REALLOCATE DATABASE[S]Description
Re-balances databases among the servers in the cluster. For more information see Hosting databases on added servers.
Note that is a cluster-level command, not a server-level command.
Required privilege
GRANT SERVER MANAGEMENT