Skip to content

Commit a325ce5

Browse files
authored
Clarify what single shard means and that leader shards are placed on one node (#361)
Follower shards are also placed on one node
1 parent 35947ea commit a325ce5

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed

site/content/3.10/deploy/oneshard.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@ archetype: default
1010
{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
1111

1212
The OneShard option for ArangoDB clusters restricts all collections of a
13-
database to a single shard and places them on one DB-Server node. This way,
14-
whole queries can be pushed to and executed on that server, massively reducing
15-
cluster-internal communication. The Coordinator only gets back the final result.
13+
database to a single shard so that every collection has `numberOfShards` set to `1`,
14+
and all leader shards are placed on one DB-Server node. This way, whole queries
15+
can be pushed to and executed on that server, massively reducing cluster-internal
16+
communication. The Coordinator only gets back the final result.
1617

1718
Queries are always limited to a single database, and with the data of a whole
1819
database on a single node, the OneShard option allows running transactions with
1920
ACID guarantees on shard leaders.
2021

22+
Collections can have replicas by setting a `replicationFactor` greater than `1`
23+
as usual. For each replica, the follower shards are all placed on one DB-Server
24+
node when using the OneShard option. This allows for a quick failover in case
25+
the DB-Server with the leader shards fails.
26+
2127
A OneShard setup is highly recommended for most graph use cases and join-heavy
2228
queries.
2329

site/content/3.11/deploy/oneshard.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@ archetype: default
1010
{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
1111

1212
The OneShard option for ArangoDB clusters restricts all collections of a
13-
database to a single shard and places them on one DB-Server node. This way,
14-
whole queries can be pushed to and executed on that server, massively reducing
15-
cluster-internal communication. The Coordinator only gets back the final result.
13+
database to a single shard so that every collection has `numberOfShards` set to `1`,
14+
and all leader shards are placed on one DB-Server node. This way, whole queries
15+
can be pushed to and executed on that server, massively reducing cluster-internal
16+
communication. The Coordinator only gets back the final result.
1617

1718
Queries are always limited to a single database, and with the data of a whole
1819
database on a single node, the OneShard option allows running transactions with
1920
ACID guarantees on shard leaders.
2021

22+
Collections can have replicas by setting a `replicationFactor` greater than `1`
23+
as usual. For each replica, the follower shards are all placed on one DB-Server
24+
node when using the OneShard option. This allows for a quick failover in case
25+
the DB-Server with the leader shards fails.
26+
2127
A OneShard setup is highly recommended for most graph use cases and join-heavy
2228
queries.
2329

site/content/3.12/deploy/oneshard.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@ archetype: default
1010
{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
1111

1212
The OneShard option for ArangoDB clusters restricts all collections of a
13-
database to a single shard and places them on one DB-Server node. This way,
14-
whole queries can be pushed to and executed on that server, massively reducing
15-
cluster-internal communication. The Coordinator only gets back the final result.
13+
database to a single shard so that every collection has `numberOfShards` set to `1`,
14+
and all leader shards are placed on one DB-Server node. This way, whole queries
15+
can be pushed to and executed on that server, massively reducing cluster-internal
16+
communication. The Coordinator only gets back the final result.
1617

1718
Queries are always limited to a single database, and with the data of a whole
1819
database on a single node, the OneShard option allows running transactions with
1920
ACID guarantees on shard leaders.
2021

22+
Collections can have replicas by setting a `replicationFactor` greater than `1`
23+
as usual. For each replica, the follower shards are all placed on one DB-Server
24+
node when using the OneShard option. This allows for a quick failover in case
25+
the DB-Server with the leader shards fails.
26+
2127
A OneShard setup is highly recommended for most graph use cases and join-heavy
2228
queries.
2329

0 commit comments

Comments
 (0)