Skip to content

Commit 1fbc0bb

Browse files
committed
NXDOC-2686: Document Amazon DocumentDB support
1 parent bccef8c commit 1fbc0bb

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

src/nxdoc/nuxeo-server/administration/database-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ This takes two steps:
163163
* [MySQL]({{page page='mysql'}})
164164
* [MariaDB]({{page page='mariadb'}})
165165
* [MongoDB]({{page page='mongodb'}})
166+
* [DocumentDB]({{page page='documentdb'}})
166167
2. [Connect Nuxeo to the database]({{page page='connecting-nuxeo-to-the-database'}}).
167168

168169
 
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Amazon DocumentDB
3+
labels:
4+
- database
5+
- documentdb
6+
tree_item_index: 700
7+
8+
---
9+
`DocumentDB` is compatible with `MongoDB`, therefore, it can be used by `Nuxeo` like a `MongoDB` backend,
10+
but there are limitations.
11+
12+
## Limitations
13+
14+
- 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.
15+
- retryable writes are not supported. You need to disable this. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section.
16+
- the `DocumentDB` instance type chosen affects the number of open cursor at any given time.
17+
18+
Note there are also other differences that should not affect Nuxeo. Please refer to `DocumentDB`.
19+
20+
## Configuration
21+
22+
To use `DocumentDB` you need the following options:
23+
24+
```properties
25+
nuxeo.templates=<MY_TEMPLATES>,mongodb
26+
nuxeo.vcs.fulltext.search.disabled=true
27+
nuxeo.mongodb.server=<MONGO_URL>?retryWrites=false
28+
```
29+
30+
For all other configuration information, please refer to the [MongoDB configuration page]({{page page='mongodb'}}).
31+
32+
* * *
33+
34+
<div class="row" data-equalizer data-equalize-on="medium"><div class="column medium-6">{{#> panel heading='Related topics'}}
35+
36+
- [Connecting Nuxeo to the Database]({{page page='connecting-nuxeo-to-the-database'}})
37+
- [How to Estimate Volume Usage]({{page page='how-to-estimate-volume-usage'}})
38+
39+
{{/panel}}</div><div class="column medium-6">
40+
41+
&nbsp;
42+
43+
</div></div>

0 commit comments

Comments
 (0)