1
0
Fork 0

Doc - Use proper terms for editions (esp. shardingStrategy) (#8014)

This commit is contained in:
Simran 2019-02-23 23:11:36 +01:00 committed by sleto-it
parent 9f5f2d7c92
commit 3df86129e8
9 changed files with 41 additions and 41 deletions

View File

@ -128,16 +128,16 @@ always find documents already distributed to shards using the same
initial sharding algorithm. initial sharding algorithm.
The available sharding strategies are: The available sharding strategies are:
- `community-compat`: default sharding used by ArangoDB community - `community-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Community Edition before version 3.4
- `enterprise-compat`: default sharding used by ArangoDB enterprise - `enterprise-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Enterprise Edition before version 3.4
- `enterprise-smart-edge-compat`: default sharding used by smart edge - `enterprise-smart-edge-compat`: default sharding used by smart edge
collections in ArangoDB enterprise versions before ArangoDB 3.4 collections in ArangoDB Enterprise Edition before version 3.4
- `hash`: default sharding used by ArangoDB 3.4 for new collections - `hash`: default sharding used for new collections starting from version 3.4
(excluding smart edge collections) (excluding smart edge collections)
- `enterprise-hash-smart-edge`: default sharding used by ArangoDB 3.4 - `enterprise-hash-smart-edge`: default sharding used for new
for new smart edge collections smart edge collections starting from version 3.4
If no sharding strategy is specified, the default will be `hash` for If no sharding strategy is specified, the default will be `hash` for
all collections, and `enterprise-hash-smart-edge` for all smart edge all collections, and `enterprise-hash-smart-edge` for all smart edge

View File

@ -179,16 +179,16 @@ to the [naming conventions](../NamingConventions/README.md).
initial sharding algorithm. initial sharding algorithm.
The available sharding strategies are: The available sharding strategies are:
- `community-compat`: default sharding used by ArangoDB community - `community-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Community Edition before version 3.4
- `enterprise-compat`: default sharding used by ArangoDB enterprise - `enterprise-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Enterprise Edition before version 3.4
- `enterprise-smart-edge-compat`: default sharding used by smart edge - `enterprise-smart-edge-compat`: default sharding used by smart edge
collections in ArangoDB enterprise versions before ArangoDB 3.4 collections in ArangoDB Enterprise Edition before version 3.4
- `hash`: default sharding used by ArangoDB 3.4 for new collections - `hash`: default sharding used for new collections starting from version 3.4
(excluding smart edge collections) (excluding smart edge collections)
- `enterprise-hash-smart-edge`: default sharding used by ArangoDB 3.4 - `enterprise-hash-smart-edge`: default sharding used for new
for new smart edge collections smart edge collections starting from version 3.4
If no sharding strategy is specified, the default will be `hash` for If no sharding strategy is specified, the default will be `hash` for
all collections, and `enterprise-hash-smart-edge` for all smart edge all collections, and `enterprise-hash-smart-edge` for all smart edge

View File

@ -23,7 +23,7 @@ If you are running a single ArangoDB instance in single-server mode, there are n
of your data. All you need is at least one vertex collection and one edge collection. Note that the performance may be of your data. All you need is at least one vertex collection and one edge collection. Note that the performance may be
better, if the number of your shards / collections matches the number of CPU cores. better, if the number of your shards / collections matches the number of CPU cores.
When you use ArangoDB Community edition in cluster mode, you might need to model your collections in a certain way to When you use ArangoDB Community Edition in cluster mode, you might need to model your collections in a certain way to
ensure correct results. For more information see the next section. ensure correct results. For more information see the next section.
### Requirements for Collections in a Cluster (Non Smart Graph) ### Requirements for Collections in a Cluster (Non Smart Graph)

View File

@ -8,7 +8,7 @@ here.
SmartGraphs SmartGraphs
----------- -----------
ArangoDB 3.1 adds a first major enterprise only feature called SmartGraphs. ArangoDB 3.1 adds a first major Enterprise Edition feature called SmartGraphs.
SmartGraphs form an addition to the already existing graph features and allow to SmartGraphs form an addition to the already existing graph features and allow to
scale graphs beyond a single machine while keeping almost the same query performance. scale graphs beyond a single machine while keeping almost the same query performance.
The SmartGraph feature is suggested for all graph database use cases that require The SmartGraph feature is suggested for all graph database use cases that require
@ -19,7 +19,7 @@ sharded and you want to keep all of them in the same environment.
Or you simply use the cluster for high-availability. Or you simply use the cluster for high-availability.
In all the above cases SmartGraphs will significantly increase the performance of In all the above cases SmartGraphs will significantly increase the performance of
graph operations. graph operations.
For more detailed information read [this manual section](../Graphs/SmartGraphs/index.html). For more detailed information read the [SmartGraphs section](../Graphs/SmartGraphs/index.html).
Data format Data format
----------- -----------

View File

@ -349,7 +349,7 @@ Client tools
Authentication Authentication
-------------- --------------
* added [LDAP](../Programs/Arangod/Ldap.md) authentication (Enterprise only) * added [LDAP](../Programs/Arangod/Ldap.md) authentication (Enterprise Edition only)
Authorization Authorization

View File

@ -343,16 +343,16 @@ The following APIs have been added or augmented:
sharding algorithm. sharding algorithm.
The available sharding strategies are: The available sharding strategies are:
- `community-compat`: default sharding used by ArangoDB community - `community-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Community Edition before version 3.4
- `enterprise-compat`: default sharding used by ArangoDB enterprise - `enterprise-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Enterprise Edition before version 3.4
- `enterprise-smart-edge-compat`: default sharding used by smart edge - `enterprise-smart-edge-compat`: default sharding used by smart edge
collections in ArangoDB enterprise versions before ArangoDB 3.4 collections in ArangoDB Enterprise Edition before version 3.4
- `hash`: default sharding used by ArangoDB 3.4 for new collections - `hash`: default sharding used for new collections starting from version 3.4
(excluding smart edge collections) (excluding smart edge collections)
- `enterprise-hash-smart-edge`: default sharding used by ArangoDB 3.4 - `enterprise-hash-smart-edge`: default sharding used for new
for new smart edge collections smart edge collections starting from version 3.4
If no sharding strategy is specified, the default will be `hash` for If no sharding strategy is specified, the default will be `hash` for
all collections, and `enterprise-hash-smart-edge` for all smart edge all collections, and `enterprise-hash-smart-edge` for all smart edge

View File

@ -151,16 +151,16 @@ always find documents already distributed to shards using the same
initial sharding algorithm. initial sharding algorithm.
The available sharding strategies are: The available sharding strategies are:
- *community-compat*: default sharding used by ArangoDB community - `community-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Community Edition before version 3.4
- *enterprise-compat*: default sharding used by ArangoDB enterprise - `enterprise-compat`: default sharding used by ArangoDB
versions before ArangoDB 3.4 Enterprise Edition before version 3.4
- *enterprise-smart-edge-compat*: default sharding used by smart edge - `enterprise-smart-edge-compat`: default sharding used by smart edge
collections in ArangoDB enterprise versions before ArangoDB 3.4 collections in ArangoDB Enterprise Edition before version 3.4
- *hash*: default sharding used by ArangoDB 3.4 for new collections - `hash`: default sharding used for new collections starting from version 3.4
(excluding smart edge collections) (excluding smart edge collections)
- *enterprise-hash-smart-edge*: default sharding used by ArangoDB 3.4 - `enterprise-hash-smart-edge`: default sharding used for new
for new smart edge collections smart edge collections starting from version 3.4
If no sharding strategy is specified, the default will be *hash* for If no sharding strategy is specified, the default will be *hash* for
all collections, and *enterprise-hash-smart-edge* for all smart edge all collections, and *enterprise-hash-smart-edge* for all smart edge

View File

@ -26,10 +26,10 @@ concurrent modifications to this graph.
The replication factor used for every new collection in the graph. The replication factor used for every new collection in the graph.
@RESTSTRUCT{isSmart,graph_representation,boolean,required,} @RESTSTRUCT{isSmart,graph_representation,boolean,required,}
Flag if the graph is a SmartGraph (Enterprise only) or not. Flag if the graph is a SmartGraph (Enterprise Edition only) or not.
@RESTSTRUCT{smartGraphAttribute,graph_representation,string,optional,} @RESTSTRUCT{smartGraphAttribute,graph_representation,string,optional,}
The name of the sharding attribute in smart graph case (Enterprise Only) The name of the sharding attribute in smart graph case (Enterprise Edition only)
@RESTSTRUCT{_id,vertex_representation,string,required,} @RESTSTRUCT{_id,vertex_representation,string,required,}
The _id value of the stored data. The _id value of the stored data.

View File

@ -52,10 +52,10 @@ concurrent modifications to this graph.
The replication factor used for every new collection in the graph. The replication factor used for every new collection in the graph.
@RESTSTRUCT{isSmart,graph_representation,boolean,required,} @RESTSTRUCT{isSmart,graph_representation,boolean,required,}
Flag if the graph is a SmartGraph (Enterprise only) or not. Flag if the graph is a SmartGraph (Enterprise Edition only) or not.
@RESTSTRUCT{smartGraphAttribute,graph_representation,string,optional,} @RESTSTRUCT{smartGraphAttribute,graph_representation,string,optional,}
The name of the sharding attribute in smart graph case (Enterprise Only) The name of the sharding attribute in smart graph case (Enterprise Edition only)
@EXAMPLES @EXAMPLES