Skip to content

Commit b9726ba

Browse files
JPryce-AklundhHunternessrenetapopova
authored
Cherry-picked SHOW command PRs (#3080)
Cherry-picks: - #3034 - #3033 - #3003 All content added post-LTS and any mention of Cypher 25 in the original PR's has been removed. --------- Co-authored-by: Therese Magnusson <scout.therese@gmail.com> Co-authored-by: Reneta Popova <reneta.popova@neo4j.com>
1 parent 971894e commit b9726ba

36 files changed

Lines changed: 1205 additions & 101 deletions

models/hospital/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ setup the users, roles and security privileges, and those running against
2323
the `healthcare` database for setting up the data model itself. These
2424
scripts do not include the queries used by the different users to query the
2525
database. See the docs at
26-
https://neo4j.com/docs/operations-manual/current/authentication-authorization/
26+
https://neo4j.com/docs/operations-manual/5/authentication-authorization/
2727
for example queries.
2828

2929
Run as `neo4j` against the `system` database:

modules/ROOT/content-nav.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
** xref:configuration/set-initial-password.adoc[]
8181
** xref:configuration/plugins.adoc[Plugins]
8282
** xref:configuration/dynamic-settings.adoc[]
83+
** xref:configuration/show-settings.adoc[]
8384
** xref:configuration/configuration-settings.adoc[]
8485
*** xref:configuration/configuration-settings.adoc#_checkpoint_settings[Checkpoint settings]
8586
*** xref:configuration/configuration-settings.adoc#_cloud_storage_integration_settings[Cloud storage integration settings]
@@ -130,6 +131,7 @@
130131
131132
* xref:database-internals/index.adoc[]
132133
** xref:database-internals/transaction-management.adoc[]
134+
** xref:database-internals/show-and-terminate-transactions.adoc[]
133135
** xref:database-internals/concurrent-data-access.adoc[]
134136
** xref:database-internals/transaction-logs.adoc[]
135137
** xref:database-internals/checkpointing.adoc[]
@@ -250,7 +252,10 @@
250252
*** xref:tools/neo4j-admin/validate-config.adoc[]
251253
** xref:tools/cypher-shell.adoc[]
252254
253-
* xref:procedures.adoc[]
255+
* Procedures
256+
** xref:procedures/call-procedures.adoc[]
257+
** xref:procedures/show-procedures.adoc[]
258+
** xref:procedures/built-in-procedures.adoc[]
254259
255260
* xref:tutorial/index.adoc[]
256261
//** xref:tutorial/local-causal-cluster.adoc[]

modules/ROOT/images/call-procedure.svg

Lines changed: 27 additions & 0 deletions
Loading

modules/ROOT/pages/authentication-authorization/dbms-administration/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ CREATE ROLE serverViewer IF NOT EXISTS;
7373

7474
All DBMS privileges are relevant system-wide.
7575
Like user management, they do not belong to one specific database or graph.
76-
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/current/introduction/cypher-neo4j/[Cypher Manual -> Cypher and Neo4j].
76+
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/5/introduction/cypher-neo4j/[Cypher Manual -> Cypher and Neo4j].
7777

7878
image::privileges-grant-and-deny-syntax-dbms-privileges.svg[width="800", title="Syntax of `GRANT` and `DENY` DBMS privileges"]
7979

@@ -142,7 +142,7 @@ In this case, `+*+` means 0 or more characters, and `?` matches exactly one char
142142

143143
[NOTE]
144144
====
145-
The name-globbing is subject to the link:{neo4j-docs-base-uri}/cypher-manual/current/syntax/naming/[Cypher Manual -> Naming rules and recommendations], with the exception that it may include dots, stars, and question marks without the need for escaping using backticks.
145+
The name-globbing is subject to the link:{neo4j-docs-base-uri}/cypher-manual/5/syntax/naming/[Cypher Manual -> Naming rules and recommendations], with the exception that it may include dots, stars, and question marks without the need for escaping using backticks.
146146
147147
Each part of the name-globbing separated by dots may be individually quoted.
148148
For example, `++mine.`procedureWith%`++` is allowed, but not `++mine.procedure`With%`++`.

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/authentication-authorization/property-based-access-control.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ This is essential when revoking property-based privileges containing evaluated f
161161

162162
[NOTE]
163163
====
164-
Not all temporal values are comparable, see link:{neo4j-docs-base-uri}/cypher-manual/current/values-and-types/ordering-equality-comparison[Cypher Manual -> Equality, ordering, and comparison of value types].
164+
Not all temporal values are comparable, see link:{neo4j-docs-base-uri}/cypher-manual/5/values-and-types/ordering-equality-comparison[Cypher Manual -> Equality, ordering, and comparison of value types].
165165
====
166166

167167
You can show the privilege created by the command in the previous example as a revoke command by running:

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, which 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 & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,13 +117,13 @@ 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.
125125

126-
You can also use the xref:procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
126+
You can also use the xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`] procedure.
127127
However, note that the procedure is deprecated in Neo4j 5.23.
128128

129129

@@ -146,9 +146,9 @@ Once a server is in a deallocating state, it subsequently cannot have databases
146146

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

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)`]
149+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServer[`dbms.cluster.deallocateDatabaseFromServer("server-name", "database-name")`]
150+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateDatabaseFromServers[`dbms.cluster.deallocateDatabaseFromServers(["server-name1", "server-name2"\], "database-name")`]
151+
* xref:procedures/built-in-procedures.adoc#procedure_dbms_cluster_deallocateNumberOfDatabases[`dbms.cluster.deallocateNumberOfDatabases("server-name", number)`]
152152

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

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.

0 commit comments

Comments
 (0)