Skip to content

Commit 14a81c5

Browse files
author
Frannie-Ludmilla
committed
Add description to fields in RaftedStatusCheck procedure
1 parent 54dc59f commit 14a81c5

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

modules/ROOT/pages/procedures.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -665,19 +665,19 @@ It will still run with the `Admin` privilege, but that should be considered depr
665665
| *Syntax* 3+m| dbms.cluster.statusCheck(databases, timeoutMilliseconds) :: (database, serverId, serverName, address, replicationSuccessful, memberStatus, recognisedLeader, recognisedLeaderTerm, requester, error)
666666
| *Description* 3+a| Performs a rafted status check.
667667
.3+| *Input arguments* | *Name* | *Type* | *Description*
668-
| `databases` | `LIST<STRING>` | databases :: LIST<STRING>
669-
| `timeoutMilliseconds` | `INTEGER` | timeoutMilliseconds = null :: INTEGER
668+
| `databases` | `LIST<STRING>` | 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. it does not run on singles or secondaries.
669+
| `timeoutMilliseconds` | `INTEGER` | How long to allow for replication, before returning it was unsuccessful. Default value is 1000 milliseconds.
670670
.11+| *Return arguments* | *Name* | *Type* | *Description*
671-
| `database` | `STRING` | database :: STRING
672-
| `serverId` | `STRING` | serverId :: STRING
673-
| `serverName` | `STRING` | serverName :: STRING
674-
| `address` | `STRING` | address :: STRING
675-
| `replicationSuccessful` | `BOOLEAN` | replicationSuccessful :: BOOLEAN
676-
| `memberStatus` | `STRING` | memberStatus :: STRING
677-
| `recognisedLeader` | `STRING` | recognisedLeader :: STRING
678-
| `recognisedLeaderTerm` | `INTEGER` | recognisedLeaderTerm :: INTEGER
679-
| `requester` | `BOOLEAN` | requester :: BOOLEAN
680-
| `error` | `STRING` | error :: STRING
671+
| `database` | `STRING` | The database for which a status check entry was replicated.
672+
| `serverId` | `STRING` | The UUID of the server, which did or did not participate in a successful replication of the status check entry.
673+
| `serverName` | `STRING` | The friendly name of the server, or its UUID if no name is set.
674+
| `address` | `STRING` | The address of the Bolt port for the server.
675+
| `replicationSuccessful` | `BOOLEAN` | Indicates if the server (on which the procedure is run) can replicate a transaction.
676+
| `memberStatus` | `STRING` | The status of each primary member.
677+
| `recognisedLeader` | `STRING` | The server id of the perceived leader of each primary member.
678+
| `recognisedLeaderTerm` | `INTEGER` | 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.
679+
| `requester` | `BOOLEAN` | Whether a server is the requester or not.
680+
| `error` | `STRING` | Contains the error message if one is present. An example of an error is that one or more of the requested databases do not exist on the requester.
681681
| *Mode* 3+| DBMS
682682
|===
683683

0 commit comments

Comments
 (0)