5.x release

.github/workflows/docs-deploy-surge.yml

@@ -1,8 +1,8 @@
 # Use this starter workflow to deploy HTML generated by Antora to surge.sh
 # Docs are published at <org>-<repo>-<deployid>.surge.sh
-
+#
 # By default, this workflow runs on completion of a workflow called "Verify docs PR"
-
+#
 # This workflow expects the triggering workflow to generate an artifact called "docs"
 # - update the reference to "docs" and "docs.zip" in this workflow if your triggering workflow generates an artifact with a different name
 
@@ -71,7 +71,6 @@ jobs:
       - id: unzip-changelog
         if: ${{ hashFiles('changelog.zip') != '' }}
         run: unzip changelog.zip
-
       - id: get-deploy-id
         run: |
           deployid=$(<deployid)
@@ -86,7 +85,6 @@ jobs:
         run: |
           deployurl=$ORG-$REPO-$DEPLOYID.surge.sh
           echo "deploy-url=$deployurl" >> $GITHUB_OUTPUT
-
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*

modules/ROOT/content-nav.adoc

@@ -148,6 +148,7 @@
 *** xref:clustering/monitoring/show-servers-monitoring.adoc[]
 *** xref:clustering/monitoring/show-databases-monitoring.adoc[]
 *** xref:clustering/monitoring/endpoints.adoc[]
+*** xref:clustering/monitoring/status-check.adoc[]
 ** xref:clustering/disaster-recovery.adoc[]
 //** xref:clustering/internals.adoc[]
 ** xref:clustering/settings.adoc[]

modules/ROOT/pages/authentication-authorization/property-based-access-control.adoc

@@ -7,7 +7,7 @@ CREATE ROLE regularUsers;
 ----
 ////
 
-[role=enterprise-edition aura-db-enterprise]
+:page-role: enterprise-edition aura-db-enterprise new-5.24
 [[property-based-access-control]]
 = Property-based access control
 

modules/ROOT/pages/clustering/index.adoc

@@ -19,6 +19,7 @@ This chapter describes the following:
 ** xref:clustering/monitoring/show-servers-monitoring.adoc[Monitor servers] -- The tools available for monitoring the servers in a cluster.
 ** xref:clustering/monitoring/show-databases-monitoring.adoc[Monitor databases] -- The tools available for monitoring the databases in a cluster.
 ** xref:clustering/monitoring/endpoints.adoc[Monitor cluster endpoints for status information] -- The endpoints and semantics of endpoints used to monitor the health of the cluster.
+** xref:clustering/monitoring/status-check.adoc[Cluster status check] label:new[Introduced in 5.24] -- The procedure that checks which databases are up-to-date and can participate in a successful replication.
 * xref:clustering/disaster-recovery.adoc[Disaster recovery] -- How to recover a cluster in the event of a disaster.
 * xref:clustering/settings.adoc[Settings reference] -- A summary of the most important cluster settings.
 * xref:clustering/server-syntax.adoc[Server commands reference] -- Reference of Cypher administrative commands to add and manage servers.

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

