|
| 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 | +{{#> callout type='warning'}} |
| 13 | +Only DocumentDB "instance cluster" has been successfully tested with Nuxeo. |
| 14 | +The DocumentDB [elastic cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-using-elastic-clusters.html) behaves differently from MongoDB regarding index initialization. At the moment it cannot be used by Nuxeo. |
| 15 | +{{/callout}} |
| 16 | + |
| 17 | +## Limitations |
| 18 | + |
| 19 | +- 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. |
| 20 | +- retryable writes are not supported. You need to disable this. See the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section. |
| 21 | +- the `DocumentDB` instance type chosen affects the number of open cursor at any given time. |
| 22 | + |
| 23 | +Note there are also other differences that should not affect Nuxeo. Please refer to `DocumentDB`: |
| 24 | +- [Differences With MongoDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/text-search.html#text-index-mongo-diff) |
| 25 | +- [Functional Differences](https://docs.aws.amazon.com/documentdb/latest/developerguide/functional-differences.html#functional-differences.with-mongodb) |
| 26 | + |
| 27 | +## Configuration |
| 28 | + |
| 29 | +To use `DocumentDB` you need the following options: |
| 30 | + |
| 31 | +```properties |
| 32 | +nuxeo.templates=<MY_TEMPLATES>,mongodb |
| 33 | +nuxeo.vcs.fulltext.search.disabled=true |
| 34 | +nuxeo.mongodb.server=<MONGO_URL>?retryWrites=false |
| 35 | +``` |
| 36 | + |
| 37 | +For all other configuration information, please refer to the [MongoDB configuration page]({{page page='mongodb'}}). |
| 38 | + |
| 39 | +* * * |
| 40 | + |
| 41 | +<div class="row" data-equalizer data-equalize-on="medium"><div class="column medium-6">{{#> panel heading='Related topics'}} |
| 42 | + |
| 43 | +- [Connecting Nuxeo to the Database]({{page page='connecting-nuxeo-to-the-database'}}) |
| 44 | +- [How to Estimate Volume Usage]({{page page='how-to-estimate-volume-usage'}}) |
| 45 | + |
| 46 | +{{/panel}}</div><div class="column medium-6"> |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +</div></div> |
0 commit comments