From 619ea5c2c53a555810fa0306958f95afd4022f30 Mon Sep 17 00:00:00 2001 From: hkernbach Date: Mon, 19 Aug 2019 11:58:11 +0200 Subject: [PATCH] added documentation for minReplicationFactor --- .../Reference/Collection/CollectionManipulation.md | 11 +++++++++++ docs/Drivers/Java/Reference/Graph/README.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md index e6f4f1f78..1c3a7de26 100644 --- a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md @@ -35,6 +35,17 @@ then returns collection information from the server. automatically and one of the servers holding copies take over, usually without an error being reported. + - **minReplicationFactor**: `Integer` + + (optional, default is 1): in a cluster, this + attribute determines how many copies of each shard are required + to be in sync on the different DBServers. If we have less then these + many copies in the cluster a shard will refuse to write. The + minReplicationFactor can not be larger than replicationFactor. + Please note: during server failures this might lead to writes + not being possible until the failover is sorted out and might cause + write slow downs in trade of data durability. + - **satellite**: `Boolean` If the true the collection is created as a satellite collection. diff --git a/docs/Drivers/Java/Reference/Graph/README.md b/docs/Drivers/Java/Reference/Graph/README.md index 2bb454492..1270c8613 100644 --- a/docs/Drivers/Java/Reference/Graph/README.md +++ b/docs/Drivers/Java/Reference/Graph/README.md @@ -43,6 +43,17 @@ name of the graph and a definition of its edges. automatically and one of the servers holding copies take over, usually without an error being reported. + - **minReplicationFactor**: `Integer` + + (optional, default is 1): in a cluster, this + attribute determines how many copies of each shard are required + to be in sync on the different DBServers. If we have less then these + many copies in the cluster a shard will refuse to write. The + minReplicationFactor can not be larger than replicationFactor. + Please note: during server failures this might lead to writes + not being possible until the failover is sorted out and might cause + write slow downs in trade of data durability. + - **numberOfShards**: `Integer` The number of shards that is used for every collection within this graph.