@@ -0,0 +1,77 @@
+:description: This section describes how to monitor a database's availability with the help of the cluster status check procedure.
+
+:page-role: enterprise-edition new-5.24
+[[cluster-status-check]]
+= Cluster status check
+
+Neo4j 5.24 introduces the xref:reference/procedures.adoc#procedure_dbms_cluster_statusCheck[`dbms.cluster.statusCheck()`] procedure, which can be used to monitor the ability to replicate in clustered databases, which in most cases means being able to write to the database.
+You can also use the procedure to check which members are up-to-date and can participate in a successful replication.
+Therefore, it is useful in determining the fault-tolerance of a clustered database as well.
+A third and final function is to determine the leader of the cluster.
+
+[NOTE]
+====
+The member on which the procedure is called replicates a dummy transaction in the same cluster as the real transactions, and verifies that it can be replicated and applied.
+
+Since the status check doesn't replicate an actual transaction, it's not guaranteed that the database is write available even though the status check reports that it can replicate.
+Apart from replication there are other stops in the write path that can potentially block a transaction from being applied, e.g. issues in the database.
+However, it tells that the cluster is healthy and in most cases that means that the database is write available.
+====
+
+[[procedure-syntax]]
+== Syntax
+
+[source, shell]
+----
+CALL dbms.cluster.statusCheck(databases :: LIST<STRING>, timeoutMilliseconds = null :: INTEGER)
+----
+
+* *databases:* the list of databases for which the status check should run.
+Providing an empty list runs the status check for all *clustered* databases on that server, i.e. the status check won't run on singles or secondaries.
+* *timeoutMilliseconds:* specifies how long the replication may take.
+Default value is 1000 milliseconds.
+If replication takes longer than this timeout, it will return that replication is unsuccessful.
+
+
+The procedure returns a row for all primary members of all the requested databases where each row consists of:
+
+* *database:* the database for which the `status check entry` was replicated.
+* *serverId:* the server id of each primary member, which did or did not participate in a successful replication of the `status check entry`.
+* *serverName:* the server name of each primary member.
+* *address:* the Bolt address of each primary member.
+* *replicationSuccessful:* indicates if the server (on which the procedure is run) can replicate a transaction.
++
+** `TRUE` -- if this server managed to replicate the dummy transaction to a majority of cluster members within the given timeout.
+** `FALSE` -- if it failed to replicate within the timeout.
+The value is the same column-wise.
+A failed replication can either mean a real issue in the cluster (e.g., no leader) or that this server is too far behind in apply and can't replicate.
+* *memberStatus:* shows the status of each primary member.
+It can be `APPLYING`, `REPLICATING`, or `UNAVAILABLE`.
++
+** `APPLYING` means that the member can replicate and is actively applying transactions.
+** `REPLICATING` means that the member can participate in replicating, but can't apply.
+This state is uncommon, but may happen while waiting for the database to start and accept transactions.
+* *recognisedLeader:* shows the server id of the perceived leader of each primary member.
+* *recognisedLeaderTerm:* shows the term of the perceived leader of each primary member.
+If the members report different leaders, the one with the highest term should be trusted.
+* *requester:* is `TRUE` for the server on which the procedure is run, and `FALSE` on the remaining servers.
+* *error:* contains the error message if there is one.
+An example of an error is that one or more of the requested databases doesn't exist on the requester.
+
+In general, you can use the `replicationSuccessful` field to determine overall write-availability, whereas the `memberStatus` field can be checked in order to see whether the database is fault-tolerant or not.
+
+[NOTE]
+====
+Members that are `REPLICATING` are good from a data safety point of view.
+They can participate in replication and keep the data durably until application.
+They are also up-to-date and therefore eligible leaders.
+So they add to the fault-tolerance.
+
+Members that are `APPLYING` have all the qualities of `REPLICATING` members, so they too add to the fault-tolerance.
+But they are also applying to the database, which is a requirement for writing transactions and reading with bookmarks in a timely manner.
+
+Lastly, `UNAVAILABLE` members are either too far behind or unreachable.
+They are unhealthy and cannot add to the fault-tolerance.
+====
+
+

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

@@ -363,8 +363,6 @@ m|
 [[config_dbms.cluster.discovery.v2.endpoints]]
 === `dbms.cluster.discovery.v2.endpoints`
 
-// label:enterprise-edition[Enterprise Edition]
-
 .dbms.cluster.discovery.v2.endpoints
 [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
 |===
@@ -382,8 +380,6 @@ m|
 [[config_dbms.cluster.discovery.version]]
 === `dbms.cluster.discovery.version`
 
-// label:enterprise-edition[Enterprise Edition]
-
 .dbms.cluster.discovery.version
 [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
 |===
@@ -744,7 +740,7 @@ m|+++false+++
 |===
 
 
-[role=label--enterprise-edition]
+[role=label--enterprise-edition label--deprecated-5.23]
 [[config_initial.dbms.database_allocator]]
 === `initial.dbms.database_allocator`
 
@@ -3578,8 +3574,6 @@ m|
 [[config_dbms.kubernetes.discovery.v2.service_port_name]]
 === `dbms.kubernetes.discovery.v2.service_port_name`
 
-// label:enterprise-edition[Enterprise Edition]
-
 .dbms.kubernetes.discovery.v2.service_port_name
 [frame="topbot", stripes=odd, grid="cols", cols="<1s,<4"]
 |===

modules/ROOT/pages/reference/procedures.adoc

@@ -524,6 +524,11 @@ Replaced by: xref:reference/procedures.adoc#procedure_dbms_routing_getroutingtab
 Before Neo4j 5.23, the procedure can be run only with the `Admin` privileges. +
 Replaced by xref:clustering/server-syntax.adoc#server-management-syntax[`ENABLE SERVER`].
 
+| xref:reference/procedures.adoc#procedure_dbms_setDatabaseAllocator[`dbms.setDatabaseAllocator()`]
+| label:no[]
+| label:yes[]
+| label:admin-only[] label:deprecated[Deprecated in 5.23]
+
 // New in 4.1
 | xref:reference/procedures.adoc#procedure_dbms_upgrade[`dbms.upgrade()`]
 | label:yes[]
@@ -2224,7 +2229,7 @@ m|DBMS
 
 
 [[procedure_dbms_setDatabaseAllocator]]
-[role=label--enterprise-edition label--admin-only]
+[role=label--enterprise-edition label--admin-only label--deprecated-5.23]
 .dbms.setDatabaseAllocator()
 [cols="<15s,<85"]
 |===

modules/ROOT/pages/tools/cypher-shell.adoc

@@ -63,6 +63,10 @@ The syntax for running Cypher Shell is:
 | Exit and report failures at the end of the input when reading from a file.
 |
 
+| --enable-autocompletions
+| Whether to enable Cypher autocompletions inside the CLI, which are disabled by default.
+|
+
 |--format {auto,verbose,plain}
 |Desired output format. Displays the results in tabular format if you use the shell interactively and with minimal formatting if you use it for scripting. +
 `verbose` displays results in a tabular format and prints statistics. +