Skip to content

Commit 102c9f0

Browse files
hkernbachrashtao
authored andcommitted
added documentation for minReplicationFactor (#296)
1 parent c9be5e0 commit 102c9f0

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs/Drivers/Java/Reference/Collection/CollectionManipulation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,17 @@ then returns collection information from the server.
3535
automatically and one of the servers holding copies take over, usually
3636
without an error being reported.
3737

38+
- **minReplicationFactor**: `Integer`
39+
40+
(optional, default is 1): in a cluster, this
41+
attribute determines how many copies of each shard are required
42+
to be in sync on the different DBServers. If we have less then these
43+
many copies in the cluster a shard will refuse to write. The
44+
minReplicationFactor can not be larger than replicationFactor.
45+
Please note: during server failures this might lead to writes
46+
not being possible until the failover is sorted out and might cause
47+
write slow downs in trade of data durability.
48+
3849
- **satellite**: `Boolean`
3950

4051
If the true the collection is created as a satellite collection.

docs/Drivers/Java/Reference/Graph/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,17 @@ name of the graph and a definition of its edges.
4343
automatically and one of the servers holding copies take over, usually
4444
without an error being reported.
4545

46+
- **minReplicationFactor**: `Integer`
47+
48+
(optional, default is 1): in a cluster, this
49+
attribute determines how many copies of each shard are required
50+
to be in sync on the different DBServers. If we have less then these
51+
many copies in the cluster a shard will refuse to write. The
52+
minReplicationFactor can not be larger than replicationFactor.
53+
Please note: during server failures this might lead to writes
54+
not being possible until the failover is sorted out and might cause
55+
write slow downs in trade of data durability.
56+
4657
- **numberOfShards**: `Integer`
4758

4859
The number of shards that is used for every collection within this graph.

0 commit comments

Comments
 (0)