You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/authentication-authorization/ldap-integration.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ this LDAP group will fail authentication, even if their credentials are correct.
65
65
|===
66
66
67
67
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()`].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/databases.adoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ For example, if only four servers exist, the command fails with an error.
68
68
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.
69
69
70
70
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.
72
72
73
73
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]).
74
74
@@ -172,9 +172,9 @@ By default, a newly created database has both read and write access.
172
172
173
173
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:
@@ -227,7 +227,7 @@ To rebalance all database allocations across the cluster, for example, because y
227
227
[[reallocate-databases-procedure]]
228
228
=== Reallocate databases using a procedure
229
229
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.
231
231
Note that if the cluster is already balanced, no reallocations will happen when running these procedures.
232
232
These procedures do not require a server name and can be executed with or without a dry run.
233
233
@@ -267,7 +267,7 @@ This command can also be used with `DRYRUN` to preview the new allocation of dat
267
267
[CAUTION]
268
268
====
269
269
`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.
271
271
====
272
272
273
273
[NOTE]
@@ -445,7 +445,7 @@ If the default database is initially created for you with a topology different t
445
445
[[change-default-database]]
446
446
=== Change the default database
447
447
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.
449
449
450
450
. Ensure that the database to be set as default exists, otherwise create it using the command `CREATE DATABASE <database-name>`.
451
451
. Show the name and status of the current default database by using the command `SHOW DEFAULT DATABASE`.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/monitoring/status-check.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
[[monitoring-replication]]
5
5
= Monitor replication status
6
6
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.
8
8
In most cases this means a clustered database is write available.
9
9
The procedure identifies which members of a clustered database are up-to-date and can participate in successful replication.
10
10
Therefore, it is useful in determining the fault tolerance of a clustered database.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/servers.adoc
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,11 +117,12 @@ A server in a _cordoned_ state cannot be assigned to host any newly created data
117
117
118
118
This state is primarily used for <<server-error-handling, error handling>>.
119
119
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.
121
121
Keep in mind that when decreasing the number of allocations of a database, allocations on cordoned servers are removed first.
122
122
123
123
A server in the _cordoned_ state can be transitioned to _deallocating_ state or back to _enabled_.
124
124
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.
125
126
126
127
You can also use the xref:procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
127
128
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
146
147
147
148
However, you can deallocate databases from a server in a *reversible manner* by running one of the following procedures:
| 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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/setup/deploy.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,10 +69,10 @@ Points to consider:
69
69
70
70
* 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`].
71
71
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.
73
73
See xref:clustering/databases.adoc#create-database[`CREATE DATABASE`] for more information.
74
74
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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/clustering/setup/routing.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Client-side routing means that the application decides which cluster server to s
42
42
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.
43
43
44
44
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.
46
46
47
47
A routing table contains information about the servers and their roles as `writers`, `readers`, and `routers` for a specific database.
48
48
There is usually one `writer`, though there may be none if the database is read-only or unhealthy.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/configuration/show-settings.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ For general information about the `SHOW` command, see the link:{neo4j-docs-base-
12
12
To retrieve settings on a specific server, you need to directly connect to it using `bolt` scheme.
13
13
For more information, see the link:{neo4j-docs-base-uri}/bolt/current/bolt[Bolt protocol documentation].
14
14
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.
0 commit comments