Skip to content

Commit 33ff65e

Browse files
author
Frannie-Ludmilla
committed
Sync with definitions in monorepo
1 parent 1d93e9c commit 33ff65e

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ CALL dbms.cluster.statusCheck(databases :: LIST<STRING>, timeoutMilliseconds = n
3636
| Name | Type | Description
3737
| databases | List<String> | Databases for which the status check should run.
3838
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.
39-
| timeoutMilliseconds | Integer | How long to allow for replication, before returning it was unsuccessful.
39+
| timeoutMilliseconds | Integer | Specifies the maximum wait time for replication before marking it unsuccessful.
4040
Default value is 1000 milliseconds.
4141
|===
4242

@@ -58,7 +58,7 @@ The procedure returns a row for all primary members of all the requested databas
5858
| recognisedLeaderTerm | Integer | The term of the perceived leader of each primary member.
5959
If the members report different leaders, the one with the highest term should be trusted.
6060
| requester | Boolean | Whether a server is the requester or not.
61-
| error | String | Contains the error message if one is present.
61+
| 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.
6262
An example of an error is that one or more of the requested databases do not exist on the requester.
6363
|===
6464

modules/ROOT/pages/procedures.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ It will still run with the `Admin` privilege, but that should be considered depr
637637
| *Description* 3+a| Performs a rafted status check.
638638
.3+| *Input arguments* | *Name* | *Type* | *Description*
639639
| `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.
640-
| `timeoutMilliseconds` | `INTEGER` | How long to allow for replication, before returning it was unsuccessful. Default value is 1000 milliseconds.
640+
| `timeoutMilliseconds` | `INTEGER` | Specifies the maximum wait time for replication before marking it unsuccessful. Default value is 1000 milliseconds.
641641
.11+| *Return arguments* | *Name* | *Type* | *Description*
642642
| `database` | `STRING` | The database for which a status check entry was replicated.
643643
| `serverId` | `STRING` | The UUID of the server, which did or did not participate in a successful replication of the status check entry.
@@ -648,7 +648,7 @@ It will still run with the `Admin` privilege, but that should be considered depr
648648
| `recognisedLeader` | `STRING` | The server id of the perceived leader of each primary member.
649649
| `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.
650650
| `requester` | `BOOLEAN` | Whether a server is the requester or not.
651-
| `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.
651+
| `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.
652652
| *Mode* 3+| DBMS
653653
|===
654654

0 commit comments

Comments
 (0)