diff --git a/site/content/3.12/about-arangodb/features/_index.md b/site/content/3.12/about-arangodb/features/_index.md index 0b73cf8e80..7dd480e943 100644 --- a/site/content/3.12/about-arangodb/features/_index.md +++ b/site/content/3.12/about-arangodb/features/_index.md @@ -8,14 +8,27 @@ description: >- aliases: - ../introduction/features --- +## Feature overview + +- One database core for all graph, document, key-value, search, and vector needs +- A single composable query language for all data models +- Cluster deployments for high availability and resilience, with a multi-tenant + deployment option for the transactional guarantees and performance of a single server +- Performance options to smartly shard and replicate graphs and datasets for + optimal data locality +- Enhanced data security with on-disk and backup encryption, key rotation, + audit logging, and incremental backups without downtime + +See the full [Feature list of the ArangoDB core database system](core.md). + ## On-premises versus Cloud ### Fully managed cloud service The fully managed multi-cloud [ArangoGraph Insights Platform](https://dashboard.arangodb.cloud/home?utm_source=docs&utm_medium=cluster_pages&utm_campaign=docs_traffic) -is the easiest and fastest way to get started. It runs the Enterprise Edition -of ArangoDB, lets you deploy clusters with just a few clicks, and is operated +is the easiest and fastest way to get started. +It lets you deploy clusters with just a few clicks, and is operated by a dedicated team of ArangoDB engineers day and night. You can choose from a variety of support plans to meet your needs. @@ -63,28 +76,28 @@ Kubernetes cluster. ## ArangoDB Editions -### Community Edition +Up to version 3.12.4, the Community Edition of ArangoDB didn't include +certain query, performance, compliance, and security features. They used to +be exclusive to the Enterprise Edition. -ArangoDB is available in a **Community Edition** governed by the -[ArangoDB Community License](https://arangodb.com/community-license/). +From version 3.12.5 onward, the **Community Edition** includes all +Enterprise Edition features without time restrictions. It is governed by the +[ArangoDB Community License](https://arangodb.com/community-license). You can download the extensively tested prepackaged binaries and official Docker images for free. - -- One database core for all graph, document, key-value, and search needs -- A single composable query language for all data models -- Extensible through microservices with custom REST APIs and user-definable - query functions -- Cluster deployments for high availability and resilience - -See all [Community Edition Features](community-edition.md). - -The Community Edition is a fully-featured version without time -restrictions and includes cluster support. It is limited to a 100 GB on dataset -size in production and you cannot use it for any commercial purposes, only -internal business purposes. - -The source code of the Community Edition is available under the -[Business Source License 1.1 (BUSL-1.1)](https://github.com/arangodb/arangodb/blob/devel/LICENSE). +The use for commercial purposes and distribution is prohibited for production, +but development and testing is allowed without a license even for commercial use. +The dataset size is limited to a 100 GB. If you exceed the size limit, you get +warnings for two days and can bring the deployment back below 100 GB. If you don't, +then the deployment enters read-only mode for two days and then shuts down. + +The **Enterprise Edition** is an ArangoDB deployment with an activated license. +It allows you to use ArangoDB for commercial purposes and removes the 100 GB +dataset size limit of the Community Edition. + +The source code of ArangoDB is available under the +[Business Source License 1.1 (BUSL-1.1)](https://github.com/arangodb/arangodb/blob/devel/LICENSE), +excluding the source code of the formerly exclusive Enterprise Edition features. Copying, modification, redistribution, non-commercial use, and commercial use in a non-production context are always allowed. Additionally, you can deploy BUSL-licensed ArangoDB source code for any purpose (including production) as @@ -92,45 +105,3 @@ long as you are not creating a commercial derivative work or offering, or are including it in a commercial product, application, or service. On the fourth anniversary of the first publicly available distribution of a specific version, the license changes to the permissive Apache 2.0 open-source license. - -### Enterprise Edition - -ArangoDB is also available in a commercial version, called the -**Enterprise Edition**. It includes additional features for performance and -security, such as for scaling graphs and managing your data safely. - -- Includes all Community Edition features -- Performance options to smartly shard and replicate graphs and datasets for - optimal data locality -- Multi-tenant deployment option for the transactional guarantees and - performance of a single server -- Enhanced data security with on-disk and backup encryption, key rotation, - and audit logging -- Incremental backups without downtime and off-site replication - -See all [Enterprise Edition Features](enterprise-edition.md). - -### Differences between the Editions - -| Community Edition | Enterprise Edition | -|-------------------|--------------------| -| ArangoDB Community License for prepackaged binaries and Docker images, BUSL-1.1 for the source code | Commercial License | -| Sharding using consistent hashing on the default or custom shard keys | In addition, **smart sharding** for improved data locality | -| Only hash-based graph sharding | **SmartGraphs** to intelligently shard large graph datasets and **EnterpriseGraphs** with an automatic sharding key selection | -| Only regular collection replication without data locality optimizations | **SatelliteCollections** to replicate collections on all cluster nodes and data locality optimizations for queries | -| No optimizations when querying sharded graphs and replicated collections together | **SmartGraphs using SatelliteCollections** to enable more local execution of graph queries | -| Only regular graph replication without local execution optimizations | **SatelliteGraphs** to execute graph traversals locally on a cluster node | -| Collections can be sharded alike but joins do not utilize co-location | **SmartJoins** for co-located joins in a cluster using identically sharded collections | -| Graph traversals without parallel execution | **Parallel execution of traversal queries** with many start vertices | -| Graph traversals always load full documents | **Traversal projections** optimize the data loading of AQL traversal queries if only a few document attributes are accessed | -| Inverted indexes and Views without support for search highlighting and nested search | **Search highlighting** for getting the substring positions of matches and **nested search** for matching arrays with all the conditions met by a single object | -| Only standard Jaccard index calculation | **Jaccard similarity approximation** with MinHash for entity resolution, such as for finding duplicate records, based on how many common elements they have |{{% comment %}} Experimental feature -| No fastText model support | Classification of text tokens and finding similar tokens using supervised **fastText word embedding models** | -{{% /comment %}} -| Only regular cluster deployments | **OneShard** deployment option to store all collections of a database on a single cluster node, to combine the performance of a single server and ACID semantics with a fault-tolerant cluster setup | -| ACID transactions for multi-document / multi-collection queries on single servers, for single document operations in clusters, and for multi-document queries in clusters for collections with a single shard | In addition, ACID transactions for multi-collection queries using the OneShard feature | -| Always read from leader shards in clusters | Optionally allow dirty reads to **read from followers** to scale reads | -| TLS key and certificate rotation | In addition, **key rotation for JWT secrets** and **server name indication** (SNI) | -| Only server logs | **Audit log** of server interactions | -| No on-disk encryption | **Encryption at Rest** with hardware-accelerated on-disk encryption and key rotation | -| Only unencrypted backups and basic data masking for backups | **Hot Backups**, **encrypted backups**, and **enhanced data masking** for backups | diff --git a/site/content/3.12/about-arangodb/features/community-edition.md b/site/content/3.12/about-arangodb/features/core.md similarity index 69% rename from site/content/3.12/about-arangodb/features/community-edition.md rename to site/content/3.12/about-arangodb/features/core.md index 9ee6ac647d..c0555e56dd 100644 --- a/site/content/3.12/about-arangodb/features/community-edition.md +++ b/site/content/3.12/about-arangodb/features/core.md @@ -1,16 +1,16 @@ --- -title: Community Edition Features -menuTitle: Community Edition +title: Feature list of the ArangoDB core database system +menuTitle: Core Database weight: 5 description: >- - The community variant of ArangoDB offers an extensive feature set including - cluster support for free + All features of the ArangoDB database system, available in both the + Community Edition and Enterprise Edition aliases: - ../../introduction/features/community-edition + - ../../introduction/features/enterprise-edition + - community-edition + - enterprise-edition --- -The Community Edition features are outlined below. For additional information, -see [arangodb.com/community-server/](https://www.arangodb.com/community-server/). - ## General - [**Graph Database**](../../concepts/data-models.md#graph-model): @@ -23,9 +23,13 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) and evolve the data model easily. Documents can be organized in collections, and collections in databases for multi-tenancy. -{{% comment %}} - TODO: Add a bullet point for multi-model? (unified query language, lower TCO, ...) -{{% /comment %}} +- **Native Multi-model**: + The capabilities of a graph database, a document database, a key-value store + in one C++ core with a unified query language for a lower TCO (total cost of + ownership). Easily change the data access strategy or even combine all + supported data models in a single query. Add full-text search with ranking on + top and mix it with graph traversals, geo queries, aggregations, or any other + supported access pattern. - [**Data Format**](../../concepts/data-structure/_index.md#documents): JSON, internally stored in a binary format invented by ArangoDB called @@ -154,6 +158,23 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) machine learning models. {{% /comment %}} +- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md): + Get the substring positions of matched terms, phrases, or _n_-grams. + +- [**Nested search**](../../index-and-search/arangosearch/nested-search.md): + Match arrays of objects with all the conditions met by a single sub-object, + and define for how many of the elements this must be true. + +{{% comment %}} Experimental feature +- **[`classification`](../../index-and-search/analyzers.md#classification) and [`nearest_neighbors` Analyzers](../../index-and-search/analyzers.md#nearest_neighbors)**: + Classification of text tokens and finding similar tokens using supervised + fastText word embedding models. +{{% /comment %}} + +- [**Skip inaccessible collections**](../../aql/how-to-invoke-aql/with-arangosh.md#skipinaccessiblecollections): + Let AQL queries like graph traversals pretend that collections are empty if + the user has no access to them instead of failing the query. + ## Transactions - [**AQL Queries**](../../aql/data-queries.md#transactional-execution): @@ -182,10 +203,69 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) Using cluster deployments, single-document operations are fully ACID, too. Multi-document queries in a cluster are not ACID, except for collections with a single shard. Multi-collection queries require the OneShard - feature of the Enterprise Edition to be ACID. + feature to be ACID. ## Performance +- [**SmartGraphs**](../../graphs/smartgraphs/_index.md): + Value-based sharding of large graph datasets for better data locality when + traversing graphs. + +- [**EnterpriseGraphs**](../../graphs/enterprisegraphs/_index.md): + A specialized version of SmartGraphs, with an automatic sharding key selection. + +- [**SmartGraphs using SatelliteCollections**](../../graphs/smartgraphs/_index.md): + Collections replicated on all cluster nodes can be combined with graphs + sharded by document attributes to enable more local execution of graph queries. + +- [**SatelliteGraphs**](../../graphs/satellitegraphs/_index.md): + Graphs replicated on all cluster nodes to execute graph traversals locally. + +- [**SatelliteCollections**](../../develop/satellitecollections.md): + Collections replicated on all cluster nodes to execute joins with sharded + data locally. + +- [**SmartJoins**](../../develop/smartjoins.md): + Co-located joins in a cluster using identically sharded collections. + +- [**OneShard**](../../deploy/oneshard.md): + Option to store all collections of a database on a single cluster node, to + combine the performance of a single server and ACID semantics with a + fault-tolerant cluster setup. + +- [**Traversal**](../../release-notes/version-3.7/whats-new-in-3-7.md#traversal-parallelization-enterprise-edition) + [**Parallelization**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallelism-for-sharded-graphs-enterprise-edition): + Parallel execution of traversal queries with many start vertices, leading to + faster results. + +- [**Traversal Projections**](../../release-notes/version-3.10/whats-new-in-3-10.md#traversal-projections-enterprise-edition): + Optimized data loading for AQL traversal queries if only a few document + attributes are accessed. + +- [**Parallel index creation**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallel-index-creation-enterprise-edition): + Non-unique indexes can be created with multiple threads in parallel. + +- [**`minhash` Analyzer**](../../index-and-search/analyzers.md#minhash): + Jaccard similarity approximation for entity resolution, such as for finding + duplicate records, based on how many elements they have in common + +- [**`geo_s2` Analyzer**](../../index-and-search/analyzers.md#geo_s2): + Efficiently index geo-spatial data using different binary formats, tuning the + size on disk, the precision, and query performance. + +- [**ArangoSearch column cache**](../../release-notes/version-3.10/whats-new-in-3-10.md#arangosearch-column-cache-enterprise-edition): + Always cache field normalization values, Geo Analyzer auxiliary data, + stored values, primary sort columns, and primary key columns in memory to + improve the performance of Views and inverted indexes. + +- [**ArangoSearch WAND optimization**](../../index-and-search/arangosearch/performance.md#wand-optimization): + Retrieve search results for the highest-ranking matches from Views faster by + defining a list of sort expressions to optimize. + +- [**Read from followers in clusters**](../../develop/http-api/documents.md#read-from-followers): + Allow dirty reads so that Coordinators can read from any shard replica and not + only from the leader, for scaling reads. + - [**Persistent Indexes**](../../index-and-search/indexing/basics.md#persistent-index): Indexes are stored on disk to enable fast server restarts. You can create secondary indexes over one or multiple fields, optionally with a uniqueness @@ -247,6 +327,27 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) ## Security +- [**Auditing**](../../operations/security/audit-logging.md): + Audit logs of all server interactions. + +- [**Encryption at Rest**](../../operations/security/encryption-at-rest.md): + Hardware-accelerated on-disk encryption for your data. + +- [**Encrypted Backups**](../../components/tools/arangodump/examples.md#encryption): + Data dumps can be encrypted using a strong 256-bit AES block cipher. + +- [**Hot Backups**](../../operations/backup-and-restore.md#hot-backups): + Consistent, incremental data backups without downtime for single servers and clusters. + +- [**Enhanced Data Masking**](../../components/tools/arangodump/maskings.md#masking-functions): + Extended data masking capabilities for attributes containing sensitive data + / PII when creating backups. + +- **Advanced Encryption and Security Configuration**: + Key rotation for [JWT secrets](../../develop/http-api/authentication.md#hot-reload-jwt-secrets) + and [on-disk encryption](../../develop/http-api/security.md#encryption-at-rest), + as well as [Server Name Indication (SNI)](../../components/arangodb-server/options.md#--sslserver-name-indication). + - [**Authentication**](../../operations/administration/user-management/_index.md): Built-in user management with password- and token-based authentication. diff --git a/site/content/3.12/about-arangodb/features/enterprise-edition.md b/site/content/3.12/about-arangodb/features/enterprise-edition.md deleted file mode 100644 index bab5fdba41..0000000000 --- a/site/content/3.12/about-arangodb/features/enterprise-edition.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: Enterprise Edition Features -menuTitle: Enterprise Edition -weight: 10 -description: >- - The commercial version of ArangoDB offers performance, compliance, and - security features for larger or more sensitive datasets, as well as additional - query capabilities -aliases: - - ../../introduction/features/enterprise-edition ---- -The Enterprise Edition has all the features of the -[Community Edition](community-edition.md) and, on top of that, the -features outlined below. For additional information, see -[arangodb.com/enterprise-server/](https://www.arangodb.com/enterprise-server/). - -## Performance - -- [**SmartGraphs**](../../graphs/smartgraphs/_index.md): - Value-based sharding of large graph datasets for better data locality when - traversing graphs. - -- [**EnterpriseGraphs**](../../graphs/enterprisegraphs/_index.md): - A specialized version of SmartGraphs, with an automatic sharding key selection. - -- [**SmartGraphs using SatelliteCollections**](../../graphs/smartgraphs/_index.md): - Collections replicated on all cluster nodes can be combined with graphs - sharded by document attributes to enable more local execution of graph queries. - -- [**SatelliteGraphs**](../../graphs/satellitegraphs/_index.md): - Graphs replicated on all cluster nodes to execute graph traversals locally. - -- [**SatelliteCollections**](../../develop/satellitecollections.md): - Collections replicated on all cluster nodes to execute joins with sharded - data locally. - -- [**SmartJoins**](../../develop/smartjoins.md): - Co-located joins in a cluster using identically sharded collections. - -- [**OneShard**](../../deploy/oneshard.md): - Option to store all collections of a database on a single cluster node, to - combine the performance of a single server and ACID semantics with a - fault-tolerant cluster setup. - -- [**Traversal**](../../release-notes/version-3.7/whats-new-in-3-7.md#traversal-parallelization-enterprise-edition) - [**Parallelization**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallelism-for-sharded-graphs-enterprise-edition): - Parallel execution of traversal queries with many start vertices, leading to - faster results. - -- [**Traversal Projections**](../../release-notes/version-3.10/whats-new-in-3-10.md#traversal-projections-enterprise-edition): - Optimized data loading for AQL traversal queries if only a few document - attributes are accessed. - -- [**Parallel index creation**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallel-index-creation-enterprise-edition): - Non-unique indexes can be created with multiple threads in parallel. - -- [**`minhash` Analyzer**](../../index-and-search/analyzers.md#minhash): - Jaccard similarity approximation for entity resolution, such as for finding - duplicate records, based on how many elements they have in common - -- [**`geo_s2` Analyzer**](../../index-and-search/analyzers.md#geo_s2): - Efficiently index geo-spatial data using different binary formats, tuning the - size on disk, the precision, and query performance. - -- [**ArangoSearch column cache**](../../release-notes/version-3.10/whats-new-in-3-10.md#arangosearch-column-cache-enterprise-edition): - Always cache field normalization values, Geo Analyzer auxiliary data, - stored values, primary sort columns, and primary key columns in memory to - improve the performance of Views and inverted indexes. - -- [**ArangoSearch WAND optimization**](../../index-and-search/arangosearch/performance.md#wand-optimization): - Retrieve search results for the highest-ranking matches from Views faster by - defining a list of sort expressions to optimize. - -- [**Read from followers in clusters**](../../develop/http-api/documents.md#read-from-followers): - Allow dirty reads so that Coordinators can read from any shard replica and not - only from the leader, for scaling reads. - -## Querying - -- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md): - Get the substring positions of matched terms, phrases, or _n_-grams. - -- [**Nested search**](../../index-and-search/arangosearch/nested-search.md): - Match arrays of objects with all the conditions met by a single sub-object, - and define for how many of the elements this must be true. - -{{% comment %}} Experimental feature -- **[`classification`](../../index-and-search/analyzers.md#classification) and [`nearest_neighbors` Analyzers](../../index-and-search/analyzers.md#nearest_neighbors)**: - Classification of text tokens and finding similar tokens using supervised - fastText word embedding models. -{{% /comment %}} - -- [**Skip inaccessible collections**](../../aql/how-to-invoke-aql/with-arangosh.md#skipinaccessiblecollections): - Let AQL queries like graph traversals pretend that collections are empty if - the user has no access to them instead of failing the query. - -## Security - -- [**Auditing**](../../operations/security/audit-logging.md): - Audit logs of all server interactions. - -- [**Encryption at Rest**](../../operations/security/encryption-at-rest.md): - Hardware-accelerated on-disk encryption for your data. - -- [**Encrypted Backups**](../../components/tools/arangodump/examples.md#encryption): - Data dumps can be encrypted using a strong 256-bit AES block cipher. - -- [**Hot Backups**](../../operations/backup-and-restore.md#hot-backups): - Consistent, incremental data backups without downtime for single servers and clusters. - -- [**Enhanced Data Masking**](../../components/tools/arangodump/maskings.md#masking-functions): - Extended data masking capabilities for attributes containing sensitive data - / PII when creating backups. - -- **Advanced Encryption and Security Configuration**: - Key rotation for [JWT secrets](../../develop/http-api/authentication.md#hot-reload-jwt-secrets) - and [on-disk encryption](../../develop/http-api/security.md#encryption-at-rest), - as well as [Server Name Indication (SNI)](../../components/arangodb-server/options.md#--sslserver-name-indication). diff --git a/site/content/3.12/about-arangodb/features/highlights-by-version.md b/site/content/3.12/about-arangodb/features/highlights-by-version.md index 51e5a3579e..8b691f5681 100644 --- a/site/content/3.12/about-arangodb/features/highlights-by-version.md +++ b/site/content/3.12/about-arangodb/features/highlights-by-version.md @@ -3,13 +3,18 @@ title: Highlights by Version menuTitle: Highlights by Version weight: 15 description: >- - The most notable features in the Community and Enterprise Edition of ArangoDB, - grouped by version + The most notable features of the ArangoDB core database system, grouped by version aliases: - ../../introduction/features/highlights-by-version --- ## Version 3.12 +{{< info >}} +From version 3.12.5 onward, the prepackaged binaries and official Docker images +of the Community Edition include all features of the Enterprise Edition. +See [ArangoDB Editions](_index.md#arangodb-editions) for details. +{{< /info >}} + **All Editions** - [**Improved memory accounting**](../../release-notes/version-3.12/whats-new-in-3-12.md#improved-memory-accounting-and-usage): diff --git a/site/content/3.12/aql/functions/arangosearch.md b/site/content/3.12/aql/functions/arangosearch.md index a313c1a4d7..f5ced9f064 100644 --- a/site/content/3.12/aql/functions/arangosearch.md +++ b/site/content/3.12/aql/functions/arangosearch.md @@ -286,7 +286,7 @@ FOR doc IN viewName Match documents where the attribute at `path` is present _and_ is indexed as a nested field for [nested search with Views](../../index-and-search/arangosearch/nested-search.md) -or [inverted indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition). +or [inverted indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search). - **path** (attribute path expression): the attribute to test in the document - **type** (string): string literal `"nested"` @@ -453,6 +453,10 @@ FOR doc IN viewName Match documents with an approximate Jaccard similarity of at least the `threshold`, approximated with the specified `minhash` Analyzer. +You can use the Jaccard similarity approximation with MinHash for efficient +entity resolution, such as for finding duplicate records, based on how many +common elements they have. + To only compute the MinHash signatures, see the [`MINHASH()` Miscellaneous function](miscellaneous.md#minhash). @@ -1271,8 +1275,6 @@ FOR doc IN viewName ## Search Highlighting Functions -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - ### OFFSET_INFO() `OFFSET_INFO(doc, paths) → offsetInfo` diff --git a/site/content/3.12/aql/graphs/traversals.md b/site/content/3.12/aql/graphs/traversals.md index 7d78f0cad6..384aebc902 100644 --- a/site/content/3.12/aql/graphs/traversals.md +++ b/site/content/3.12/aql/graphs/traversals.md @@ -189,8 +189,6 @@ If omitted or an empty array is specified, then there are no restrictions. #### `parallelism` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Parallelize traversal execution (number). If omitted or set to a value of `1`, the traversal execution is not parallelized. @@ -206,11 +204,15 @@ execution. #### `maxProjections` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Specifies the number of document attributes per `FOR` loop to be used as projections (number). The default value is `5`. +The AQL optimizer automatically detects which document attributes you access in +traversal queries and optimizes the data loading. This optimization is +beneficial if you have large documents but only access a few document attributes. +The `maxProjections` option lets you tune when to load individual attributes +versus the whole document. + #### `indexHint` Introduced in v3.12.1 diff --git a/site/content/3.12/aql/high-level-operations/for.md b/site/content/3.12/aql/high-level-operations/for.md index 913ccef3cb..604a6d52fd 100644 --- a/site/content/3.12/aql/high-level-operations/for.md +++ b/site/content/3.12/aql/high-level-operations/for.md @@ -218,7 +218,7 @@ there are a few corner cases where it can make sense: {{< info >}} Starting with version 3.10, `maxProjections` can be used in -[Graph Traversals](../graphs/traversals.md#working-with-named-graphs) (Enterprise Edition only). +[Graph Traversals](../graphs/traversals.md#working-with-named-graphs). {{< /info >}} ### `useCache` diff --git a/site/content/3.12/aql/high-level-operations/search.md b/site/content/3.12/aql/high-level-operations/search.md index 8f8530e38e..a8d8089a79 100644 --- a/site/content/3.12/aql/high-level-operations/search.md +++ b/site/content/3.12/aql/high-level-operations/search.md @@ -164,7 +164,7 @@ different outside of `SEARCH`, where `IN` needs to be followed by an array. You can use the [Question mark operator](../operators.md#question-mark-operator) to perform [Nested searches with ArangoSearch](../../index-and-search/arangosearch/nested-search.md) -(Enterprise Edition only): +: ```aql FOR doc IN myView @@ -176,7 +176,7 @@ It allows you to match nested objects in arrays that satisfy multiple conditions each, and optionally define how often these conditions should be fulfilled for the entire array. You need to configure the View specifically for this type of search using the `nested` property in [`arangosearch` Views](../../index-and-search/arangosearch/arangosearch-views-reference.md#link-properties) -or in the definition of [Inverted Indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition) +or in the definition of [Inverted Indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search) that you can add to [`search-alias` Views](../../index-and-search/arangosearch/search-alias-views-reference.md). ## Handling of non-indexed fields diff --git a/site/content/3.12/aql/how-to-invoke-aql/with-arangosh.md b/site/content/3.12/aql/how-to-invoke-aql/with-arangosh.md index b91699876f..1a55f5abc8 100644 --- a/site/content/3.12/aql/how-to-invoke-aql/with-arangosh.md +++ b/site/content/3.12/aql/how-to-invoke-aql/with-arangosh.md @@ -496,8 +496,6 @@ the entire query result in RAM, use a streaming query (see the #### `allowDirtyReads` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Introduced in: v3.10.0 If you set this option to `true` and execute the query against a cluster @@ -507,8 +505,6 @@ for details. #### `skipInaccessibleCollections` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Let AQL queries (especially graph traversals) treat collection to which a user has **no access** rights for as if these collections are empty. Instead of returning a *forbidden access* error, your queries execute normally. @@ -518,8 +514,6 @@ accessible results by changing the access rights of users on collections. #### `satelliteSyncWait` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Configure how long a DB-Server has time to bring the SatelliteCollections involved in the query into sync. The default value is `60.0` seconds. When the maximal time is reached, the query is stopped. diff --git a/site/content/3.12/aql/operators.md b/site/content/3.12/aql/operators.md index a8f5395ee7..d925fc226d 100644 --- a/site/content/3.12/aql/operators.md +++ b/site/content/3.12/aql/operators.md @@ -727,9 +727,9 @@ surrounding length check. The following table compares both variants: | `arr[?]` | `LENGTH(arr[*]) > 0` {.fixed} -The question mark operator can be used for nested search (Enterprise Edition only): +The question mark operator can be used for nested search: - [Nested search with ArangoSearch](../index-and-search/arangosearch/nested-search.md) using Views -- Nested search using [Inverted indexes](../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition) +- Nested search using [Inverted indexes](../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search) ### Array destructuring diff --git a/site/content/3.12/components/arangodb-server/_index.md b/site/content/3.12/components/arangodb-server/_index.md index e12ed49eca..6bceea0bcf 100644 --- a/site/content/3.12/components/arangodb-server/_index.md +++ b/site/content/3.12/components/arangodb-server/_index.md @@ -14,8 +14,7 @@ The server process serves the various client connections to the server via the TCP/HTTP protocol. It also provides a [web interface](../web-interface/_index.md). _arangod_ can run in different modes for a variety of setups like single server -and clusters. It differs between the [Community Edition](../../about-arangodb/features/community-edition.md) -and [Enterprise Edition](../../about-arangodb/features/enterprise-edition.md). +and clusters. See [Administration](../../operations/administration/_index.md) for server configuration and [Deploy](../../deploy/_index.md) for operation mode details. diff --git a/site/content/3.12/components/tools/arangobackup/_index.md b/site/content/3.12/components/tools/arangobackup/_index.md index aff5b54870..342c24c29a 100644 --- a/site/content/3.12/components/tools/arangobackup/_index.md +++ b/site/content/3.12/components/tools/arangobackup/_index.md @@ -6,12 +6,9 @@ description: >- `arangobackup` is a command-line client tool to create global hot backups of ArangoDB deployments --- -{{< tag "ArangoDB Enterprise Edition" >}} - {{< tip >}} -In the Community Edition, use [_arangodump_](../arangodump/_index.md) and -[_arangorestore_](../arangorestore/_index.md) for -[logical backups](../../../operations/backup-and-restore.md#logical-backups). +In the ArangoGraph Insights Platform, use managed +[Backups](../../../arangograph/backups.md) instead. {{< /tip >}} _arangobackup_ creates instantaneous and consistent diff --git a/site/content/3.12/components/tools/arangobackup/examples.md b/site/content/3.12/components/tools/arangobackup/examples.md index 8e31883ce8..693c625d76 100644 --- a/site/content/3.12/components/tools/arangobackup/examples.md +++ b/site/content/3.12/components/tools/arangobackup/examples.md @@ -223,7 +223,7 @@ The output will look like this: [Rclone](https://rclone.org/) is a versatile open-source remote file sync program that can deal with over 30 different remote file -IO protocols. Enterprise Editions of ArangoDB come with a bundled version +IO protocols. ArangoDB comes with a bundled version of rclone, which is distributed under the MIT license. It is used to both download and upload hot backup sets to and from local and cloud operated storage resources. diff --git a/site/content/3.12/components/tools/arangodump/examples.md b/site/content/3.12/components/tools/arangodump/examples.md index d282dc8b4e..ef5bc7de32 100644 --- a/site/content/3.12/components/tools/arangodump/examples.md +++ b/site/content/3.12/components/tools/arangodump/examples.md @@ -163,8 +163,6 @@ INFO [66c0e] {dump} Processed 2 collection(s) from 1 database(s) in 0.132990 s t ## Encryption -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - You can encrypt dumps using an encryption keyfile, which must contain exactly 32 bytes of data (required by the AES block cipher). diff --git a/site/content/3.12/components/tools/arangodump/maskings.md b/site/content/3.12/components/tools/arangodump/maskings.md index 415262ccd5..de71ffd4e4 100644 --- a/site/content/3.12/components/tools/arangodump/maskings.md +++ b/site/content/3.12/components/tools/arangodump/maskings.md @@ -470,8 +470,8 @@ processed by a single masking function, ignoring any other rules below it. ## Masking Functions -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - +- [Random String](#random-string) +- [Random](#random) - [Xify Front](#xify-front) - [Zip](#zip) - [Datetime](#datetime) @@ -481,13 +481,6 @@ processed by a single masking function, ignoring any other rules below it. - [Phone Number](#phone-number) - [Email Address](#email-address) -The masking functions: - -- [Random String](#random-string) -- [Random](#random) - -… are available in the Community Edition as well as the Enterprise Edition. - ### Random String This masking type replaces all values of attributes whose values are strings diff --git a/site/content/3.12/components/web-interface/graphs.md b/site/content/3.12/components/web-interface/graphs.md index b504bee758..68deb9265c 100644 --- a/site/content/3.12/components/web-interface/graphs.md +++ b/site/content/3.12/components/web-interface/graphs.md @@ -17,9 +17,9 @@ subsets of a graph or an entire graph. 1. In the **Graphs** section, click the first card with the label **Add Graph**. 2. Select a tab depending on which type of named graph you want to create. The **SatelliteGraph**, **SmartGraph**, and **EnterpriseGraph** tabs are - only available for cluster deployments using the Enterprise Edition. - For non-cluster deployments and in the Community Edition, only the - **Examples** and **GeneralGraph** tabs are available. + only available for cluster deployments. + For non-cluster deployments and in the Community Edition up to v3.12.4, + only the **Examples** and **GeneralGraph** tabs are available. 3. Fill in the fields of the dialog. Required fields have an asterisk (`*`) in their label. Hover over the gray circle with a white `i` in it next to a field to show the tooltip with an explanation. diff --git a/site/content/3.12/data-science/arangographml/deploy.md b/site/content/3.12/data-science/arangographml/deploy.md index 0d62cb12f6..2fa947b758 100644 --- a/site/content/3.12/data-science/arangographml/deploy.md +++ b/site/content/3.12/data-science/arangographml/deploy.md @@ -54,8 +54,6 @@ To summarize, all you need to do is: ### Self-managed ArangoGraphML -{{< tag "ArangoDB Enterprise Edition" >}} - The self-managed solution enables you to deploy and manage ArangoML within your Kubernetes cluster using the [ArangoDB Kubernetes Operator](https://github.com/arangodb/kube-arangodb). diff --git a/site/content/3.12/deploy/_index.md b/site/content/3.12/deploy/_index.md index 5a6de1a8d7..7ad9165a5b 100644 --- a/site/content/3.12/deploy/_index.md +++ b/site/content/3.12/deploy/_index.md @@ -37,8 +37,6 @@ You can deploy systems that dynamically scale up and down according to demand. ### OneShard -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - [OneShard deployments](oneshard.md) are cluster deployments but with the data of each database restricted to a single shard. This allows queries to run locally on a single DB-Server node for better performance and with transactional diff --git a/site/content/3.12/deploy/cluster/administration.md b/site/content/3.12/deploy/cluster/administration.md index b434da5304..9b59616739 100644 --- a/site/content/3.12/deploy/cluster/administration.md +++ b/site/content/3.12/deploy/cluster/administration.md @@ -180,7 +180,7 @@ The available sharding strategies are: If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph -vertex collections (the latter two require the Enterprise Edition of ArangoDB). +vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. diff --git a/site/content/3.12/deploy/cluster/deployment/using-the-arangodb-starter.md b/site/content/3.12/deploy/cluster/deployment/using-the-arangodb-starter.md index 6439552c82..09e67ac79b 100644 --- a/site/content/3.12/deploy/cluster/deployment/using-the-arangodb-starter.md +++ b/site/content/3.12/deploy/cluster/deployment/using-the-arangodb-starter.md @@ -179,9 +179,9 @@ docker run -it --name=adbN --rm -p 8528:8528 \ --docker.net-mode=default ``` -If you use the Enterprise Edition Docker image, you have to set the license key +If you have a license for the Enterprise Edition, set the license key in an environment variable by adding this option to the above `docker` command -(place `` with the actual license key): +(replace `` with the actual license key): ``` -e ARANGO_LICENSE_KEY= @@ -189,11 +189,7 @@ in an environment variable by adding this option to the above `docker` command The Starter hands the license key to the Docker containers it launches for ArangoDB. -You can get a free evaluation license key by visiting: - -[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/) - -**TLS verified Docker services** +**TLS-verified Docker services** Oftentimes, one needs to harden Docker services using client certificate and TLS verification. The Docker API allows subsequently only certified access. diff --git a/site/content/3.12/deploy/cluster/limitations.md b/site/content/3.12/deploy/cluster/limitations.md index 5fd0ebb727..fedf70c984 100644 --- a/site/content/3.12/deploy/cluster/limitations.md +++ b/site/content/3.12/deploy/cluster/limitations.md @@ -17,9 +17,8 @@ Obviously, an ArangoDB Cluster is limited by the available resources of CPU, memory, disk and network bandwidth and latency. Moreover, high numbers of databases, collections, and shards come at a cost. -An ArangoDB Enterprise Edition cluster can sustain up to a few thousand +An ArangoDB cluster can sustain up to a few thousand databases, and a database can sustain up to a thousand collections, but the total number of shards in the cluster should not go beyond 50,000 or so. Beyond these limits, certain regular cleanup and maintenance operations can take -too long for a smooth operational experience. The Community Edition comes -without guarantees regarding the database, collection, and shard count. +too long for a smooth operational experience. diff --git a/site/content/3.12/deploy/oneshard.md b/site/content/3.12/deploy/oneshard.md index cd4eed572b..cb7ed57fe7 100644 --- a/site/content/3.12/deploy/oneshard.md +++ b/site/content/3.12/deploy/oneshard.md @@ -3,11 +3,10 @@ title: OneShard cluster deployments menuTitle: OneShard weight: 20 description: >- - The OneShard feature offers a practicable solution that enables significantly - improved performance and transactional guarantees for cluster deployments + OneShard is a deployment option to store all collections of a database on a + single cluster node, to combine the performance and the transactional + guarantees of a single server with a fault-tolerant cluster setup --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - The OneShard option for ArangoDB clusters restricts all collections of a database to a single shard so that every collection has `numberOfShards` set to `1`, and all leader shards are placed on one DB-Server node. This way, whole queries @@ -59,8 +58,8 @@ resilience etc. ### How to use the OneShard feature -The OneShard feature is enabled by default if you use the ArangoDB -Enterprise Edition and if the database is sharded as `"single"`. In this case the +The OneShard feature is enabled by default +and if the database is sharded as `"single"`. In this case the optimizer rule `cluster-one-shard` is applied automatically. There are two ways to achieve this: diff --git a/site/content/3.12/deploy/production-checklist.md b/site/content/3.12/deploy/production-checklist.md index 486452b1e2..6cb59f8198 100644 --- a/site/content/3.12/deploy/production-checklist.md +++ b/site/content/3.12/deploy/production-checklist.md @@ -76,9 +76,8 @@ have been performed on your production system before you go live. - Verify your **Backup** and restore procedures are working. -- Consider enabling [Encryption at Rest](../operations/security/encryption-at-rest.md) - (Enterprise Edition only). Make sure to safely store any secret keys you - create for this. +- Consider enabling [Encryption at Rest](../operations/security/encryption-at-rest.md). + Make sure to safely store any secret keys you create for this. - Monitor the ArangoDB provided metrics (e.g. by using Prometheus/Grafana). diff --git a/site/content/3.12/deploy/single-instance-vs-cluster.md b/site/content/3.12/deploy/single-instance-vs-cluster.md index 7367bc7f8c..07611e21cf 100644 --- a/site/content/3.12/deploy/single-instance-vs-cluster.md +++ b/site/content/3.12/deploy/single-instance-vs-cluster.md @@ -125,10 +125,12 @@ problem. Using a single instance of ArangoDB, multi-document / multi-collection queries are guaranteed to be fully ACID. This is more than many other NoSQL database systems support. In cluster mode, single-document -operations are also fully ACID. Multi-document / multi-collection +operations are also fully ACID, and so are multi-document queries for +collections with a single shard. Multi-document / multi-collection queries in a cluster are not ACID, which is equally the case for -competing database systems. See [Transactions](../develop/transactions/_index.md) -for details. +competing database systems. However, ACID transactions are supported for +multi-collection queries using ArangoDB's [OneShard](oneshard.md) feature. +See [Transactions](../develop/transactions/_index.md) for details. Batch operations for multiple documents in the same collection are only fully transactional in a single instance. @@ -163,6 +165,6 @@ In a cluster, the `arangodump` utility cannot guarantee a consistent snapshot across multiple shards or even multiple collections. In a single server, `arangodump` produces a consistent snapshot. -In the Enterprise Edition, there is an additional utility -`arangobackup` and an HTTP API for [Hot Backups](../operations/backup-and-restore.md#hot-backups) +There is an additional `arangobackup` utility and an HTTP API for +[Hot Backups](../operations/backup-and-restore.md#hot-backups) to create consistent cluster snapshots. diff --git a/site/content/3.12/deploy/single-instance/using-the-arangodb-starter.md b/site/content/3.12/deploy/single-instance/using-the-arangodb-starter.md index b4057671af..b23ddff05c 100644 --- a/site/content/3.12/deploy/single-instance/using-the-arangodb-starter.md +++ b/site/content/3.12/deploy/single-instance/using-the-arangodb-starter.md @@ -49,22 +49,17 @@ docker run -it --name=adb --rm -p 8528:8528 \ --docker.net-mode=default ``` -If you use the Enterprise Edition Docker image, you have to set the license key -in an environment variable by adding this option to the above `docker` command: +If you have a license for the Enterprise Edition, set the license key +in an environment variable by adding this option to the above `docker` command +(replace `` with the actual license key): ``` - -e ARANGO_LICENSE_KEY= + -e ARANGO_LICENSE_KEY= ``` -You can get a free evaluation license key by visiting: +The Starter hands the license key to the Docker containers it launches for ArangoDB. -[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/) - -Then replace `` above with the actual license key. The start -will then hand on the license key to the Docker container it launches -for ArangoDB. - -### TLS verified Docker services +### TLS-verified Docker services Oftentimes, one needs to harden Docker services using client certificate and TLS verification. The Docker API allows subsequently only certified access. diff --git a/site/content/3.12/develop/drivers/python.md b/site/content/3.12/develop/drivers/python.md index bea8233d48..782250ba3a 100644 --- a/site/content/3.12/develop/drivers/python.md +++ b/site/content/3.12/develop/drivers/python.md @@ -83,7 +83,7 @@ db = client.db("test", username="root", password="passwd") # Create a new graph named "school". graph = db.create_graph("school") -# Create a new EnterpriseGraph [Enterprise Edition] +# Create a new EnterpriseGraph eegraph = db.create_graph( name="school", smart=True) diff --git a/site/content/3.12/develop/http-api/administration.md b/site/content/3.12/develop/http-api/administration.md index 0fe1d0e940..52fb5286b8 100644 --- a/site/content/3.12/develop/http-api/administration.md +++ b/site/content/3.12/develop/http-api/administration.md @@ -801,9 +801,8 @@ paths: that is not ready for production yet - `obsolete` (boolean): Whether the option has been deprecated and no effect anymore - - `enterpriseOnly` (boolean): Whether the option is only available in - the Enterprise Edition. The Community Edition does have most of the - Enterprise Edition startup options and they are thus not reported + - `enterpriseOnly` (boolean): Whether the option is implemented in + the non-public enterprise code. - `requiresValue` (boolean): Whether the option can be specified without a value to enable it - `os` (array of strings): The operating systems the startup option @@ -981,7 +980,7 @@ paths: license: description: | The encrypted license key in Base64 encoding, or `"none"` - in the Community Edition. + for the Community Edition. type: string example: V0h/W...wEDw== hash: @@ -1134,7 +1133,7 @@ paths: type: string '501': description: | - If you try to apply a license in the Community Edition. + If you try to apply a license using a custom build of the public source code. content: application/json: schema: diff --git a/site/content/3.12/develop/http-api/authentication.md b/site/content/3.12/develop/http-api/authentication.md index 4b5fa15c36..019ba19e00 100644 --- a/site/content/3.12/develop/http-api/authentication.md +++ b/site/content/3.12/develop/http-api/authentication.md @@ -272,7 +272,10 @@ curl -v -H "Authorization: bearer $(jwtgen -s -e 3600 -a "HS256" -c ## Hot-reload JWT secrets -{{< tag "ArangoDB Enterprise Edition" >}} +{{< tip >}} +In the ArangoGraph Insights Platform, authentication secrets are managed and +therefore this feature isn't available. +{{< /tip >}} To reload the JWT secrets of a local arangod process without a restart, you may use the following RESTful API. A `POST` request reloads the secret, a diff --git a/site/content/3.12/develop/http-api/collections.md b/site/content/3.12/develop/http-api/collections.md index 369c836fbd..163849bf28 100644 --- a/site/content/3.12/develop/http-api/collections.md +++ b/site/content/3.12/develop/http-api/collections.md @@ -518,7 +518,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -556,25 +556,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -967,7 +967,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -1005,25 +1005,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -1447,7 +1447,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -1485,25 +1485,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -2271,7 +2271,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -2309,25 +2309,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -2957,8 +2957,7 @@ paths: of each shard are kept on different DB-Servers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. For SatelliteCollections, it needs to be the string `"satellite"`, - which matches the replication factor to the number of DB-Servers - (Enterprise Edition only). + which matches the replication factor to the number of DB-Servers. Any two copies reside on different DB-Servers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated @@ -3011,7 +3010,7 @@ paths: If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph - vertex collections (the latter two require the *Enterprise Edition* of ArangoDB). + vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. type: string @@ -3021,8 +3020,7 @@ paths: collection copies the `replicationFactor`, `numberOfShards` and `shardingStrategy` properties from the specified collection (referred to as the _prototype collection_) and distributes the shards of this collection in the same way as the shards of - the other collection. In an Enterprise Edition cluster, this data co-location is - utilized to optimize queries. + the other collection. This data co-location is utilized to optimize queries. You need to use the same number of `shardKeys` as the prototype collection, but you can use different attributes. @@ -3038,13 +3036,13 @@ paths: default: "" isSmart: description: | - Whether the collection is for a SmartGraph or EnterpriseGraph - (Enterprise Edition only). This is an internal property. + Whether the collection is for a SmartGraph or EnterpriseGraph. + This is an internal property. type: boolean isDisjoint: description: | - Whether the collection is for a Disjoint SmartGraph - (Enterprise Edition only). This is an internal property. + Whether the collection is for a Disjoint SmartGraph. + This is an internal property. type: boolean smartGraphAttribute: description: | @@ -3052,18 +3050,16 @@ paths: this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - - This feature can only be used in the *Enterprise Edition*. type: string smartJoinAttribute: description: | - In an *Enterprise Edition* cluster, this attribute determines an attribute + In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. Additionally, the shard key for a document in this collection must contain the value of this attribute, followed by a colon, followed by the actual primary key of the document. - This feature can only be used in the *Enterprise Edition* and requires the + This feature requires the `distributeShardsLike` attribute of the collection to be set to the name of another collection. It also requires the `shardKeys` attribute of the collection to be set to a single shard key attribute, with an additional ':' @@ -3284,7 +3280,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -3322,25 +3318,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -4005,8 +4001,7 @@ paths: of each shard are kept on different DB-Servers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. For SatelliteCollections, it needs to be the string `"satellite"`, - which matches the replication factor to the number of DB-Servers - (Enterprise Edition only). + which matches the replication factor to the number of DB-Servers. Any two copies reside on different DB-Servers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated @@ -4244,7 +4239,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -4282,25 +4277,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -4843,7 +4838,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -4881,25 +4876,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | diff --git a/site/content/3.12/develop/http-api/databases.md b/site/content/3.12/develop/http-api/databases.md index d12e72f7af..8803fb9ca1 100644 --- a/site/content/3.12/develop/http-api/databases.md +++ b/site/content/3.12/develop/http-api/databases.md @@ -248,7 +248,7 @@ paths: description: | Default replication factor for new collections created in this database. Special values include "satellite", which will replicate the collection to - every DB-Server (Enterprise Edition only), and 1, which disables replication. + every DB-Server, and 1, which disables replication. _(cluster only)_ type: integer writeConcern: diff --git a/site/content/3.12/develop/http-api/documents.md b/site/content/3.12/develop/http-api/documents.md index 715760330b..59f80e2b47 100644 --- a/site/content/3.12/develop/http-api/documents.md +++ b/site/content/3.12/develop/http-api/documents.md @@ -3072,8 +3072,6 @@ db._drop(cn); ## Read from followers -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Introduced in: v3.10.0 In an ArangoDB cluster, all reads and writes are performed via diff --git a/site/content/3.12/develop/http-api/graphs/named-graphs.md b/site/content/3.12/develop/http-api/graphs/named-graphs.md index 9523741871..a6876a3c7d 100644 --- a/site/content/3.12/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.12/develop/http-api/graphs/named-graphs.md @@ -148,7 +148,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -163,19 +163,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean tags: - Graphs @@ -280,12 +280,11 @@ paths: type: string isSmart: description: | - Define if the created graph should be smart (Enterprise Edition only). + Define if the created graph should be smart. type: boolean isDisjoint: description: | - Whether to create a Disjoint SmartGraph instead of a regular SmartGraph - (Enterprise Edition only). + Whether to create a Disjoint SmartGraph instead of a regular SmartGraph. type: boolean options: description: | @@ -295,7 +294,8 @@ paths: properties: smartGraphAttribute: description: | - Only has effect in Enterprise Edition and it is required if isSmart is true. + Required if `isSmart` is true. + The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this SmartGraph has to have this attribute. Cannot be modified later. @@ -303,7 +303,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -318,8 +318,7 @@ paths: description: | The replication factor used when initially creating collections for this graph. Can be set to `"satellite"` to create a SatelliteGraph, which then ignores - `numberOfShards`, `minReplicationFactor`, and `writeConcern` - (Enterprise Edition only). + `numberOfShards`, `minReplicationFactor`, and `writeConcern`. type: integer writeConcern: description: | @@ -434,7 +433,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -449,19 +448,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -561,7 +560,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -576,19 +575,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -730,7 +729,6 @@ graph._drop("myGraph", true); description: |- Create a SmartGraph. This graph uses 9 shards and is sharded by the "region" attribute. - Available in the Enterprise Edition only. name: HttpGharialCreateSmart --- var graph = require("@arangodb/general-graph"); @@ -768,7 +766,6 @@ graph._drop("smartGraph", true); description: |- Create a disjoint SmartGraph. This graph uses 9 shards and is sharded by the "region" attribute. - Available in the Enterprise Edition only. Note that as you are using a disjoint version, you can only create edges between vertices sharing the same region. name: HttpGharialCreateDisjointSmart @@ -812,7 +809,6 @@ description: |- This collection is cloned to all servers, all other vertex collections are split into 9 shards and are sharded by the "region" attribute. - Available in the Enterprise Edition only. name: HttpGharialCreateSmartWithSatellites --- var graph = require("@arangodb/general-graph"); @@ -851,7 +847,6 @@ graph._drop("smartGraph", true); description: |- Create an EnterpriseGraph. This graph uses 9 shards, it does not make use of specific sharding attributes. - Available in the Enterprise Edition only. name: HttpGharialCreateEnterprise --- var graph = require("@arangodb/general-graph"); @@ -890,7 +885,6 @@ description: |- shards, but uses "satellite" as replicationFactor. Make sure to keep this graph small as it is cloned to every server. - Available in the Enterprise Edition only. name: HttpGharialCreateSatellite --- var graph = require("@arangodb/general-graph"); @@ -1045,7 +1039,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1060,19 +1054,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '404': description: | @@ -1445,7 +1439,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -1550,7 +1544,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1565,19 +1559,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -1677,7 +1671,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1692,19 +1686,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -1972,7 +1966,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1987,19 +1981,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -2097,7 +2091,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2112,19 +2106,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -2443,7 +2437,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -2548,7 +2542,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2563,19 +2557,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -2675,7 +2669,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2690,19 +2684,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -2912,7 +2906,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -3015,7 +3009,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3030,19 +3024,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -3140,7 +3134,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3155,19 +3149,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -3440,7 +3434,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3455,19 +3449,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -3566,7 +3560,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3581,19 +3575,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '403': description: | diff --git a/site/content/3.12/develop/http-api/hot-backups.md b/site/content/3.12/develop/http-api/hot-backups.md index 4f0d4aea46..b986c32ced 100644 --- a/site/content/3.12/develop/http-api/hot-backups.md +++ b/site/content/3.12/develop/http-api/hot-backups.md @@ -6,7 +6,10 @@ description: >- The HTTP API for Hot Backups lets you manage incremental, zero-downtime data backups --- -{{< tag "ArangoDB Enterprise Edition" >}} +{{< tip >}} +In the ArangoGraph Insights Platform, use managed +[Backups](../../arangograph/backups.md) instead. +{{< /tip >}} Hot Backups are near instantaneous consistent snapshots of an **entire** ArangoDB deployment. This includes all databases, collections, diff --git a/site/content/3.12/develop/http-api/indexes/inverted.md b/site/content/3.12/develop/http-api/indexes/inverted.md index 4a1fc22261..a43033eb52 100644 --- a/site/content/3.12/develop/http-api/indexes/inverted.md +++ b/site/content/3.12/develop/http-api/indexes/inverted.md @@ -147,8 +147,6 @@ paths: Default: the value defined by the top-level `cache` option. - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -160,8 +158,6 @@ paths: `fields` property, the values get indexed in a way that lets you query for co-occurring values. For example, you can search the sub-objects and all the conditions need to be met by a single sub-object instead of across all of them. - - This property is available in the Enterprise Edition only. type: array items: type: object @@ -223,8 +219,6 @@ paths: Default: the value defined by the top-level `cache` option. - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -270,8 +264,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -333,8 +325,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -388,8 +378,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -430,8 +418,6 @@ paths: Example: `["BM25(@doc) DESC", "TFIDF(@doc, true) DESC"]` Default: `[]` - - This property is available in the Enterprise Edition only. type: array items: type: string diff --git a/site/content/3.12/develop/http-api/monitoring/logs.md b/site/content/3.12/develop/http-api/monitoring/logs.md index 95869c2fe0..252df8a106 100644 --- a/site/content/3.12/develop/http-api/monitoring/logs.md +++ b/site/content/3.12/develop/http-api/monitoring/logs.md @@ -462,44 +462,42 @@ paths: audit-authentication: description: | Controls whether events such as successful logins and - missing or wrong credentials are written to the audit log - (_Enterprise Edition only_). + missing or wrong credentials are written to the audit log. type: string audit-authorization: description: | Controls whether events such as users trying to access databases - without the necessary permissions are written to the audit log - (_Enterprise Edition only_). + without the necessary permissions are written to the audit log. type: string audit-collection: description: | Controls whether events about collections creation, truncation, - and deletion are written to the audit log (_Enterprise Edition only_). + and deletion are written to the audit log. type: string audit-database: description: | Controls whether events about database creation and deletion - are written to the audit log (_Enterprise Edition only_). + are written to the audit log. type: string audit-document: description: | Controls whether document read and write events are written - to the audit log (_Enterprise Edition only_). + to the audit log. type: string audit-hotbackup: description: | Controls whether the Hot Backup creation, restore, and delete - events are written to the audit log (_Enterprise Edition only_). + events are written to the audit log. type: string audit-service: description: | Controls whether the start and stop events of the audit - service are written to the audit log (_Enterprise Edition only_). + service are written to the audit log. type: string audit-view: description: | Controls whether events about View creation and deletion - are written to the audit log (_Enterprise Edition only_). + are written to the audit log. type: string authentication: description: | @@ -512,7 +510,7 @@ paths: type: string backup: description: | - Logs events related to Hot Backup (_Enterprise Edition only_). + Logs events related to Hot Backup. type: string bench: description: | @@ -600,7 +598,7 @@ paths: license: description: | Logs events related to the license management like the - expiration of a license (_Enterprise Edition only_). + expiration of a license. type: string maintenance: description: | diff --git a/site/content/3.12/develop/http-api/queries/aql-queries.md b/site/content/3.12/develop/http-api/queries/aql-queries.md index b795b42fd3..9898ecbd40 100644 --- a/site/content/3.12/develop/http-api/queries/aql-queries.md +++ b/site/content/3.12/develop/http-api/queries/aql-queries.md @@ -583,7 +583,7 @@ paths: type: integer satelliteSyncWait: description: | - This *Enterprise Edition* parameter allows to configure how long a DB-Server has time + This parameter allows to configure how long a DB-Server has time to bring the SatelliteCollections involved in the query into sync. The default value is `60.0` seconds. When the maximal time is reached, the query is stopped. @@ -634,8 +634,6 @@ paths: with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can naturally limit the accessible results by changing the access rights of users on collections. - - This feature is only available in the Enterprise Edition. type: boolean allowDirtyReads: description: | @@ -647,8 +645,6 @@ paths: namely obsolete revisions of documents because changes have not yet been replicated to the follower, as well as changes to documents before they are officially committed on the leader. - - This feature is only available in the Enterprise Edition. type: boolean responses: '201': @@ -3471,7 +3467,7 @@ paths: type: boolean enterpriseOnly: description: | - Whether the rule is available in the Enterprise Edition only. + Whether the rule is implemented in the non-public enterprise code. type: boolean tags: - Queries diff --git a/site/content/3.12/develop/http-api/views/arangosearch-views.md b/site/content/3.12/develop/http-api/views/arangosearch-views.md index f4d331a2ee..9f6f0185bb 100644 --- a/site/content/3.12/develop/http-api/views/arangosearch-views.md +++ b/site/content/3.12/develop/http-api/views/arangosearch-views.md @@ -95,7 +95,7 @@ paths: primarySortCache: description: | If you enable this option, then the primary sort columns are always cached in - memory (Enterprise Edition only). This can improve the + memory. This can improve the performance of queries that utilize the primary sort order. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -110,7 +110,7 @@ paths: primaryKeyCache: description: | If you enable this option, then the primary key columns are always cached in - memory (introduced in v3.9.6, Enterprise Edition only). This can improve the + memory (introduced in v3.9.6). This can improve the performance of queries that return many documents. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -141,8 +141,6 @@ paths: You can define up to 64 expressions per View. Example: `["BM25(@doc) DESC", "TFIDF(@doc, true) DESC"]` - - This property is available in the Enterprise Edition only. type: array items: type: string @@ -208,7 +206,7 @@ paths: default: lz4 cache: description: | - Whether to always cache stored values in memory (Enterprise Edition only). + Whether to always cache stored values in memory. This can improve the query performance if stored values are involved. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -459,18 +457,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -502,8 +498,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -934,18 +929,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -977,8 +970,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -1519,18 +1511,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -1562,8 +1552,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -2010,18 +1999,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -2053,8 +2040,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -2380,18 +2366,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -2423,8 +2407,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | diff --git a/site/content/3.12/develop/javascript-api/@arangodb/collection-object.md b/site/content/3.12/develop/javascript-api/@arangodb/collection-object.md index 3f8992ba8c..306c1cf0b2 100644 --- a/site/content/3.12/develop/javascript-api/@arangodb/collection-object.md +++ b/site/content/3.12/develop/javascript-api/@arangodb/collection-object.md @@ -264,8 +264,7 @@ In a cluster setup, the result also contains the following attributes: - `replicationFactor` (number\|string): Determines how many copies of each shard are kept on different DB-Servers. Has to be in the range of 1-10 or the string - `"satellite"` for a SatelliteCollection (Enterprise Edition only). - _(cluster only)_ + `"satellite"` for a SatelliteCollection. _(cluster only)_ - `writeConcern` (number): Determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less then these many copies @@ -291,10 +290,10 @@ In a cluster setup, the result also contains the following attributes: the other collection. - `isSmart` (boolean): Whether the collection is used in a SmartGraph or - EnterpriseGraph (Enterprise Edition only). This is an internal property. + EnterpriseGraph. This is an internal property. - `isDisjoint` (boolean): Whether the SmartGraph this collection belongs to is - disjoint (Enterprise Edition only). This is an internal property. + disjoint. This is an internal property. - `smartGraphAttribute` (string): The attribute that is used for sharding: vertices with the same value of @@ -302,10 +301,8 @@ In a cluster setup, the result also contains the following attributes: have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - This feature can only be used in the *Enterprise Edition*. - - `smartJoinAttribute` (string): - In an *Enterprise Edition* cluster, this attribute determines an attribute + In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. @@ -321,8 +318,7 @@ one or more of the following attribute(s): - `replicationFactor` (number\|string): Change the number of shard copies kept on different DB-Servers. Valid values are integer numbers in the range of 1-10 - or the string `"satellite"` for a SatelliteCollection (Enterprise Edition only). - _(cluster only)_ + or the string `"satellite"` for a SatelliteCollection. _(cluster only)_ - `writeConcern` (number): Change how many copies of each shard are required to be in sync on the different DB-Servers. If there are less then these many copies diff --git a/site/content/3.12/develop/javascript-api/@arangodb/db-object.md b/site/content/3.12/develop/javascript-api/@arangodb/db-object.md index cc7f3130cb..458d9e8bb0 100644 --- a/site/content/3.12/develop/javascript-api/@arangodb/db-object.md +++ b/site/content/3.12/develop/javascript-api/@arangodb/db-object.md @@ -42,8 +42,7 @@ The `options` attribute can be used to set defaults for collections that will be created in the new database (_cluster only_): - `sharding`: The sharding method to use. Valid values are: `""` or `"single"`. - Setting this option to `"single"` will enable the OneShard feature in the - Enterprise Edition. + Setting this option to `"single"` enables the OneShard feature. - `replicationFactor`: Default replication factor. Special values include `"satellite"`, which will replicate the collection to every DB-Server, and `1`, which disables replication. @@ -343,8 +342,8 @@ error is thrown. For information about the naming constraints for collections, s servers holding copies take over, usually without an error being reported. - When using the *Enterprise Edition* of ArangoDB the replicationFactor - may be set to "satellite" making the collection locally joinable + The `replicationFactor` + may be set to `"satellite"`, making the collection locally joinable on every DB-Server. This reduces the number of network hops dramatically when using joins in AQL at the costs of reduced write performance on these collections. @@ -384,7 +383,7 @@ error is thrown. For information about the naming constraints for collections, s If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph - vertex collections (the latter two require the *Enterprise Edition* of ArangoDB). + vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. @@ -396,8 +395,7 @@ error is thrown. For information about the naming constraints for collections, s collection copies the `replicationFactor`, `numberOfShards` and `shardingStrategy` properties from the specified collection (referred to as the _prototype collection_) and distributes the shards of this collection in the same way as the shards of - the other collection. In an Enterprise Edition cluster, this data co-location is - utilized to optimize queries. + the other collection. IThis data co-location is utilized to optimize queries. You need to use the same number of `shardKeys` as the prototype collection, but you can use different attributes. @@ -410,10 +408,10 @@ error is thrown. For information about the naming constraints for collections, s {{< /info >}} - `isSmart` (boolean): Whether the collection is for a SmartGraph or - EnterpriseGraph (Enterprise Edition only). This is an internal property. + EnterpriseGraph. This is an internal property. -- `isDisjoint` (boolean): Whether the collection is for a Disjoint SmartGraph - (Enterprise Edition only). This is an internal property. +- `isDisjoint` (boolean): Whether the collection is for a Disjoint SmartGraph. + This is an internal property. - `smartGraphAttribute` (string, _optional_): The attribute that is used for sharding: vertices with the same value of @@ -421,15 +419,13 @@ error is thrown. For information about the naming constraints for collections, s have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - This feature can only be used in the *Enterprise Edition*. - -- `smartJoinAttribute` (string, _optional_): In an *Enterprise Edition* cluster, this attribute +- `smartJoinAttribute` (string, _optional_): In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. Additionally, the sharding key for a document in this collection must contain the value of this attribute, followed by a colon, followed by the actual primary key of the document. - This feature can only be used in the *Enterprise Edition* and requires the + This feature requires the `distributeShardsLike` attribute of the collection to be set to the name of another collection. It also requires the `shardKeys` attribute of the collection to be set to a single shard key attribute, with an additional `:` @@ -1274,7 +1270,7 @@ require("@arangodb").db._version(); Returns the current license. -See [`db._getLicense()`](../../../operations/administration/license-management.md#managing-your-license). +See [`db._getLicense()`](../../../operations/administration/license-management.md#check-the-license). ### `db._setLicense(data)` @@ -1282,4 +1278,4 @@ See [`db._getLicense()`](../../../operations/administration/license-management.m Sets a license. -See [`db._setLicense(data)`](../../../operations/administration/license-management.md#initial-installation). +See [`db._setLicense(data)`](../../../operations/administration/license-management.md#apply-a-license). diff --git a/site/content/3.12/develop/operational-factors.md b/site/content/3.12/develop/operational-factors.md index b51bd8a9fb..da9ead90bb 100644 --- a/site/content/3.12/develop/operational-factors.md +++ b/site/content/3.12/develop/operational-factors.md @@ -224,9 +224,9 @@ for more information. ### SmartGraphs -SmartGraphs are an Enterprise Edition feature of ArangoDB. It enables you to -manage graphs at scale. It provides a vast performance benefit for all graphs -sharded in an ArangoDB Cluster. + +The SmartGraphs feature enables you to manage graphs at scale. +It provides a vast performance benefit for all graphs sharded in an ArangoDB Cluster. To add a SmartGraph you need a SmartGraph attribute that partitions your graph into several smaller sub-graphs. Ideally these sub-graphs follow a diff --git a/site/content/3.12/develop/satellitecollections.md b/site/content/3.12/develop/satellitecollections.md index d470d6bb2b..5aeec6ccad 100644 --- a/site/content/3.12/develop/satellitecollections.md +++ b/site/content/3.12/develop/satellitecollections.md @@ -3,10 +3,8 @@ title: SatelliteCollections menuTitle: SatelliteCollections weight: 250 description: >- - Collections synchronously replicated to all servers, available in the Enterprise Edition + Collections synchronously replicated to all servers to enable local joins --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - When doing joins in an ArangoDB cluster data has to be exchanged between different servers. Joins are executed on a Coordinator. It prepares an execution plan diff --git a/site/content/3.12/develop/smartjoins.md b/site/content/3.12/develop/smartjoins.md index fd44d18d56..e3e030aeb5 100644 --- a/site/content/3.12/develop/smartjoins.md +++ b/site/content/3.12/develop/smartjoins.md @@ -6,8 +6,6 @@ description: >- SmartJoins allow to execute co-located join operations among identically sharded collections --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - ## Cluster joins without being smart When doing joins in an ArangoDB cluster, data has to be exchanged between different servers. diff --git a/site/content/3.12/get-started/how-to-interact-with-arangodb.md b/site/content/3.12/get-started/how-to-interact-with-arangodb.md index 204aa5a9db..b12a440ac1 100644 --- a/site/content/3.12/get-started/how-to-interact-with-arangodb.md +++ b/site/content/3.12/get-started/how-to-interact-with-arangodb.md @@ -102,7 +102,6 @@ to restore structural information with or without data. you to create instantaneous and consistent [hot backups](../operations/backup-and-restore.md#hot-backups) of the data and structural information stored in ArangoDB, without interrupting the database operations. It can be used for all ArangoDB deployment modes. -It is only available in the Enterprise Edition. You can download the extensively tested prepackaged binaries and official Docker images for free. - -- One database core for all graph, document, key-value, and search needs -- A single composable query language for all data models -- Extensible through microservices with custom REST APIs and user-definable - query functions -- Cluster deployments for high availability and resilience - -See all [Community Edition Features](community-edition.md). - -The Community Edition is a fully-featured version without time -restrictions and includes cluster support. It is limited to a 100 GB on dataset -size in production and you cannot use it for any commercial purposes, only -internal business purposes. - -The source code of the Community Edition is available under the -[Business Source License 1.1 (BUSL-1.1)](https://github.com/arangodb/arangodb/blob/devel/LICENSE). +The use for commercial purposes and distribution is prohibited for production, +but development and testing is allowed without a license even for commercial use. +The dataset size is limited to a 100 GB. If you exceed the size limit, you get +warnings for two days and can bring the deployment back below 100 GB. If you don't, +then the deployment enters read-only mode for two days and then shuts down. + +The **Enterprise Edition** is an ArangoDB deployment with an activated license. +It allows you to use ArangoDB for commercial purposes and removes the 100 GB +dataset size limit of the Community Edition. + +The source code of ArangoDB is available under the +[Business Source License 1.1 (BUSL-1.1)](https://github.com/arangodb/arangodb/blob/devel/LICENSE), +excluding the source code of the formerly exclusive Enterprise Edition features. Copying, modification, redistribution, non-commercial use, and commercial use in a non-production context are always allowed. Additionally, you can deploy BUSL-licensed ArangoDB source code for any purpose (including production) as @@ -92,45 +105,3 @@ long as you are not creating a commercial derivative work or offering, or are including it in a commercial product, application, or service. On the fourth anniversary of the first publicly available distribution of a specific version, the license changes to the permissive Apache 2.0 open-source license. - -### Enterprise Edition - -ArangoDB is also available in a commercial version, called the -**Enterprise Edition**. It includes additional features for performance and -security, such as for scaling graphs and managing your data safely. - -- Includes all Community Edition features -- Performance options to smartly shard and replicate graphs and datasets for - optimal data locality -- Multi-tenant deployment option for the transactional guarantees and - performance of a single server -- Enhanced data security with on-disk and backup encryption, key rotation, - and audit logging -- Incremental backups without downtime and off-site replication - -See all [Enterprise Edition Features](enterprise-edition.md). - -### Differences between the Editions - -| Community Edition | Enterprise Edition | -|-------------------|--------------------| -| ArangoDB Community License for prepackaged binaries and Docker images, BUSL-1.1 for the source code | Commercial License | -| Sharding using consistent hashing on the default or custom shard keys | In addition, **smart sharding** for improved data locality | -| Only hash-based graph sharding | **SmartGraphs** to intelligently shard large graph datasets and **EnterpriseGraphs** with an automatic sharding key selection | -| Only regular collection replication without data locality optimizations | **SatelliteCollections** to replicate collections on all cluster nodes and data locality optimizations for queries | -| No optimizations when querying sharded graphs and replicated collections together | **SmartGraphs using SatelliteCollections** to enable more local execution of graph queries | -| Only regular graph replication without local execution optimizations | **SatelliteGraphs** to execute graph traversals locally on a cluster node | -| Collections can be sharded alike but joins do not utilize co-location | **SmartJoins** for co-located joins in a cluster using identically sharded collections | -| Graph traversals without parallel execution | **Parallel execution of traversal queries** with many start vertices | -| Graph traversals always load full documents | **Traversal projections** optimize the data loading of AQL traversal queries if only a few document attributes are accessed | -| Inverted indexes and Views without support for search highlighting and nested search | **Search highlighting** for getting the substring positions of matches and **nested search** for matching arrays with all the conditions met by a single object | -| Only standard Jaccard index calculation | **Jaccard similarity approximation** with MinHash for entity resolution, such as for finding duplicate records, based on how many common elements they have |{{% comment %}} Experimental feature -| No fastText model support | Classification of text tokens and finding similar tokens using supervised **fastText word embedding models** | -{{% /comment %}} -| Only regular cluster deployments | **OneShard** deployment option to store all collections of a database on a single cluster node, to combine the performance of a single server and ACID semantics with a fault-tolerant cluster setup | -| ACID transactions for multi-document / multi-collection queries on single servers, for single document operations in clusters, and for multi-document queries in clusters for collections with a single shard | In addition, ACID transactions for multi-collection queries using the OneShard feature | -| Always read from leader shards in clusters | Optionally allow dirty reads to **read from followers** to scale reads | -| TLS key and certificate rotation | In addition, **key rotation for JWT secrets** and **server name indication** (SNI) | -| Only server logs | **Audit log** of server interactions | -| No on-disk encryption | **Encryption at Rest** with hardware-accelerated on-disk encryption and key rotation | -| Only unencrypted backups and basic data masking for backups | **Hot Backups**, **encrypted backups**, and **enhanced data masking** for backups | diff --git a/site/content/3.13/about-arangodb/features/community-edition.md b/site/content/3.13/about-arangodb/features/core.md similarity index 69% rename from site/content/3.13/about-arangodb/features/community-edition.md rename to site/content/3.13/about-arangodb/features/core.md index 9ee6ac647d..c0555e56dd 100644 --- a/site/content/3.13/about-arangodb/features/community-edition.md +++ b/site/content/3.13/about-arangodb/features/core.md @@ -1,16 +1,16 @@ --- -title: Community Edition Features -menuTitle: Community Edition +title: Feature list of the ArangoDB core database system +menuTitle: Core Database weight: 5 description: >- - The community variant of ArangoDB offers an extensive feature set including - cluster support for free + All features of the ArangoDB database system, available in both the + Community Edition and Enterprise Edition aliases: - ../../introduction/features/community-edition + - ../../introduction/features/enterprise-edition + - community-edition + - enterprise-edition --- -The Community Edition features are outlined below. For additional information, -see [arangodb.com/community-server/](https://www.arangodb.com/community-server/). - ## General - [**Graph Database**](../../concepts/data-models.md#graph-model): @@ -23,9 +23,13 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) and evolve the data model easily. Documents can be organized in collections, and collections in databases for multi-tenancy. -{{% comment %}} - TODO: Add a bullet point for multi-model? (unified query language, lower TCO, ...) -{{% /comment %}} +- **Native Multi-model**: + The capabilities of a graph database, a document database, a key-value store + in one C++ core with a unified query language for a lower TCO (total cost of + ownership). Easily change the data access strategy or even combine all + supported data models in a single query. Add full-text search with ranking on + top and mix it with graph traversals, geo queries, aggregations, or any other + supported access pattern. - [**Data Format**](../../concepts/data-structure/_index.md#documents): JSON, internally stored in a binary format invented by ArangoDB called @@ -154,6 +158,23 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) machine learning models. {{% /comment %}} +- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md): + Get the substring positions of matched terms, phrases, or _n_-grams. + +- [**Nested search**](../../index-and-search/arangosearch/nested-search.md): + Match arrays of objects with all the conditions met by a single sub-object, + and define for how many of the elements this must be true. + +{{% comment %}} Experimental feature +- **[`classification`](../../index-and-search/analyzers.md#classification) and [`nearest_neighbors` Analyzers](../../index-and-search/analyzers.md#nearest_neighbors)**: + Classification of text tokens and finding similar tokens using supervised + fastText word embedding models. +{{% /comment %}} + +- [**Skip inaccessible collections**](../../aql/how-to-invoke-aql/with-arangosh.md#skipinaccessiblecollections): + Let AQL queries like graph traversals pretend that collections are empty if + the user has no access to them instead of failing the query. + ## Transactions - [**AQL Queries**](../../aql/data-queries.md#transactional-execution): @@ -182,10 +203,69 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) Using cluster deployments, single-document operations are fully ACID, too. Multi-document queries in a cluster are not ACID, except for collections with a single shard. Multi-collection queries require the OneShard - feature of the Enterprise Edition to be ACID. + feature to be ACID. ## Performance +- [**SmartGraphs**](../../graphs/smartgraphs/_index.md): + Value-based sharding of large graph datasets for better data locality when + traversing graphs. + +- [**EnterpriseGraphs**](../../graphs/enterprisegraphs/_index.md): + A specialized version of SmartGraphs, with an automatic sharding key selection. + +- [**SmartGraphs using SatelliteCollections**](../../graphs/smartgraphs/_index.md): + Collections replicated on all cluster nodes can be combined with graphs + sharded by document attributes to enable more local execution of graph queries. + +- [**SatelliteGraphs**](../../graphs/satellitegraphs/_index.md): + Graphs replicated on all cluster nodes to execute graph traversals locally. + +- [**SatelliteCollections**](../../develop/satellitecollections.md): + Collections replicated on all cluster nodes to execute joins with sharded + data locally. + +- [**SmartJoins**](../../develop/smartjoins.md): + Co-located joins in a cluster using identically sharded collections. + +- [**OneShard**](../../deploy/oneshard.md): + Option to store all collections of a database on a single cluster node, to + combine the performance of a single server and ACID semantics with a + fault-tolerant cluster setup. + +- [**Traversal**](../../release-notes/version-3.7/whats-new-in-3-7.md#traversal-parallelization-enterprise-edition) + [**Parallelization**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallelism-for-sharded-graphs-enterprise-edition): + Parallel execution of traversal queries with many start vertices, leading to + faster results. + +- [**Traversal Projections**](../../release-notes/version-3.10/whats-new-in-3-10.md#traversal-projections-enterprise-edition): + Optimized data loading for AQL traversal queries if only a few document + attributes are accessed. + +- [**Parallel index creation**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallel-index-creation-enterprise-edition): + Non-unique indexes can be created with multiple threads in parallel. + +- [**`minhash` Analyzer**](../../index-and-search/analyzers.md#minhash): + Jaccard similarity approximation for entity resolution, such as for finding + duplicate records, based on how many elements they have in common + +- [**`geo_s2` Analyzer**](../../index-and-search/analyzers.md#geo_s2): + Efficiently index geo-spatial data using different binary formats, tuning the + size on disk, the precision, and query performance. + +- [**ArangoSearch column cache**](../../release-notes/version-3.10/whats-new-in-3-10.md#arangosearch-column-cache-enterprise-edition): + Always cache field normalization values, Geo Analyzer auxiliary data, + stored values, primary sort columns, and primary key columns in memory to + improve the performance of Views and inverted indexes. + +- [**ArangoSearch WAND optimization**](../../index-and-search/arangosearch/performance.md#wand-optimization): + Retrieve search results for the highest-ranking matches from Views faster by + defining a list of sort expressions to optimize. + +- [**Read from followers in clusters**](../../develop/http-api/documents.md#read-from-followers): + Allow dirty reads so that Coordinators can read from any shard replica and not + only from the leader, for scaling reads. + - [**Persistent Indexes**](../../index-and-search/indexing/basics.md#persistent-index): Indexes are stored on disk to enable fast server restarts. You can create secondary indexes over one or multiple fields, optionally with a uniqueness @@ -247,6 +327,27 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/) ## Security +- [**Auditing**](../../operations/security/audit-logging.md): + Audit logs of all server interactions. + +- [**Encryption at Rest**](../../operations/security/encryption-at-rest.md): + Hardware-accelerated on-disk encryption for your data. + +- [**Encrypted Backups**](../../components/tools/arangodump/examples.md#encryption): + Data dumps can be encrypted using a strong 256-bit AES block cipher. + +- [**Hot Backups**](../../operations/backup-and-restore.md#hot-backups): + Consistent, incremental data backups without downtime for single servers and clusters. + +- [**Enhanced Data Masking**](../../components/tools/arangodump/maskings.md#masking-functions): + Extended data masking capabilities for attributes containing sensitive data + / PII when creating backups. + +- **Advanced Encryption and Security Configuration**: + Key rotation for [JWT secrets](../../develop/http-api/authentication.md#hot-reload-jwt-secrets) + and [on-disk encryption](../../develop/http-api/security.md#encryption-at-rest), + as well as [Server Name Indication (SNI)](../../components/arangodb-server/options.md#--sslserver-name-indication). + - [**Authentication**](../../operations/administration/user-management/_index.md): Built-in user management with password- and token-based authentication. diff --git a/site/content/3.13/about-arangodb/features/enterprise-edition.md b/site/content/3.13/about-arangodb/features/enterprise-edition.md deleted file mode 100644 index bab5fdba41..0000000000 --- a/site/content/3.13/about-arangodb/features/enterprise-edition.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: Enterprise Edition Features -menuTitle: Enterprise Edition -weight: 10 -description: >- - The commercial version of ArangoDB offers performance, compliance, and - security features for larger or more sensitive datasets, as well as additional - query capabilities -aliases: - - ../../introduction/features/enterprise-edition ---- -The Enterprise Edition has all the features of the -[Community Edition](community-edition.md) and, on top of that, the -features outlined below. For additional information, see -[arangodb.com/enterprise-server/](https://www.arangodb.com/enterprise-server/). - -## Performance - -- [**SmartGraphs**](../../graphs/smartgraphs/_index.md): - Value-based sharding of large graph datasets for better data locality when - traversing graphs. - -- [**EnterpriseGraphs**](../../graphs/enterprisegraphs/_index.md): - A specialized version of SmartGraphs, with an automatic sharding key selection. - -- [**SmartGraphs using SatelliteCollections**](../../graphs/smartgraphs/_index.md): - Collections replicated on all cluster nodes can be combined with graphs - sharded by document attributes to enable more local execution of graph queries. - -- [**SatelliteGraphs**](../../graphs/satellitegraphs/_index.md): - Graphs replicated on all cluster nodes to execute graph traversals locally. - -- [**SatelliteCollections**](../../develop/satellitecollections.md): - Collections replicated on all cluster nodes to execute joins with sharded - data locally. - -- [**SmartJoins**](../../develop/smartjoins.md): - Co-located joins in a cluster using identically sharded collections. - -- [**OneShard**](../../deploy/oneshard.md): - Option to store all collections of a database on a single cluster node, to - combine the performance of a single server and ACID semantics with a - fault-tolerant cluster setup. - -- [**Traversal**](../../release-notes/version-3.7/whats-new-in-3-7.md#traversal-parallelization-enterprise-edition) - [**Parallelization**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallelism-for-sharded-graphs-enterprise-edition): - Parallel execution of traversal queries with many start vertices, leading to - faster results. - -- [**Traversal Projections**](../../release-notes/version-3.10/whats-new-in-3-10.md#traversal-projections-enterprise-edition): - Optimized data loading for AQL traversal queries if only a few document - attributes are accessed. - -- [**Parallel index creation**](../../release-notes/version-3.10/whats-new-in-3-10.md#parallel-index-creation-enterprise-edition): - Non-unique indexes can be created with multiple threads in parallel. - -- [**`minhash` Analyzer**](../../index-and-search/analyzers.md#minhash): - Jaccard similarity approximation for entity resolution, such as for finding - duplicate records, based on how many elements they have in common - -- [**`geo_s2` Analyzer**](../../index-and-search/analyzers.md#geo_s2): - Efficiently index geo-spatial data using different binary formats, tuning the - size on disk, the precision, and query performance. - -- [**ArangoSearch column cache**](../../release-notes/version-3.10/whats-new-in-3-10.md#arangosearch-column-cache-enterprise-edition): - Always cache field normalization values, Geo Analyzer auxiliary data, - stored values, primary sort columns, and primary key columns in memory to - improve the performance of Views and inverted indexes. - -- [**ArangoSearch WAND optimization**](../../index-and-search/arangosearch/performance.md#wand-optimization): - Retrieve search results for the highest-ranking matches from Views faster by - defining a list of sort expressions to optimize. - -- [**Read from followers in clusters**](../../develop/http-api/documents.md#read-from-followers): - Allow dirty reads so that Coordinators can read from any shard replica and not - only from the leader, for scaling reads. - -## Querying - -- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md): - Get the substring positions of matched terms, phrases, or _n_-grams. - -- [**Nested search**](../../index-and-search/arangosearch/nested-search.md): - Match arrays of objects with all the conditions met by a single sub-object, - and define for how many of the elements this must be true. - -{{% comment %}} Experimental feature -- **[`classification`](../../index-and-search/analyzers.md#classification) and [`nearest_neighbors` Analyzers](../../index-and-search/analyzers.md#nearest_neighbors)**: - Classification of text tokens and finding similar tokens using supervised - fastText word embedding models. -{{% /comment %}} - -- [**Skip inaccessible collections**](../../aql/how-to-invoke-aql/with-arangosh.md#skipinaccessiblecollections): - Let AQL queries like graph traversals pretend that collections are empty if - the user has no access to them instead of failing the query. - -## Security - -- [**Auditing**](../../operations/security/audit-logging.md): - Audit logs of all server interactions. - -- [**Encryption at Rest**](../../operations/security/encryption-at-rest.md): - Hardware-accelerated on-disk encryption for your data. - -- [**Encrypted Backups**](../../components/tools/arangodump/examples.md#encryption): - Data dumps can be encrypted using a strong 256-bit AES block cipher. - -- [**Hot Backups**](../../operations/backup-and-restore.md#hot-backups): - Consistent, incremental data backups without downtime for single servers and clusters. - -- [**Enhanced Data Masking**](../../components/tools/arangodump/maskings.md#masking-functions): - Extended data masking capabilities for attributes containing sensitive data - / PII when creating backups. - -- **Advanced Encryption and Security Configuration**: - Key rotation for [JWT secrets](../../develop/http-api/authentication.md#hot-reload-jwt-secrets) - and [on-disk encryption](../../develop/http-api/security.md#encryption-at-rest), - as well as [Server Name Indication (SNI)](../../components/arangodb-server/options.md#--sslserver-name-indication). diff --git a/site/content/3.13/about-arangodb/features/highlights-by-version.md b/site/content/3.13/about-arangodb/features/highlights-by-version.md index b55db460c8..61d471a305 100644 --- a/site/content/3.13/about-arangodb/features/highlights-by-version.md +++ b/site/content/3.13/about-arangodb/features/highlights-by-version.md @@ -3,25 +3,24 @@ title: Highlights by Version menuTitle: Highlights by Version weight: 15 description: >- - The most notable features in the Community and Enterprise Edition of ArangoDB, - grouped by version + The most notable features of the ArangoDB core database system, grouped by version aliases: - ../../introduction/features/highlights-by-version --- ## Version 3.13 -**All Editions** - -- - -**Enterprise Edition** - - Also see [What's New in 3.13](../../release-notes/version-3.13/whats-new-in-3-13.md). ## Version 3.12 +{{< info >}} +From version 3.12.5 onward, the prepackaged binaries and official Docker images +of the Community Edition include all features of the Enterprise Edition. +See [ArangoDB Editions](_index.md#arangodb-editions) for details. +{{< /info >}} + **All Editions** - [**Improved memory accounting**](../../release-notes/version-3.12/whats-new-in-3-12.md#improved-memory-accounting-and-usage): diff --git a/site/content/3.13/aql/functions/arangosearch.md b/site/content/3.13/aql/functions/arangosearch.md index 2478beb468..be11f69c0f 100644 --- a/site/content/3.13/aql/functions/arangosearch.md +++ b/site/content/3.13/aql/functions/arangosearch.md @@ -286,7 +286,7 @@ FOR doc IN viewName Match documents where the attribute at `path` is present _and_ is indexed as a nested field for [nested search with Views](../../index-and-search/arangosearch/nested-search.md) -or [inverted indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition). +or [inverted indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search). - **path** (attribute path expression): the attribute to test in the document - **type** (string): string literal `"nested"` @@ -453,6 +453,10 @@ FOR doc IN viewName Match documents with an approximate Jaccard similarity of at least the `threshold`, approximated with the specified `minhash` Analyzer. +You can use the Jaccard similarity approximation with MinHash for efficient +entity resolution, such as for finding duplicate records, based on how many +common elements they have. + To only compute the MinHash signatures, see the [`MINHASH()` Miscellaneous function](miscellaneous.md#minhash). @@ -1271,8 +1275,6 @@ FOR doc IN viewName ## Search Highlighting Functions -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - ### OFFSET_INFO() `OFFSET_INFO(doc, paths) → offsetInfo` diff --git a/site/content/3.13/aql/graphs/traversals.md b/site/content/3.13/aql/graphs/traversals.md index 7d78f0cad6..384aebc902 100644 --- a/site/content/3.13/aql/graphs/traversals.md +++ b/site/content/3.13/aql/graphs/traversals.md @@ -189,8 +189,6 @@ If omitted or an empty array is specified, then there are no restrictions. #### `parallelism` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Parallelize traversal execution (number). If omitted or set to a value of `1`, the traversal execution is not parallelized. @@ -206,11 +204,15 @@ execution. #### `maxProjections` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Specifies the number of document attributes per `FOR` loop to be used as projections (number). The default value is `5`. +The AQL optimizer automatically detects which document attributes you access in +traversal queries and optimizes the data loading. This optimization is +beneficial if you have large documents but only access a few document attributes. +The `maxProjections` option lets you tune when to load individual attributes +versus the whole document. + #### `indexHint` Introduced in v3.12.1 diff --git a/site/content/3.13/aql/high-level-operations/for.md b/site/content/3.13/aql/high-level-operations/for.md index 913ccef3cb..604a6d52fd 100644 --- a/site/content/3.13/aql/high-level-operations/for.md +++ b/site/content/3.13/aql/high-level-operations/for.md @@ -218,7 +218,7 @@ there are a few corner cases where it can make sense: {{< info >}} Starting with version 3.10, `maxProjections` can be used in -[Graph Traversals](../graphs/traversals.md#working-with-named-graphs) (Enterprise Edition only). +[Graph Traversals](../graphs/traversals.md#working-with-named-graphs). {{< /info >}} ### `useCache` diff --git a/site/content/3.13/aql/high-level-operations/search.md b/site/content/3.13/aql/high-level-operations/search.md index 2948638a6b..44a27234e5 100644 --- a/site/content/3.13/aql/high-level-operations/search.md +++ b/site/content/3.13/aql/high-level-operations/search.md @@ -164,7 +164,7 @@ different outside of `SEARCH`, where `IN` needs to be followed by an array. You can use the [Question mark operator](../operators.md#question-mark-operator) to perform [Nested searches with ArangoSearch](../../index-and-search/arangosearch/nested-search.md) -(Enterprise Edition only): +: ```aql FOR doc IN myView @@ -176,7 +176,7 @@ It allows you to match nested objects in arrays that satisfy multiple conditions each, and optionally define how often these conditions should be fulfilled for the entire array. You need to configure the View specifically for this type of search using the `nested` property in [`arangosearch` Views](../../index-and-search/arangosearch/arangosearch-views-reference.md#link-properties) -or in the definition of [Inverted Indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition) +or in the definition of [Inverted Indexes](../../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search) that you can add to [`search-alias` Views](../../index-and-search/arangosearch/search-alias-views-reference.md). ## Handling of non-indexed fields diff --git a/site/content/3.13/aql/how-to-invoke-aql/with-arangosh.md b/site/content/3.13/aql/how-to-invoke-aql/with-arangosh.md index b91699876f..1a55f5abc8 100644 --- a/site/content/3.13/aql/how-to-invoke-aql/with-arangosh.md +++ b/site/content/3.13/aql/how-to-invoke-aql/with-arangosh.md @@ -496,8 +496,6 @@ the entire query result in RAM, use a streaming query (see the #### `allowDirtyReads` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Introduced in: v3.10.0 If you set this option to `true` and execute the query against a cluster @@ -507,8 +505,6 @@ for details. #### `skipInaccessibleCollections` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Let AQL queries (especially graph traversals) treat collection to which a user has **no access** rights for as if these collections are empty. Instead of returning a *forbidden access* error, your queries execute normally. @@ -518,8 +514,6 @@ accessible results by changing the access rights of users on collections. #### `satelliteSyncWait` -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Configure how long a DB-Server has time to bring the SatelliteCollections involved in the query into sync. The default value is `60.0` seconds. When the maximal time is reached, the query is stopped. diff --git a/site/content/3.13/aql/operators.md b/site/content/3.13/aql/operators.md index a8f5395ee7..d925fc226d 100644 --- a/site/content/3.13/aql/operators.md +++ b/site/content/3.13/aql/operators.md @@ -727,9 +727,9 @@ surrounding length check. The following table compares both variants: | `arr[?]` | `LENGTH(arr[*]) > 0` {.fixed} -The question mark operator can be used for nested search (Enterprise Edition only): +The question mark operator can be used for nested search: - [Nested search with ArangoSearch](../index-and-search/arangosearch/nested-search.md) using Views -- Nested search using [Inverted indexes](../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search-enterprise-edition) +- Nested search using [Inverted indexes](../index-and-search/indexing/working-with-indexes/inverted-indexes.md#nested-search) ### Array destructuring diff --git a/site/content/3.13/components/arangodb-server/_index.md b/site/content/3.13/components/arangodb-server/_index.md index e12ed49eca..6bceea0bcf 100644 --- a/site/content/3.13/components/arangodb-server/_index.md +++ b/site/content/3.13/components/arangodb-server/_index.md @@ -14,8 +14,7 @@ The server process serves the various client connections to the server via the TCP/HTTP protocol. It also provides a [web interface](../web-interface/_index.md). _arangod_ can run in different modes for a variety of setups like single server -and clusters. It differs between the [Community Edition](../../about-arangodb/features/community-edition.md) -and [Enterprise Edition](../../about-arangodb/features/enterprise-edition.md). +and clusters. See [Administration](../../operations/administration/_index.md) for server configuration and [Deploy](../../deploy/_index.md) for operation mode details. diff --git a/site/content/3.13/components/tools/arangobackup/_index.md b/site/content/3.13/components/tools/arangobackup/_index.md index aff5b54870..342c24c29a 100644 --- a/site/content/3.13/components/tools/arangobackup/_index.md +++ b/site/content/3.13/components/tools/arangobackup/_index.md @@ -6,12 +6,9 @@ description: >- `arangobackup` is a command-line client tool to create global hot backups of ArangoDB deployments --- -{{< tag "ArangoDB Enterprise Edition" >}} - {{< tip >}} -In the Community Edition, use [_arangodump_](../arangodump/_index.md) and -[_arangorestore_](../arangorestore/_index.md) for -[logical backups](../../../operations/backup-and-restore.md#logical-backups). +In the ArangoGraph Insights Platform, use managed +[Backups](../../../arangograph/backups.md) instead. {{< /tip >}} _arangobackup_ creates instantaneous and consistent diff --git a/site/content/3.13/components/tools/arangobackup/examples.md b/site/content/3.13/components/tools/arangobackup/examples.md index 8e31883ce8..693c625d76 100644 --- a/site/content/3.13/components/tools/arangobackup/examples.md +++ b/site/content/3.13/components/tools/arangobackup/examples.md @@ -223,7 +223,7 @@ The output will look like this: [Rclone](https://rclone.org/) is a versatile open-source remote file sync program that can deal with over 30 different remote file -IO protocols. Enterprise Editions of ArangoDB come with a bundled version +IO protocols. ArangoDB comes with a bundled version of rclone, which is distributed under the MIT license. It is used to both download and upload hot backup sets to and from local and cloud operated storage resources. diff --git a/site/content/3.13/components/tools/arangodump/examples.md b/site/content/3.13/components/tools/arangodump/examples.md index d282dc8b4e..ef5bc7de32 100644 --- a/site/content/3.13/components/tools/arangodump/examples.md +++ b/site/content/3.13/components/tools/arangodump/examples.md @@ -163,8 +163,6 @@ INFO [66c0e] {dump} Processed 2 collection(s) from 1 database(s) in 0.132990 s t ## Encryption -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - You can encrypt dumps using an encryption keyfile, which must contain exactly 32 bytes of data (required by the AES block cipher). diff --git a/site/content/3.13/components/tools/arangodump/maskings.md b/site/content/3.13/components/tools/arangodump/maskings.md index 415262ccd5..de71ffd4e4 100644 --- a/site/content/3.13/components/tools/arangodump/maskings.md +++ b/site/content/3.13/components/tools/arangodump/maskings.md @@ -470,8 +470,8 @@ processed by a single masking function, ignoring any other rules below it. ## Masking Functions -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - +- [Random String](#random-string) +- [Random](#random) - [Xify Front](#xify-front) - [Zip](#zip) - [Datetime](#datetime) @@ -481,13 +481,6 @@ processed by a single masking function, ignoring any other rules below it. - [Phone Number](#phone-number) - [Email Address](#email-address) -The masking functions: - -- [Random String](#random-string) -- [Random](#random) - -… are available in the Community Edition as well as the Enterprise Edition. - ### Random String This masking type replaces all values of attributes whose values are strings diff --git a/site/content/3.13/components/web-interface/graphs.md b/site/content/3.13/components/web-interface/graphs.md index b504bee758..68deb9265c 100644 --- a/site/content/3.13/components/web-interface/graphs.md +++ b/site/content/3.13/components/web-interface/graphs.md @@ -17,9 +17,9 @@ subsets of a graph or an entire graph. 1. In the **Graphs** section, click the first card with the label **Add Graph**. 2. Select a tab depending on which type of named graph you want to create. The **SatelliteGraph**, **SmartGraph**, and **EnterpriseGraph** tabs are - only available for cluster deployments using the Enterprise Edition. - For non-cluster deployments and in the Community Edition, only the - **Examples** and **GeneralGraph** tabs are available. + only available for cluster deployments. + For non-cluster deployments and in the Community Edition up to v3.12.4, + only the **Examples** and **GeneralGraph** tabs are available. 3. Fill in the fields of the dialog. Required fields have an asterisk (`*`) in their label. Hover over the gray circle with a white `i` in it next to a field to show the tooltip with an explanation. diff --git a/site/content/3.13/data-science/arangographml/deploy.md b/site/content/3.13/data-science/arangographml/deploy.md index 0d62cb12f6..2fa947b758 100644 --- a/site/content/3.13/data-science/arangographml/deploy.md +++ b/site/content/3.13/data-science/arangographml/deploy.md @@ -54,8 +54,6 @@ To summarize, all you need to do is: ### Self-managed ArangoGraphML -{{< tag "ArangoDB Enterprise Edition" >}} - The self-managed solution enables you to deploy and manage ArangoML within your Kubernetes cluster using the [ArangoDB Kubernetes Operator](https://github.com/arangodb/kube-arangodb). diff --git a/site/content/3.13/deploy/_index.md b/site/content/3.13/deploy/_index.md index 5a6de1a8d7..7ad9165a5b 100644 --- a/site/content/3.13/deploy/_index.md +++ b/site/content/3.13/deploy/_index.md @@ -37,8 +37,6 @@ You can deploy systems that dynamically scale up and down according to demand. ### OneShard -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - [OneShard deployments](oneshard.md) are cluster deployments but with the data of each database restricted to a single shard. This allows queries to run locally on a single DB-Server node for better performance and with transactional diff --git a/site/content/3.13/deploy/cluster/administration.md b/site/content/3.13/deploy/cluster/administration.md index b434da5304..9b59616739 100644 --- a/site/content/3.13/deploy/cluster/administration.md +++ b/site/content/3.13/deploy/cluster/administration.md @@ -180,7 +180,7 @@ The available sharding strategies are: If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph -vertex collections (the latter two require the Enterprise Edition of ArangoDB). +vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. diff --git a/site/content/3.13/deploy/cluster/deployment/using-the-arangodb-starter.md b/site/content/3.13/deploy/cluster/deployment/using-the-arangodb-starter.md index 6439552c82..09e67ac79b 100644 --- a/site/content/3.13/deploy/cluster/deployment/using-the-arangodb-starter.md +++ b/site/content/3.13/deploy/cluster/deployment/using-the-arangodb-starter.md @@ -179,9 +179,9 @@ docker run -it --name=adbN --rm -p 8528:8528 \ --docker.net-mode=default ``` -If you use the Enterprise Edition Docker image, you have to set the license key +If you have a license for the Enterprise Edition, set the license key in an environment variable by adding this option to the above `docker` command -(place `` with the actual license key): +(replace `` with the actual license key): ``` -e ARANGO_LICENSE_KEY= @@ -189,11 +189,7 @@ in an environment variable by adding this option to the above `docker` command The Starter hands the license key to the Docker containers it launches for ArangoDB. -You can get a free evaluation license key by visiting: - -[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/) - -**TLS verified Docker services** +**TLS-verified Docker services** Oftentimes, one needs to harden Docker services using client certificate and TLS verification. The Docker API allows subsequently only certified access. diff --git a/site/content/3.13/deploy/cluster/limitations.md b/site/content/3.13/deploy/cluster/limitations.md index 5fd0ebb727..fedf70c984 100644 --- a/site/content/3.13/deploy/cluster/limitations.md +++ b/site/content/3.13/deploy/cluster/limitations.md @@ -17,9 +17,8 @@ Obviously, an ArangoDB Cluster is limited by the available resources of CPU, memory, disk and network bandwidth and latency. Moreover, high numbers of databases, collections, and shards come at a cost. -An ArangoDB Enterprise Edition cluster can sustain up to a few thousand +An ArangoDB cluster can sustain up to a few thousand databases, and a database can sustain up to a thousand collections, but the total number of shards in the cluster should not go beyond 50,000 or so. Beyond these limits, certain regular cleanup and maintenance operations can take -too long for a smooth operational experience. The Community Edition comes -without guarantees regarding the database, collection, and shard count. +too long for a smooth operational experience. diff --git a/site/content/3.13/deploy/oneshard.md b/site/content/3.13/deploy/oneshard.md index cd4eed572b..cb7ed57fe7 100644 --- a/site/content/3.13/deploy/oneshard.md +++ b/site/content/3.13/deploy/oneshard.md @@ -3,11 +3,10 @@ title: OneShard cluster deployments menuTitle: OneShard weight: 20 description: >- - The OneShard feature offers a practicable solution that enables significantly - improved performance and transactional guarantees for cluster deployments + OneShard is a deployment option to store all collections of a database on a + single cluster node, to combine the performance and the transactional + guarantees of a single server with a fault-tolerant cluster setup --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - The OneShard option for ArangoDB clusters restricts all collections of a database to a single shard so that every collection has `numberOfShards` set to `1`, and all leader shards are placed on one DB-Server node. This way, whole queries @@ -59,8 +58,8 @@ resilience etc. ### How to use the OneShard feature -The OneShard feature is enabled by default if you use the ArangoDB -Enterprise Edition and if the database is sharded as `"single"`. In this case the +The OneShard feature is enabled by default +and if the database is sharded as `"single"`. In this case the optimizer rule `cluster-one-shard` is applied automatically. There are two ways to achieve this: diff --git a/site/content/3.13/deploy/production-checklist.md b/site/content/3.13/deploy/production-checklist.md index 486452b1e2..6cb59f8198 100644 --- a/site/content/3.13/deploy/production-checklist.md +++ b/site/content/3.13/deploy/production-checklist.md @@ -76,9 +76,8 @@ have been performed on your production system before you go live. - Verify your **Backup** and restore procedures are working. -- Consider enabling [Encryption at Rest](../operations/security/encryption-at-rest.md) - (Enterprise Edition only). Make sure to safely store any secret keys you - create for this. +- Consider enabling [Encryption at Rest](../operations/security/encryption-at-rest.md). + Make sure to safely store any secret keys you create for this. - Monitor the ArangoDB provided metrics (e.g. by using Prometheus/Grafana). diff --git a/site/content/3.13/deploy/single-instance-vs-cluster.md b/site/content/3.13/deploy/single-instance-vs-cluster.md index 7367bc7f8c..07611e21cf 100644 --- a/site/content/3.13/deploy/single-instance-vs-cluster.md +++ b/site/content/3.13/deploy/single-instance-vs-cluster.md @@ -125,10 +125,12 @@ problem. Using a single instance of ArangoDB, multi-document / multi-collection queries are guaranteed to be fully ACID. This is more than many other NoSQL database systems support. In cluster mode, single-document -operations are also fully ACID. Multi-document / multi-collection +operations are also fully ACID, and so are multi-document queries for +collections with a single shard. Multi-document / multi-collection queries in a cluster are not ACID, which is equally the case for -competing database systems. See [Transactions](../develop/transactions/_index.md) -for details. +competing database systems. However, ACID transactions are supported for +multi-collection queries using ArangoDB's [OneShard](oneshard.md) feature. +See [Transactions](../develop/transactions/_index.md) for details. Batch operations for multiple documents in the same collection are only fully transactional in a single instance. @@ -163,6 +165,6 @@ In a cluster, the `arangodump` utility cannot guarantee a consistent snapshot across multiple shards or even multiple collections. In a single server, `arangodump` produces a consistent snapshot. -In the Enterprise Edition, there is an additional utility -`arangobackup` and an HTTP API for [Hot Backups](../operations/backup-and-restore.md#hot-backups) +There is an additional `arangobackup` utility and an HTTP API for +[Hot Backups](../operations/backup-and-restore.md#hot-backups) to create consistent cluster snapshots. diff --git a/site/content/3.13/deploy/single-instance/using-the-arangodb-starter.md b/site/content/3.13/deploy/single-instance/using-the-arangodb-starter.md index b4057671af..b23ddff05c 100644 --- a/site/content/3.13/deploy/single-instance/using-the-arangodb-starter.md +++ b/site/content/3.13/deploy/single-instance/using-the-arangodb-starter.md @@ -49,22 +49,17 @@ docker run -it --name=adb --rm -p 8528:8528 \ --docker.net-mode=default ``` -If you use the Enterprise Edition Docker image, you have to set the license key -in an environment variable by adding this option to the above `docker` command: +If you have a license for the Enterprise Edition, set the license key +in an environment variable by adding this option to the above `docker` command +(replace `` with the actual license key): ``` - -e ARANGO_LICENSE_KEY= + -e ARANGO_LICENSE_KEY= ``` -You can get a free evaluation license key by visiting: +The Starter hands the license key to the Docker containers it launches for ArangoDB. -[www.arangodb.com/download-arangodb-enterprise/](https://www.arangodb.com/download-arangodb-enterprise/) - -Then replace `` above with the actual license key. The start -will then hand on the license key to the Docker container it launches -for ArangoDB. - -### TLS verified Docker services +### TLS-verified Docker services Oftentimes, one needs to harden Docker services using client certificate and TLS verification. The Docker API allows subsequently only certified access. diff --git a/site/content/3.13/develop/drivers/python.md b/site/content/3.13/develop/drivers/python.md index bea8233d48..782250ba3a 100644 --- a/site/content/3.13/develop/drivers/python.md +++ b/site/content/3.13/develop/drivers/python.md @@ -83,7 +83,7 @@ db = client.db("test", username="root", password="passwd") # Create a new graph named "school". graph = db.create_graph("school") -# Create a new EnterpriseGraph [Enterprise Edition] +# Create a new EnterpriseGraph eegraph = db.create_graph( name="school", smart=True) diff --git a/site/content/3.13/develop/http-api/administration.md b/site/content/3.13/develop/http-api/administration.md index 0fe1d0e940..52fb5286b8 100644 --- a/site/content/3.13/develop/http-api/administration.md +++ b/site/content/3.13/develop/http-api/administration.md @@ -801,9 +801,8 @@ paths: that is not ready for production yet - `obsolete` (boolean): Whether the option has been deprecated and no effect anymore - - `enterpriseOnly` (boolean): Whether the option is only available in - the Enterprise Edition. The Community Edition does have most of the - Enterprise Edition startup options and they are thus not reported + - `enterpriseOnly` (boolean): Whether the option is implemented in + the non-public enterprise code. - `requiresValue` (boolean): Whether the option can be specified without a value to enable it - `os` (array of strings): The operating systems the startup option @@ -981,7 +980,7 @@ paths: license: description: | The encrypted license key in Base64 encoding, or `"none"` - in the Community Edition. + for the Community Edition. type: string example: V0h/W...wEDw== hash: @@ -1134,7 +1133,7 @@ paths: type: string '501': description: | - If you try to apply a license in the Community Edition. + If you try to apply a license using a custom build of the public source code. content: application/json: schema: diff --git a/site/content/3.13/develop/http-api/authentication.md b/site/content/3.13/develop/http-api/authentication.md index 4b5fa15c36..019ba19e00 100644 --- a/site/content/3.13/develop/http-api/authentication.md +++ b/site/content/3.13/develop/http-api/authentication.md @@ -272,7 +272,10 @@ curl -v -H "Authorization: bearer $(jwtgen -s -e 3600 -a "HS256" -c ## Hot-reload JWT secrets -{{< tag "ArangoDB Enterprise Edition" >}} +{{< tip >}} +In the ArangoGraph Insights Platform, authentication secrets are managed and +therefore this feature isn't available. +{{< /tip >}} To reload the JWT secrets of a local arangod process without a restart, you may use the following RESTful API. A `POST` request reloads the secret, a diff --git a/site/content/3.13/develop/http-api/collections.md b/site/content/3.13/develop/http-api/collections.md index 500b1b04fb..1fefa8927e 100644 --- a/site/content/3.13/develop/http-api/collections.md +++ b/site/content/3.13/develop/http-api/collections.md @@ -502,7 +502,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -540,25 +540,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -935,7 +935,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -973,25 +973,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -1399,7 +1399,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -1437,25 +1437,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -2207,7 +2207,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -2245,25 +2245,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -2893,8 +2893,7 @@ paths: of each shard are kept on different DB-Servers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. For SatelliteCollections, it needs to be the string `"satellite"`, - which matches the replication factor to the number of DB-Servers - (Enterprise Edition only). + which matches the replication factor to the number of DB-Servers. Any two copies reside on different DB-Servers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated @@ -2947,7 +2946,7 @@ paths: If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph - vertex collections (the latter two require the *Enterprise Edition* of ArangoDB). + vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. type: string @@ -2957,8 +2956,7 @@ paths: collection copies the `replicationFactor`, `numberOfShards` and `shardingStrategy` properties from the specified collection (referred to as the _prototype collection_) and distributes the shards of this collection in the same way as the shards of - the other collection. In an Enterprise Edition cluster, this data co-location is - utilized to optimize queries. + the other collection. This data co-location is utilized to optimize queries. You need to use the same number of `shardKeys` as the prototype collection, but you can use different attributes. @@ -2974,13 +2972,13 @@ paths: default: "" isSmart: description: | - Whether the collection is for a SmartGraph or EnterpriseGraph - (Enterprise Edition only). This is an internal property. + Whether the collection is for a SmartGraph or EnterpriseGraph. + This is an internal property. type: boolean isDisjoint: description: | - Whether the collection is for a Disjoint SmartGraph - (Enterprise Edition only). This is an internal property. + Whether the collection is for a Disjoint SmartGraph. + This is an internal property. type: boolean smartGraphAttribute: description: | @@ -2988,18 +2986,16 @@ paths: this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - - This feature can only be used in the *Enterprise Edition*. type: string smartJoinAttribute: description: | - In an *Enterprise Edition* cluster, this attribute determines an attribute + In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. Additionally, the shard key for a document in this collection must contain the value of this attribute, followed by a colon, followed by the actual primary key of the document. - This feature can only be used in the *Enterprise Edition* and requires the + This feature requires the `distributeShardsLike` attribute of the collection to be set to the name of another collection. It also requires the `shardKeys` attribute of the collection to be set to a single shard key attribute, with an additional ':' @@ -3204,7 +3200,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -3242,25 +3238,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -3925,8 +3921,7 @@ paths: of each shard are kept on different DB-Servers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. For SatelliteCollections, it needs to be the string `"satellite"`, - which matches the replication factor to the number of DB-Servers - (Enterprise Edition only). + which matches the replication factor to the number of DB-Servers. Any two copies reside on different DB-Servers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated @@ -4148,7 +4143,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -4186,25 +4181,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | @@ -4731,7 +4726,7 @@ paths: description: | Contains how many copies of each shard are kept on different DB-Servers. It is an integer number in the range of 1-10 or the string `"satellite"` - for SatelliteCollections (Enterprise Edition only). _(cluster only)_ + for SatelliteCollections. _(cluster only)_ type: integer writeConcern: description: | @@ -4769,25 +4764,25 @@ paths: type: string isSmart: description: | - Whether the collection is used in a SmartGraph or EnterpriseGraph (Enterprise Edition only). + Whether the collection is used in a SmartGraph or EnterpriseGraph. This is an internal property. _(cluster only)_ type: boolean isDisjoint: description: | - Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint - (Enterprise Edition only). This is an internal property. _(cluster only)_ + Whether the SmartGraph or EnterpriseGraph this collection belongs to is disjoint. + This is an internal property. _(cluster only)_ type: boolean smartGraphAttribute: description: | The attribute that is used for sharding: vertices with the same value of this attribute are placed in the same shard. All vertices are required to have this attribute set and it has to be a string. Edges derive the - attribute from their connected vertices (Enterprise Edition only). _(cluster only)_ + attribute from their connected vertices. _(cluster only)_ type: string smartJoinAttribute: description: | Determines an attribute of the collection that must contain the shard key value - of the referred-to SmartJoin collection (Enterprise Edition only). _(cluster only)_ + of the referred-to SmartJoin collection. _(cluster only)_ type: string name: description: | diff --git a/site/content/3.13/develop/http-api/databases.md b/site/content/3.13/develop/http-api/databases.md index d12e72f7af..8803fb9ca1 100644 --- a/site/content/3.13/develop/http-api/databases.md +++ b/site/content/3.13/develop/http-api/databases.md @@ -248,7 +248,7 @@ paths: description: | Default replication factor for new collections created in this database. Special values include "satellite", which will replicate the collection to - every DB-Server (Enterprise Edition only), and 1, which disables replication. + every DB-Server, and 1, which disables replication. _(cluster only)_ type: integer writeConcern: diff --git a/site/content/3.13/develop/http-api/documents.md b/site/content/3.13/develop/http-api/documents.md index 715760330b..59f80e2b47 100644 --- a/site/content/3.13/develop/http-api/documents.md +++ b/site/content/3.13/develop/http-api/documents.md @@ -3072,8 +3072,6 @@ db._drop(cn); ## Read from followers -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - Introduced in: v3.10.0 In an ArangoDB cluster, all reads and writes are performed via diff --git a/site/content/3.13/develop/http-api/graphs/named-graphs.md b/site/content/3.13/develop/http-api/graphs/named-graphs.md index 9523741871..a6876a3c7d 100644 --- a/site/content/3.13/develop/http-api/graphs/named-graphs.md +++ b/site/content/3.13/develop/http-api/graphs/named-graphs.md @@ -148,7 +148,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -163,19 +163,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean tags: - Graphs @@ -280,12 +280,11 @@ paths: type: string isSmart: description: | - Define if the created graph should be smart (Enterprise Edition only). + Define if the created graph should be smart. type: boolean isDisjoint: description: | - Whether to create a Disjoint SmartGraph instead of a regular SmartGraph - (Enterprise Edition only). + Whether to create a Disjoint SmartGraph instead of a regular SmartGraph. type: boolean options: description: | @@ -295,7 +294,8 @@ paths: properties: smartGraphAttribute: description: | - Only has effect in Enterprise Edition and it is required if isSmart is true. + Required if `isSmart` is true. + The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this SmartGraph has to have this attribute. Cannot be modified later. @@ -303,7 +303,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -318,8 +318,7 @@ paths: description: | The replication factor used when initially creating collections for this graph. Can be set to `"satellite"` to create a SatelliteGraph, which then ignores - `numberOfShards`, `minReplicationFactor`, and `writeConcern` - (Enterprise Edition only). + `numberOfShards`, `minReplicationFactor`, and `writeConcern`. type: integer writeConcern: description: | @@ -434,7 +433,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -449,19 +448,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -561,7 +560,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -576,19 +575,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -730,7 +729,6 @@ graph._drop("myGraph", true); description: |- Create a SmartGraph. This graph uses 9 shards and is sharded by the "region" attribute. - Available in the Enterprise Edition only. name: HttpGharialCreateSmart --- var graph = require("@arangodb/general-graph"); @@ -768,7 +766,6 @@ graph._drop("smartGraph", true); description: |- Create a disjoint SmartGraph. This graph uses 9 shards and is sharded by the "region" attribute. - Available in the Enterprise Edition only. Note that as you are using a disjoint version, you can only create edges between vertices sharing the same region. name: HttpGharialCreateDisjointSmart @@ -812,7 +809,6 @@ description: |- This collection is cloned to all servers, all other vertex collections are split into 9 shards and are sharded by the "region" attribute. - Available in the Enterprise Edition only. name: HttpGharialCreateSmartWithSatellites --- var graph = require("@arangodb/general-graph"); @@ -851,7 +847,6 @@ graph._drop("smartGraph", true); description: |- Create an EnterpriseGraph. This graph uses 9 shards, it does not make use of specific sharding attributes. - Available in the Enterprise Edition only. name: HttpGharialCreateEnterprise --- var graph = require("@arangodb/general-graph"); @@ -890,7 +885,6 @@ description: |- shards, but uses "satellite" as replicationFactor. Make sure to keep this graph small as it is cloned to every server. - Available in the Enterprise Edition only. name: HttpGharialCreateSatellite --- var graph = require("@arangodb/general-graph"); @@ -1045,7 +1039,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1060,19 +1054,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '404': description: | @@ -1445,7 +1439,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -1550,7 +1544,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1565,19 +1559,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -1677,7 +1671,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1692,19 +1686,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -1972,7 +1966,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -1987,19 +1981,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -2097,7 +2091,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2112,19 +2106,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -2443,7 +2437,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -2548,7 +2542,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2563,19 +2557,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -2675,7 +2669,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -2690,19 +2684,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -2912,7 +2906,7 @@ paths: satellites: description: | An array of collection names that is used to create SatelliteCollections - for a (Disjoint) SmartGraph using SatelliteCollections (Enterprise Edition only). + for a (Disjoint) SmartGraph using SatelliteCollections. Each array element must be a string and a valid collection name. The collection type cannot be modified later. type: array @@ -3015,7 +3009,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3030,19 +3024,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -3140,7 +3134,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3155,19 +3149,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '400': description: | @@ -3440,7 +3434,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3455,19 +3449,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '202': description: | @@ -3566,7 +3560,7 @@ paths: replicationFactor: description: | The replication factor used for every new collection in the graph. - For SatelliteGraphs, it is the string `"satellite"` (Enterprise Edition only). + For SatelliteGraphs, it is the string `"satellite"`. type: integer writeConcern: description: | @@ -3581,19 +3575,19 @@ paths: type: integer isSmart: description: | - Whether the graph is a SmartGraph (Enterprise Edition only). + Whether the graph is a SmartGraph. type: boolean isDisjoint: description: | - Whether the graph is a Disjoint SmartGraph (Enterprise Edition only). + Whether the graph is a Disjoint SmartGraph. type: boolean smartGraphAttribute: description: | - Name of the sharding attribute in the SmartGraph case (Enterprise Edition only). + Name of the sharding attribute in the SmartGraph case. type: string isSatellite: description: | - Flag if the graph is a SatelliteGraph (Enterprise Edition only) or not. + Whether the graph is a SatelliteGraph. type: boolean '403': description: | diff --git a/site/content/3.13/develop/http-api/hot-backups.md b/site/content/3.13/develop/http-api/hot-backups.md index 4f0d4aea46..b986c32ced 100644 --- a/site/content/3.13/develop/http-api/hot-backups.md +++ b/site/content/3.13/develop/http-api/hot-backups.md @@ -6,7 +6,10 @@ description: >- The HTTP API for Hot Backups lets you manage incremental, zero-downtime data backups --- -{{< tag "ArangoDB Enterprise Edition" >}} +{{< tip >}} +In the ArangoGraph Insights Platform, use managed +[Backups](../../arangograph/backups.md) instead. +{{< /tip >}} Hot Backups are near instantaneous consistent snapshots of an **entire** ArangoDB deployment. This includes all databases, collections, diff --git a/site/content/3.13/develop/http-api/indexes/inverted.md b/site/content/3.13/develop/http-api/indexes/inverted.md index 4a1fc22261..a43033eb52 100644 --- a/site/content/3.13/develop/http-api/indexes/inverted.md +++ b/site/content/3.13/develop/http-api/indexes/inverted.md @@ -147,8 +147,6 @@ paths: Default: the value defined by the top-level `cache` option. - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -160,8 +158,6 @@ paths: `fields` property, the values get indexed in a way that lets you query for co-occurring values. For example, you can search the sub-objects and all the conditions need to be met by a single sub-object instead of across all of them. - - This property is available in the Enterprise Edition only. type: array items: type: object @@ -223,8 +219,6 @@ paths: Default: the value defined by the top-level `cache` option. - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -270,8 +264,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -333,8 +325,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -388,8 +378,6 @@ paths: Default: `false` - This property is available in the Enterprise Edition only. - See the `--arangosearch.columns-cache-limit` startup option to control the memory consumption of this cache. You can reduce the memory usage of the column cache in cluster deployments by only using the cache for leader shards, see the @@ -430,8 +418,6 @@ paths: Example: `["BM25(@doc) DESC", "TFIDF(@doc, true) DESC"]` Default: `[]` - - This property is available in the Enterprise Edition only. type: array items: type: string diff --git a/site/content/3.13/develop/http-api/monitoring/logs.md b/site/content/3.13/develop/http-api/monitoring/logs.md index 95869c2fe0..252df8a106 100644 --- a/site/content/3.13/develop/http-api/monitoring/logs.md +++ b/site/content/3.13/develop/http-api/monitoring/logs.md @@ -462,44 +462,42 @@ paths: audit-authentication: description: | Controls whether events such as successful logins and - missing or wrong credentials are written to the audit log - (_Enterprise Edition only_). + missing or wrong credentials are written to the audit log. type: string audit-authorization: description: | Controls whether events such as users trying to access databases - without the necessary permissions are written to the audit log - (_Enterprise Edition only_). + without the necessary permissions are written to the audit log. type: string audit-collection: description: | Controls whether events about collections creation, truncation, - and deletion are written to the audit log (_Enterprise Edition only_). + and deletion are written to the audit log. type: string audit-database: description: | Controls whether events about database creation and deletion - are written to the audit log (_Enterprise Edition only_). + are written to the audit log. type: string audit-document: description: | Controls whether document read and write events are written - to the audit log (_Enterprise Edition only_). + to the audit log. type: string audit-hotbackup: description: | Controls whether the Hot Backup creation, restore, and delete - events are written to the audit log (_Enterprise Edition only_). + events are written to the audit log. type: string audit-service: description: | Controls whether the start and stop events of the audit - service are written to the audit log (_Enterprise Edition only_). + service are written to the audit log. type: string audit-view: description: | Controls whether events about View creation and deletion - are written to the audit log (_Enterprise Edition only_). + are written to the audit log. type: string authentication: description: | @@ -512,7 +510,7 @@ paths: type: string backup: description: | - Logs events related to Hot Backup (_Enterprise Edition only_). + Logs events related to Hot Backup. type: string bench: description: | @@ -600,7 +598,7 @@ paths: license: description: | Logs events related to the license management like the - expiration of a license (_Enterprise Edition only_). + expiration of a license. type: string maintenance: description: | diff --git a/site/content/3.13/develop/http-api/queries/aql-queries.md b/site/content/3.13/develop/http-api/queries/aql-queries.md index b795b42fd3..9898ecbd40 100644 --- a/site/content/3.13/develop/http-api/queries/aql-queries.md +++ b/site/content/3.13/develop/http-api/queries/aql-queries.md @@ -583,7 +583,7 @@ paths: type: integer satelliteSyncWait: description: | - This *Enterprise Edition* parameter allows to configure how long a DB-Server has time + This parameter allows to configure how long a DB-Server has time to bring the SatelliteCollections involved in the query into sync. The default value is `60.0` seconds. When the maximal time is reached, the query is stopped. @@ -634,8 +634,6 @@ paths: with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can naturally limit the accessible results by changing the access rights of users on collections. - - This feature is only available in the Enterprise Edition. type: boolean allowDirtyReads: description: | @@ -647,8 +645,6 @@ paths: namely obsolete revisions of documents because changes have not yet been replicated to the follower, as well as changes to documents before they are officially committed on the leader. - - This feature is only available in the Enterprise Edition. type: boolean responses: '201': @@ -3471,7 +3467,7 @@ paths: type: boolean enterpriseOnly: description: | - Whether the rule is available in the Enterprise Edition only. + Whether the rule is implemented in the non-public enterprise code. type: boolean tags: - Queries diff --git a/site/content/3.13/develop/http-api/views/arangosearch-views.md b/site/content/3.13/develop/http-api/views/arangosearch-views.md index f4d331a2ee..9f6f0185bb 100644 --- a/site/content/3.13/develop/http-api/views/arangosearch-views.md +++ b/site/content/3.13/develop/http-api/views/arangosearch-views.md @@ -95,7 +95,7 @@ paths: primarySortCache: description: | If you enable this option, then the primary sort columns are always cached in - memory (Enterprise Edition only). This can improve the + memory. This can improve the performance of queries that utilize the primary sort order. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -110,7 +110,7 @@ paths: primaryKeyCache: description: | If you enable this option, then the primary key columns are always cached in - memory (introduced in v3.9.6, Enterprise Edition only). This can improve the + memory (introduced in v3.9.6). This can improve the performance of queries that return many documents. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -141,8 +141,6 @@ paths: You can define up to 64 expressions per View. Example: `["BM25(@doc) DESC", "TFIDF(@doc, true) DESC"]` - - This property is available in the Enterprise Edition only. type: array items: type: string @@ -208,7 +206,7 @@ paths: default: lz4 cache: description: | - Whether to always cache stored values in memory (Enterprise Edition only). + Whether to always cache stored values in memory. This can improve the query performance if stored values are involved. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory. @@ -459,18 +457,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -502,8 +498,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -934,18 +929,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -977,8 +970,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -1519,18 +1511,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -1562,8 +1552,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -2010,18 +1999,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -2053,8 +2040,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | @@ -2380,18 +2366,16 @@ paths: enum: [lz4, none] primarySortCache: description: | - Whether the primary sort columns are always cached in memory - (Enterprise Edition only). + Whether the primary sort columns are always cached in memory. type: boolean primaryKeyCache: description: | - Whether the primary key columns are always cached in memory - (Enterprise Edition only). + Whether the primary key columns are always cached in memory. type: boolean optimizeTopK: description: | An array of strings defining sort expressions that can be optimized. - This is also known as _WAND optimization_ (Enterprise Edition only, introduced in v3.12.0). + This is also known as _WAND optimization_ (introduced in v3.12.0). type: array items: type: string @@ -2423,8 +2407,7 @@ paths: enum: [lz4, none] cache: description: | - Whether stored values are always cached in memory - (Enterprise Edition only). + Whether stored values are always cached in memory. type: boolean cleanupIntervalStep: description: | diff --git a/site/content/3.13/develop/javascript-api/@arangodb/collection-object.md b/site/content/3.13/develop/javascript-api/@arangodb/collection-object.md index 732ea5777b..a89942f97d 100644 --- a/site/content/3.13/develop/javascript-api/@arangodb/collection-object.md +++ b/site/content/3.13/develop/javascript-api/@arangodb/collection-object.md @@ -255,8 +255,7 @@ In a cluster setup, the result also contains the following attributes: - `replicationFactor` (number\|string): Determines how many copies of each shard are kept on different DB-Servers. Has to be in the range of 1-10 or the string - `"satellite"` for a SatelliteCollection (Enterprise Edition only). - _(cluster only)_ + `"satellite"` for a SatelliteCollection. _(cluster only)_ - `writeConcern` (number): Determines how many copies of each shard are required to be in sync on the different DB-Servers. If there are less then these many copies @@ -282,10 +281,10 @@ In a cluster setup, the result also contains the following attributes: the other collection. - `isSmart` (boolean): Whether the collection is used in a SmartGraph or - EnterpriseGraph (Enterprise Edition only). This is an internal property. + EnterpriseGraph. This is an internal property. - `isDisjoint` (boolean): Whether the SmartGraph this collection belongs to is - disjoint (Enterprise Edition only). This is an internal property. + disjoint. This is an internal property. - `smartGraphAttribute` (string): The attribute that is used for sharding: vertices with the same value of @@ -293,10 +292,8 @@ In a cluster setup, the result also contains the following attributes: have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - This feature can only be used in the *Enterprise Edition*. - - `smartJoinAttribute` (string): - In an *Enterprise Edition* cluster, this attribute determines an attribute + In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. @@ -312,8 +309,7 @@ one or more of the following attribute(s): - `replicationFactor` (number\|string): Change the number of shard copies kept on different DB-Servers. Valid values are integer numbers in the range of 1-10 - or the string `"satellite"` for a SatelliteCollection (Enterprise Edition only). - _(cluster only)_ + or the string `"satellite"` for a SatelliteCollection. _(cluster only)_ - `writeConcern` (number): Change how many copies of each shard are required to be in sync on the different DB-Servers. If there are less then these many copies diff --git a/site/content/3.13/develop/javascript-api/@arangodb/db-object.md b/site/content/3.13/develop/javascript-api/@arangodb/db-object.md index 8baeb0d825..832e065f3d 100644 --- a/site/content/3.13/develop/javascript-api/@arangodb/db-object.md +++ b/site/content/3.13/develop/javascript-api/@arangodb/db-object.md @@ -44,8 +44,7 @@ The `options` attribute can be used to set defaults for collections that will be created in the new database (_cluster only_): - `sharding`: The sharding method to use. Valid values are: `""` or `"single"`. - Setting this option to `"single"` will enable the OneShard feature in the - Enterprise Edition. + Setting this option to `"single"` enables the OneShard feature. - `replicationFactor`: Default replication factor. Special values include `"satellite"`, which will replicate the collection to every DB-Server, and `1`, which disables replication. @@ -326,8 +325,8 @@ error is thrown. For information about the naming constraints for collections, s servers holding copies take over, usually without an error being reported. - When using the *Enterprise Edition* of ArangoDB the replicationFactor - may be set to "satellite" making the collection locally joinable + The `replicationFactor` + may be set to `"satellite"`, making the collection locally joinable on every DB-Server. This reduces the number of network hops dramatically when using joins in AQL at the costs of reduced write performance on these collections. @@ -367,7 +366,7 @@ error is thrown. For information about the naming constraints for collections, s If no sharding strategy is specified, the default is `hash` for all normal collections, `enterprise-hash-smart-edge` for all smart edge collections, and `enterprise-hex-smart-vertex` for EnterpriseGraph - vertex collections (the latter two require the *Enterprise Edition* of ArangoDB). + vertex collections. Manually overriding the sharding strategy does not yet provide a benefit, but it may later in case other sharding strategies are added. @@ -379,8 +378,7 @@ error is thrown. For information about the naming constraints for collections, s collection copies the `replicationFactor`, `numberOfShards` and `shardingStrategy` properties from the specified collection (referred to as the _prototype collection_) and distributes the shards of this collection in the same way as the shards of - the other collection. In an Enterprise Edition cluster, this data co-location is - utilized to optimize queries. + the other collection. IThis data co-location is utilized to optimize queries. You need to use the same number of `shardKeys` as the prototype collection, but you can use different attributes. @@ -393,10 +391,10 @@ error is thrown. For information about the naming constraints for collections, s {{< /info >}} - `isSmart` (boolean): Whether the collection is for a SmartGraph or - EnterpriseGraph (Enterprise Edition only). This is an internal property. + EnterpriseGraph. This is an internal property. -- `isDisjoint` (boolean): Whether the collection is for a Disjoint SmartGraph - (Enterprise Edition only). This is an internal property. +- `isDisjoint` (boolean): Whether the collection is for a Disjoint SmartGraph. + This is an internal property. - `smartGraphAttribute` (string, _optional_): The attribute that is used for sharding: vertices with the same value of @@ -404,15 +402,13 @@ error is thrown. For information about the naming constraints for collections, s have this attribute set and it has to be a string. Edges derive the attribute from their connected vertices. - This feature can only be used in the *Enterprise Edition*. - -- `smartJoinAttribute` (string, _optional_): In an *Enterprise Edition* cluster, this attribute +- `smartJoinAttribute` (string, _optional_): In a cluster, this attribute determines an attribute of the collection that must contain the shard key value of the referred-to SmartJoin collection. Additionally, the sharding key for a document in this collection must contain the value of this attribute, followed by a colon, followed by the actual primary key of the document. - This feature can only be used in the *Enterprise Edition* and requires the + This feature requires the `distributeShardsLike` attribute of the collection to be set to the name of another collection. It also requires the `shardKeys` attribute of the collection to be set to a single shard key attribute, with an additional `:` @@ -1257,7 +1253,7 @@ require("@arangodb").db._version(); Returns the current license. -See [`db._getLicense()`](../../../operations/administration/license-management.md#managing-your-license). +See [`db._getLicense()`](../../../operations/administration/license-management.md#check-the-license). ### `db._setLicense(data)` @@ -1265,4 +1261,4 @@ See [`db._getLicense()`](../../../operations/administration/license-management.m Sets a license. -See [`db._setLicense(data)`](../../../operations/administration/license-management.md#initial-installation). +See [`db._setLicense(data)`](../../../operations/administration/license-management.md#apply-a-license). diff --git a/site/content/3.13/develop/operational-factors.md b/site/content/3.13/develop/operational-factors.md index b51bd8a9fb..da9ead90bb 100644 --- a/site/content/3.13/develop/operational-factors.md +++ b/site/content/3.13/develop/operational-factors.md @@ -224,9 +224,9 @@ for more information. ### SmartGraphs -SmartGraphs are an Enterprise Edition feature of ArangoDB. It enables you to -manage graphs at scale. It provides a vast performance benefit for all graphs -sharded in an ArangoDB Cluster. + +The SmartGraphs feature enables you to manage graphs at scale. +It provides a vast performance benefit for all graphs sharded in an ArangoDB Cluster. To add a SmartGraph you need a SmartGraph attribute that partitions your graph into several smaller sub-graphs. Ideally these sub-graphs follow a diff --git a/site/content/3.13/develop/satellitecollections.md b/site/content/3.13/develop/satellitecollections.md index d470d6bb2b..5aeec6ccad 100644 --- a/site/content/3.13/develop/satellitecollections.md +++ b/site/content/3.13/develop/satellitecollections.md @@ -3,10 +3,8 @@ title: SatelliteCollections menuTitle: SatelliteCollections weight: 250 description: >- - Collections synchronously replicated to all servers, available in the Enterprise Edition + Collections synchronously replicated to all servers to enable local joins --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - When doing joins in an ArangoDB cluster data has to be exchanged between different servers. Joins are executed on a Coordinator. It prepares an execution plan diff --git a/site/content/3.13/develop/smartjoins.md b/site/content/3.13/develop/smartjoins.md index fd44d18d56..e3e030aeb5 100644 --- a/site/content/3.13/develop/smartjoins.md +++ b/site/content/3.13/develop/smartjoins.md @@ -6,8 +6,6 @@ description: >- SmartJoins allow to execute co-located join operations among identically sharded collections --- -{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}} - ## Cluster joins without being smart When doing joins in an ArangoDB cluster, data has to be exchanged between different servers. diff --git a/site/content/3.13/get-started/how-to-interact-with-arangodb.md b/site/content/3.13/get-started/how-to-interact-with-arangodb.md index 204aa5a9db..b12a440ac1 100644 --- a/site/content/3.13/get-started/how-to-interact-with-arangodb.md +++ b/site/content/3.13/get-started/how-to-interact-with-arangodb.md @@ -102,7 +102,6 @@ to restore structural information with or without data. you to create instantaneous and consistent [hot backups](../operations/backup-and-restore.md#hot-backups) of the data and structural information stored in ArangoDB, without interrupting the database operations. It can be used for all ArangoDB deployment modes. -It is only available in the Enterprise Edition.