From 1fbc0bb237f1bafa3080d3ac0505c8ee59f5f860 Mon Sep 17 00:00:00 2001 From: Nour AL KOTOB Date: Mon, 8 Jul 2024 18:56:21 +0200 Subject: [PATCH] NXDOC-2686: Document Amazon DocumentDB support --- .../administration/database-configuration.md | 1 + .../database-configuration/documentdb.md | 43 +++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md diff --git a/src/nxdoc/nuxeo-server/administration/database-configuration.md b/src/nxdoc/nuxeo-server/administration/database-configuration.md index 0b5e606ba..d3856aed5 100644 --- a/src/nxdoc/nuxeo-server/administration/database-configuration.md +++ b/src/nxdoc/nuxeo-server/administration/database-configuration.md @@ -163,6 +163,7 @@ This takes two steps: * [MySQL]({{page page='mysql'}}) * [MariaDB]({{page page='mariadb'}}) * [MongoDB]({{page page='mongodb'}}) + * [DocumentDB]({{page page='documentdb'}}) 2. [Connect Nuxeo to the database]({{page page='connecting-nuxeo-to-the-database'}}).   diff --git a/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md b/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md new file mode 100644 index 000000000..5ac517f5d --- /dev/null +++ b/src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md @@ -0,0 +1,43 @@ +--- +title: Amazon DocumentDB +labels: + - database + - documentdb +tree_item_index: 700 + +--- +`DocumentDB` is compatible with `MongoDB`, therefore, it can be used by `Nuxeo` like a `MongoDB` backend, +but there are limitations. + +## Limitations + +- fulltext search at repository level using `DocumentDB` is not supported due to `DocumentDB` limitations. You need to rely on `Elasticsearch` or `OpenSearch`. This requires to disable repository fulltext search. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section. +- retryable writes are not supported. You need to disable this. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section. +- the `DocumentDB` instance type chosen affects the number of open cursor at any given time. + +Note there are also other differences that should not affect Nuxeo. Please refer to `DocumentDB`. + +## Configuration + +To use `DocumentDB` you need the following options: + +```properties +nuxeo.templates=,mongodb +nuxeo.vcs.fulltext.search.disabled=true +nuxeo.mongodb.server=?retryWrites=false +``` + +For all other configuration information, please refer to the [MongoDB configuration page]({{page page='mongodb'}}). + +* * * + +
{{#> panel heading='Related topics'}} + +- [Connecting Nuxeo to the Database]({{page page='connecting-nuxeo-to-the-database'}}) +- [How to Estimate Volume Usage]({{page page='how-to-estimate-volume-usage'}}) + +{{/panel}}
+ +  + +