8000 added missing description of "global" query parameter in replication … · waveray/arangodb@e31ed5c · GitHub
[go: up one dir, main page]
Skip to content

Commit e31ed5c

Browse files
jsteemannjsteemann
authored
added missing description of "global" query parameter in replication (arangodb#10839)
1 parent bfc85f7 commit e31ed5c

6 files changed

+37
-0
lines changed

‎Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
@RESTHEADER{GET /_api/replication/applier-state, State of the replication applier,handleCommandApplierGetState}
66

7+
@RESTQUERYPARAMETERS
8+
9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, returns the state of the global replication applier for all
11+
database. If set to *false*, returns the state of the replication applier in the
12+
selected database.
13+
714
@RESTDESCRIPTION
815
Returns the state of the replication applier, regardless of whether the
916
applier is currently running or not.

‎Documentation/DocuBlocks/Rest/Replication/get_api_wal_access_tail.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
@RESTQUERYPARAMETERS
88

9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, tails the WAL for all databases. If set to *false*, tails the
11+
WAL for the selected database.
12+
913
@RESTQUERYPARAM{from,number,optional}
1014
Exclusive lower bound tick value for results. On successive calls
1115
to this API you should set this to the value returned

‎Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
@RESTHEADER{GET /_api/replication/applier-config, Return configuration of replication applier, handleCommandApplierGetConfig}
66

7+
@RESTQUERYPARAMETERS
8+
9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, returns the configuration of the global replication applier for all
11+
database. If set to *false*, returns the configuration of the replication applier in the
12+
selected database.
13+
714
@RESTDESCRIPTION
815
Returns the configuration of the replication applier.
916

‎Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
@RESTHEADER{PUT /_api/replication/applier-config, Adjust configuration of replication applier,handleCommandApplierSetConfig}
66

7+
@RESTQUERYPARAMETERS
8+
9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, adjusts the configuration of the global replication applier for all
11+
database. If set to *false*, adjusts the configuration of the replication applier in the
12+
selected database.
13+
714
@RESTBODYPARAM{endpoint,string,required,string}
815
the logger server to connect to (e.g. "tcp://192.168.173.13:8529"). The endpoint must be specified.
916

‎Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
@RESTQUERYPARAMETERS
88

9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, starts the global replication applier for all
11+
database. If set to *false*, starts the replication applier in the
12+
selected database.
13+
914
@RESTQUERYPARAM{from,string,optional}
1015
The remote *lastLogTick* value from which to start applying. If not specified,
1116
the last saved tick from the previous applier run is used. If there is no

‎Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
@RESTHEADER{PUT /_api/replication/applier-stop, Stop replication applier,handleCommandApplierStop}
66

7+
@RESTQUERYPARAMETERS
8+
9+
@RESTQUERYPARAM{global,boolean,optional}
10+
If set to *true*, stops the global replication applier for all
11+
database. If set to *false*, stops the replication applier in the
12+
selected database.
13+
714
@RESTDESCRIPTION
815
Stops the replication applier. This will return immediately if the
916
replication applier is not running.

0 commit comments

Comments
 (0)
0