Skip to content

Commit 2b6cbbd

Browse files
JPryce-AklundhrenetapopovaHunterness
committed
Prototype for moving List procedures page to Ops Manual (neo4j#3003)
See corresponding Cypher Manual PR: neo4j/docs-cypher#1531 --------- Co-authored-by: Reneta Popova <reneta.popova@neo4j.com> Co-authored-by: Therese Magnusson <scout.therese@gmail.com>
1 parent b3dc5bd commit 2b6cbbd

24 files changed

Lines changed: 1196 additions & 57 deletions

File tree

modules/ROOT/content-nav.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@
243243
** xref:monitoring/connection-management.adoc[]
244244
** xref:monitoring/background-jobs.adoc[]
245245
// ** xref:monitoring/cluster/index.adoc[]
246-
// *** xref:monitoring/cluster/procedures.adoc[]
246+
// *** xref:monitoring/cluster/procedures/built-in-procedures.adoc[]
247247
// *** xref:monitoring/cluster/http-endpoints.adoc[]
248248
249249
* xref:tools/index.adoc[]
@@ -260,7 +260,10 @@
260260
*** xref:tools/neo4j-admin/validate-config.adoc[]
261261
** xref:tools/cypher-shell.adoc[]
262262
263-
* xref:procedures.adoc[]
263+
* Procedures
264+
** xref:procedures/call-procedures.adoc[]
265+
** xref:procedures/show-procedures.adoc[]
266+
** xref:procedures/built-in-procedures.adoc[]
264267
265268
* xref:tutorial/index.adoc[]
266269
//** xref:tutorial/local-causal-cluster.adoc[]

modules/ROOT/images/call-procedure.svg

Lines changed: 27 additions & 0 deletions
Loading

modules/ROOT/pages/authentication-authorization/ldap-integration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ this LDAP group will fail authentication, even if their credentials are correct.
6565
|===
6666

6767
All settings are defined at server startup time in the default configuration file _xref:configuration/neo4j-conf.adoc[neo4j.conf]_ or can be modified at
68-
runtime using xref:procedures.adoc#procedure_dbms_setConfigValue[`dbms.setConfigValue()`].
68+
runtime using xref:procedures/built-in-procedures.adoc#procedure_dbms_setConfigValue[`dbms.setConfigValue()`].
6969

7070

7171
[[auth-ldap-configure-provider]]

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ For example, if only four servers exist, the command fails with an error.
6868
Also, it fails if two servers are set up with a mode constraint of primary, and three servers are set up with a mode constraint of secondary.
6969

7070
If `TOPOLOGY` is not specified, the database is created according to xref:configuration/configuration-settings.adoc#config_initial.dbms.default_primaries_count[`initial.dbms.default_primaries_count`] and xref:configuration/configuration-settings.adoc#config_initial.dbms.default_secondaries_count[`initial.dbms.default_secondaries_count`] specified in _neo4j.conf_.
71-
After cluster startup, you can overwrite these values using the xref:procedures.adoc#procedure_dbms_setDefaultAllocationNumbers[`dbms.setDefaultAllocationNumbers()`] procedure.
71+
After cluster startup, you can overwrite these values using the xref:procedures/built-in-procedures.adoc#procedure_dbms_setDefaultAllocationNumbers[`dbms.setDefaultAllocationNumbers()`] procedure.
7272

7373
A `CREATE DATABASE` command allocates the database, therefore there is no requirement to run `REALLOCATE DATABASES` (described in xref:clustering/servers.adoc#_hosting_databases_on_added_servers[Hosting databases on added servers]).
7474

@@ -172,9 +172,9 @@ By default, a newly created database has both read and write access.
172172

173173
To relieve the load of a specific server(s), you can use one of the following procedures to deallocate databases, causing the databases to be removed from the server(s) under pressure:
174174

175-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServer[`dbms.cluster.deallocateDatabaseFromServer("server-name", "database-name")`]
176-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServers[`dbms.cluster.deallocateDatabaseFromServers(["server-name1", "server-name2"\], "database-name")`]
177-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateNumberOfDatabases[`dbms.cluster.deallocateNumberOfDatabases("server-name", number)`]
175+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServer[`dbms.cluster.deallocateDatabaseFromServer("server-name", "database-name")`]
176+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServers[`dbms.cluster.deallocateDatabaseFromServers(["server-name1", "server-name2"\], "database-name")`]
177+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateNumberOfDatabases[`dbms.cluster.deallocateNumberOfDatabases("server-name", number)`]
178178

179179
[NOTE]
180180
====
@@ -227,7 +227,7 @@ To rebalance all database allocations across the cluster, for example, because y
227227
[[reallocate-databases-procedure]]
228228
=== Reallocate databases using a procedure
229229

230-
You can use the procedure xref:procedures.adoc#procedure_dbms_cluster_reallocateDatabase[`dbms.cluster.reallocateDatabase`] to rebalance a specific database across the cluster, or xref:procedures.adoc#procedure_dbms_cluster_reallocateNumberOfDatabases[`dbms.cluster.reallocateNumberOfDatabases`] to rebalance a number of database allocations across the cluster and relieve overloaded servers.
230+
You can use the procedure xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_reallocateDatabase[`dbms.cluster.reallocateDatabase`] to rebalance a specific database across the cluster, or xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_reallocateNumberOfDatabases[`dbms.cluster.reallocateNumberOfDatabases`] to rebalance a number of database allocations across the cluster and relieve overloaded servers.
231231
Note that if the cluster is already balanced, no reallocations will happen when running these procedures.
232232
These procedures do not require a server name and can be executed with or without a dry run.
233233

@@ -267,7 +267,7 @@ This command can also be used with `DRYRUN` to preview the new allocation of dat
267267
[CAUTION]
268268
====
269269
`REALLOCATE DATABASES` on a large cluster with many databases has the potential to move a lot of allocations at once, which might stress the cluster.
270-
Consider starting with more limited reallocations, such as xref:procedures.adoc#procedure_dbms_cluster_reallocateNumberOfDatabases[`dbms.cluster.reallocateNumberOfDatabases`] with a small number, and let the databases complete their reallocation before calling it again, until no more reallocations are necessary.
270+
Consider starting with more limited reallocations, such as xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_reallocateNumberOfDatabases[`dbms.cluster.reallocateNumberOfDatabases`] with a small number, and let the databases complete their reallocation before calling it again, until no more reallocations are necessary.
271271
====
272272

273273
[NOTE]
@@ -445,7 +445,7 @@ If the default database is initially created for you with a topology different t
445445
[[change-default-database]]
446446
=== Change the default database
447447

448-
You can use the procedure xref:procedures.adoc#procedure_dbms_setDefaultDatabase[`dbms.setDefaultDatabase("newDefaultDatabaseName")`] to change the default database for a DBMS.
448+
You can use the procedure xref:procedures/built-in-procedures.adoc#procedure_dbms_setDefaultDatabase[`dbms.setDefaultDatabase("newDefaultDatabaseName")`] to change the default database for a DBMS.
449449

450450
. Ensure that the database to be set as default exists, otherwise create it using the command `CREATE DATABASE <database-name>`.
451451
. Show the name and status of the current default database by using the command `SHOW DEFAULT DATABASE`.

modules/ROOT/pages/clustering/monitoring/status-check.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[[monitoring-replication]]
55
= Monitor replication status
66

7-
Neo4j 5.24 introduces the xref:procedures.adoc#procedure_dbms_cluster_statusCheck[`dbms.cluster.statusCheck()`] procedure, which can be used to monitor the ability to replicate in clustered databases.
7+
Neo4j 5.24 introduces the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_statusCheck[`dbms.cluster.statusCheck()`] procedure can be used to monitor the ability to replicate in clustered databases.
88
In most cases this means a clustered database is write available.
99
The procedure identifies which members of a clustered database are up-to-date and can participate in successful replication.
1010
Therefore, it is useful in determining the fault tolerance of a clustered database.

modules/ROOT/pages/clustering/servers.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,12 @@ A server in a _cordoned_ state cannot be assigned to host any newly created data
117117

118118
This state is primarily used for <<server-error-handling, error handling>>.
119119

120-
To transition a server from the _enabled_ to the _cordoned_ state, run the xref:procedures.adoc#procedure_dbms_cluster_cordonServer[`dbms.cluster.cordonServer()`] procedure.
120+
To transition a server from the _enabled_ to the _cordoned_ state, run the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_cordonServer[`dbms.cluster.cordonServer()`] procedure.
121121
Keep in mind that when decreasing the number of allocations of a database, allocations on cordoned servers are removed first.
122122

123123
A server in the _cordoned_ state can be transitioned to _deallocating_ state or back to _enabled_.
124124
To re-enable a server, run the `ENABLE SERVER` command.
125+
You can also use the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
125126

126127
You can also use the xref:procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
127128
However, note that the procedure is deprecated in Neo4j 5.23.
@@ -146,9 +147,9 @@ Once a server is in a deallocating state, it subsequently cannot have databases
146147

147148
However, you can deallocate databases from a server in a *reversible manner* by running one of the following procedures:
148149

149-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServer[`dbms.cluster.deallocateDatabaseFromServer("server-name", "database-name")`]
150-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServers[`dbms.cluster.deallocateDatabaseFromServers(["server-name1", "server-name2"\], "database-name")`]
151-
* xref:procedures.adoc#procedure_dbms_cluster_deallocateNumberOfDatabases[`dbms.cluster.deallocateNumberOfDatabases("server-name", number)`]
150+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServer[`dbms.cluster.deallocateDatabaseFromServer("server-name", "database-name")`]
151+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServers[`dbms.cluster.deallocateDatabaseFromServers(["server-name1", "server-name2"\], "database-name")`]
152+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateNumberOfDatabases[`dbms.cluster.deallocateNumberOfDatabases("server-name", number)`]
152153

153154
For details, see xref:clustering/databases.adoc#deallocate-databases[Managing databases in a cluster -> Deallocate databases].
154155

modules/ROOT/pages/clustering/settings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This server always only hosts those databases in `SECONDARY` mode.
2020

2121
| xref:configuration/configuration-settings.adoc#config_initial.dbms.automatically_enable_free_servers[`initial.dbms.automatically_enable_free_servers`]
2222
| This setting allows for auto-enable of servers in the `FREE` state.
23-
After startup, it can be changed with the xref:procedures.adoc#procedure_dbms_cluster_setAutomaticallyEnableFreeServers[`dbms.cluster.setAutomaticallyEnableFreeServers`] procedure.
23+
After startup, it can be changed with the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_setAutomaticallyEnableFreeServers[`dbms.cluster.setAutomaticallyEnableFreeServers`] procedure.
2424

2525
| xref:configuration/configuration-settings.adoc#config_server.cluster.system_database_mode[`server.cluster.system_database_mode`]
2626
| Every cluster member hosts the `system` database.

modules/ROOT/pages/clustering/setup/deploy.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ Points to consider:
6969

7070
* Any setting with the `initial` prefix is effective on the first startup of the DBMS and/or when a new server joins the cluster and has to be explicitly xref:clustering/servers.adoc#server-enabled-state[`ENABLED`].
7171
72-
* Changing the default number of primaries and secondaries dynamically can only be done with the xref:procedures.adoc#procedure_dbms_setDefaultAllocationNumbers[`dbms.setDefaultAllocationNumbers`] procedure.
72+
* Changing the default number of primaries and secondaries dynamically can only be done with the xref:procedures/built-in-procedures.adoc#procedure_dbms_setDefaultAllocationNumbers[`dbms.setDefaultAllocationNumbers`] procedure.
7373
See xref:clustering/databases.adoc#create-database[`CREATE DATABASE`] for more information.
7474
75-
* To view the current default settings, use the xref:procedures.adoc#procedure_dbms_showTopologyGraphConfig[`dbms.showTopologyGraphConfig`] procedure.
75+
* To view the current default settings, use the xref:procedures/built-in-procedures.adoc#procedure_dbms_showTopologyGraphConfig[`dbms.showTopologyGraphConfig`] procedure.
7676
7777
7878
[CAUTION]

modules/ROOT/pages/clustering/setup/routing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Client-side routing means that the application decides which cluster server to s
4242
Typically, this ensures that write operations are sent to the server currently acting as the `writer` for the target database, while read operations are sent to other servers.
4343

4444
Client-side routing is based on getting a routing table from a cluster server, and then using that information to make the routing decisions.
45-
Use the xref:procedures.adoc#procedure_dbms_routing_getRoutingTable[`dbms.routing.getRoutingTable()`] procedure to obtain a routing table.
45+
Use the xref:procedures/built-in-procedures.adoc#procedure_dbms_routing_getRoutingTable[`dbms.routing.getRoutingTable()`] procedure to obtain a routing table.
4646

4747
A routing table contains information about the servers and their roles as `writers`, `readers`, and `routers` for a specific database.
4848
There is usually one `writer`, though there may be none if the database is read-only or unhealthy.

modules/ROOT/pages/configuration/show-settings.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For general information about the `SHOW` command, see the link:{neo4j-docs-base-
1212
To retrieve settings on a specific server, you need to directly connect to it using `bolt` scheme.
1313
For more information, see the link:{neo4j-docs-base-uri}/bolt/current/bolt[Bolt protocol documentation].
1414
15-
* Configurations settings can also be listed using the xref:procedures.adoc#procedure_dbms_listConfig[`dbms.listConfig()`] procedure.
15+
* Configurations settings can also be listed using the xref:procedures/built-in-procedures.adoc#procedure_dbms_listConfig[`dbms.listConfig()`] procedure.
1616
====
1717

1818
[[syntax]]

0 commit comments

Comments
 (0)