Skip to content

Commit

Permalink
Sync with definitions in monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
Frannie-Ludmilla committed Dec 18, 2024
1 parent 14a81c5 commit 248f30b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions modules/ROOT/pages/clustering/monitoring/status-check.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ CALL dbms.cluster.statusCheck(databases :: LIST<STRING>, timeoutMilliseconds = n
| Name | Type | Description
| 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.
| timeoutMilliseconds | Integer | How long to allow for replication, before returning it was unsuccessful.
| timeoutMilliseconds | Integer | Specifies the maximum wait time for replication before marking it unsuccessful.
Default value is 1000 milliseconds.
|===

Expand All @@ -58,7 +58,7 @@ The procedure returns a row for all primary members of all the requested databas
| 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.
| requester | Boolean | Whether a server is the requester or not.
| error | String | Contains the error message if one is present.
| error | String | Contains any error message if present. An example of an error is that one or more of the requested databases do not exist on the requester.
An example of an error is that one or more of the requested databases do not exist on the requester.
|===

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/procedures.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ It will still run with the `Admin` privilege, but that should be considered depr
| *Description* 3+a| Performs a rafted status check.
.3+| *Input arguments* | *Name* | *Type* | *Description*
| `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.
| `timeoutMilliseconds` | `INTEGER` | How long to allow for replication, before returning it was unsuccessful. Default value is 1000 milliseconds.
| `timeoutMilliseconds` | `INTEGER` | Specifies the maximum wait time for replication before marking it unsuccessful. Default value is 1000 milliseconds.
.11+| *Return arguments* | *Name* | *Type* | *Description*
| `database` | `STRING` | The database for which a status check entry was replicated.
| `serverId` | `STRING` | The UUID of the server, which did or did not participate in a successful replication of the status check entry.
Expand All @@ -677,7 +677,7 @@ It will still run with the `Admin` privilege, but that should be considered depr
| `recognisedLeader` | `STRING` | The server id of the perceived leader of each primary member.
| `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.
| `requester` | `BOOLEAN` | Whether a server is the requester or not.
| `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.
| `error` | `STRING` | Contains any error message if present. An example of an error is that one or more of the requested databases do not exist on the requester.
| *Mode* 3+| DBMS
|===

Expand Down

0 comments on commit 248f30b

Please sign in to comment.