1
1
2
- @startDocuBlock put_api_replication_makeSlave
3
- @brief Changes role to slave
2
+ @startDocuBlock put_api_replication_makeFollower
3
+ @brief Changes role to follower
4
4
5
- @RESTHEADER {PUT /_ api/replication/make-slave , Turn the server into a slave of another, handleCommandMakeSlave }
5
+ @RESTHEADER {PUT /_ api/replication/make-follower , Turn the server into a follower of another, handleCommandMakeFollower }
6
6
7
7
@RESTBODYPARAM {endpoint,string,required,string}
8
- the master endpoint to connect to (e.g. "tcp://192.168.173.13:8529").
8
+ the leader endpoint to connect to (e.g. "tcp://192.168.173.13:8529").
9
9
10
10
@RESTBODYPARAM {database,string,required,string}
11
- the database name on the master (if not specified, defaults to the
11
+ the database name on the leader (if not specified, defaults to the
12
12
name of the local current database).
13
13
14
14
@RESTBODYPARAM {username,string,optional,string}
15
- an optional ArangoDB username to use when connecting to the master .
15
+ an optional ArangoDB username to use when connecting to the leader .
16
16
17
17
@RESTBODYPARAM {password,string,required,string}
18
- the password to use when connecting to the master .
18
+ the password to use when connecting to the leader .
19
19
20
20
@RESTBODYPARAM {includeSystem,boolean,required,}
21
21
whether or not system collection operations will be applied
@@ -27,7 +27,7 @@ specified, the allowed values are *include* or *exclude*.
27
27
@RESTBODYPARAM {restrictCollections,array,optional,string}
28
28
an optional array of collections for use with * restrictType* .
29
29
If * restrictType* is * include* , only the specified collections
30
- will be sychronised . If * restrictType* is * exclude* , all but the specified
30
+ will be synchronized . If * restrictType* is * exclude* , all but the specified
31
31
collections will be synchronized.
32
32
33
33
@RESTBODYPARAM {maxConnectRetries,integer,optional,int64}
@@ -50,8 +50,8 @@ is used when the endpoint is contacted.
50
50
whether or not the replication applier will use adaptive polling.
51
51
52
52
@RESTBODYPARAM {autoResync,boolean,optional,}
53
- whether or not the slave should perform an automatic resynchronization with
54
- the master in case the master cannot serve log data requested by the slave ,
53
+ whether or not the follower should perform an automatic resynchronization with
54
+ the leader in case the leader cannot serve log data requested by the follower ,
55
55
or when the replication is started and no tick value can be found.
56
56
57
57
@RESTBODYPARAM {autoResyncRetries,integer,optional,int64}
@@ -63,42 +63,42 @@ in case resynchronizations always fail.
63
63
64
64
@RESTBODYPARAM {initialSyncMaxWaitTime,integer,optional,int64}
65
65
the maximum wait time (in seconds) that the initial synchronization will
66
- wait for a response from the master when fetching initial collection data.
66
+ wait for a response from the leader when fetching initial collection data.
67
67
This wait time can be used to control after what time the initial synchronization
68
68
will give up waiting for a response and fail. This value is relevant even
69
69
for continuous replication when * autoResync* is set to * true* because this
70
- may re-start the initial synchronization when the master cannot provide
71
- log data the slave requires.
70
+ may re-start the initial synchronization when the leader cannot provide
71
+ log data the follower requires.
72
72
This value will be ignored if set to * 0* .
73
73
74
74
@RESTBODYPARAM {connectionRetryWaitTime,integer,optional,int64}
75
75
the time (in seconds) that the applier will intentionally idle before
76
- it retries connecting to the master in case of connection problems.
76
+ it retries connecting to the leader in case of connection problems.
77
77
This value will be ignored if set to * 0* .
78
78
79
79
@RESTBODYPARAM {idleMinWaitTime,integer,optional,int64}
80
80
the minimum wait time (in seconds) that the applier will intentionally idle
81
- before fetching more log data from the master in case the master has
81
+ before fetching more log data from the leader in case the leader has
82
82
already sent all its log data. This wait time can be used to control the
83
83
frequency with which the replication applier sends HTTP log fetch requests
84
- to the master in case there is no write activity on the master .
84
+ to the leader in case there is no write activity on the leader .
85
85
This value will be ignored if set to * 0* .
86
86
87
87
@RESTBODYPARAM {idleMaxWaitTime,integer,optional,int64}
88
88
the maximum wait time (in seconds) that the applier will intentionally idle
89
- before fetching more log data from the master in case the master has
89
+ before fetching more log data from the leader in case the leader has
90
90
already sent all its log data and there have been previous log fetch attempts
91
91
that resulted in no more log data. This wait time can be used to control the
92
92
maximum frequency with which the replication applier sends HTTP log fetch
93
- requests to the master in case there is no write activity on the master for
93
+ requests to the leader in case there is no write activity on the leader for
94
94
longer periods. This configuration value will only be used if the option
95
95
* adaptivePolling* is set to * true* .
96
96
This value will be ignored if set to * 0* .
97
97
98
98
@RESTBODYPARAM {requireFromPresent,boolean,optional,}
99
99
if set to * true* , then the replication applier will check
100
100
at start of its continuous replication if the start tick from the dump phase
101
- is still present on the master . If not, then there would be data loss. If
101
+ is still present on the leader . If not, then there would be data loss. If
102
102
* requireFromPresent* is * true* , the replication applier will abort with an
103
103
appropriate error message. If set to * false* , then the replication applier will
104
104
still start, and ignore the data loss.
@@ -209,15 +209,15 @@ Please note that all "tick" values returned do not have a specific unit. Tick
209
209
values are only meaningful when compared to each other. Higher tick values mean
210
210
"later in time" than lower tick values.
211
211
212
- WARNING: calling this method will sychronize data from the collections found
213
- on the remote master to the local ArangoDB database. All data in the local
214
- collections will be purged and replaced with data from the master .
212
+ WARNING: calling this method will synchronize data from the collections found
213
+ on the remote leader to the local ArangoDB database. All data in the local
214
+ collections will be purged and replaced with data from the leader .
215
215
216
216
Use with caution!
217
217
218
218
Please also keep in mind that this command may take a long time to complete
219
219
and return. This is because it will first do a full data synchronization with
220
- the master , which will take time roughly proportional to the amount of data.
220
+ the leader , which will take time roughly proportional to the amount of data.
221
221
222
222
** Note** : this method is not supported on a Coordinator in a cluster.
223
223
0 commit comments