1
0
Fork 0

add minReplicationFactor to http documentation (#10529)

* add minReplicationFactor to http documentation

* reword

* add original text written by heiko

* fix typos

* try to fix rest structs
This commit is contained in:
Jan Christoph Uhde 2019-11-26 13:21:47 +01:00 committed by KVS85
parent 18408c882e
commit 2c1acb5bc7
3 changed files with 21 additions and 1 deletions

View File

@ -131,6 +131,20 @@ to all "follower" replicas, before the write operation is reported successful.
If a server fails, this is detected automatically and one of the servers holding
copies take over, usually without an error being reported.
@RESTBODYPARAM{minReplicationFactor,integer,optional,int64}
(optional, default is 1): in a cluster, this attribute determines how many
desired copies of each shard are kept on different DBServers. The value 1 means
that only one copy (no synchronous replication) is kept. A value of k means
that desired k-1 replicas are kept. If in a failover scenario a shard of a
collection has less than minReplicationFactor many insync followers it will go
into "read-only" mode and will reject writes until enough followers are insync
again.
**In more detail**: Having `minReplicationFactor == 1` means as soon as a
"master-copy" is available of the data writes are allowed. Having
`minReplicationFactor > 1` requires additional insync copies on follower
servers to allow writes.
@RESTBODYPARAM{distributeShardsLike,string,optional,string}
(The default is *""*): in an Enterprise Edition cluster, this attribute binds
the specifics of sharding for the newly created collection to follow that of a

View File

@ -21,6 +21,7 @@ The response is a JSON object with the following attributes:
- *replicationFactor*: the default replication factor for collections in this database
- *minReplicationFactor*: the default minimum replication factor for collections in this database
@RESTRETURNCODES

View File

@ -14,11 +14,16 @@ Optional object which can contain the following attributes:
The sharding method to use for new collections in this database. Valid values
are: "", "flexible", or "single". The first two are equivalent.
@RESTSTRUCT{replicationFactor,get_api_database_new_USERS,string,optional,number}
@RESTSTRUCT{replicationFactor,get_api_database_new_USERS,string,optional,}
Default replication factor for new collections created in this database.
Special values include "satellite", which will replicate the collection to
every DB-server, and 1, which disables replication.
@RESTSTRUCT{minReplicationFactor,get_api_database_new_USERS,number,optional,}
Default minimum replication factor for new collections created in this database.
If there are less than minReplicationFactor replicas available the collection
will become read-only.
@RESTBODYPARAM{users,array,optional,get_api_database_new_USERS}
Has to be an array of user objects to initially create for the new database.
User information will not be changed for users that already exist.