-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
task-NXDOC-2686-Document-Amazon-DocumentDB #2264
Open
NourNuxeo
wants to merge
2
commits into
2023
Choose a base branch
from
task-NXDOC-2686-Document-Amazon-DocumentDB
base: 2023
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
src/nxdoc/nuxeo-server/administration/database-configuration/documentdb.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
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. | ||
|
||
{{#> callout type='warning'}} | ||
Only DocumentDB "instance cluster" has been successfully tested with Nuxeo. | ||
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. | ||
{{/callout}} | ||
|
||
## Limitations | ||
Prosune marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Fulltext search at repository level is not supported due to `DocumentDB` limitations. Use `Elasticsearch` or `OpenSearch` for fulltext search. This requires you to disable repository fulltext search. For additional information, see the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section. | ||
- Retryable writes are not supported. You must disable this. For additional information, see the [configuration]({{page space='nxdoc' page='documentdb#configuration'}}) section. | ||
- The chosen `DocumentDB` instance type 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`: | ||
- [Differences With MongoDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/text-search.html#text-index-mongo-diff) | ||
- [Functional Differences](https://docs.aws.amazon.com/documentdb/latest/developerguide/functional-differences.html#functional-differences.with-mongodb) | ||
|
||
## Configuration | ||
|
||
To use `DocumentDB`, you need the following options: | ||
|
||
```properties | ||
nuxeo.templates=<MY_TEMPLATES>,mongodb | ||
nuxeo.vcs.fulltext.search.disabled=true | ||
nuxeo.mongodb.server=<MONGO_URL>?retryWrites=false | ||
``` | ||
|
||
For all other configuration information, please refer to the [MongoDB configuration page]({{page page='mongodb'}}). | ||
|
||
* * * | ||
|
||
<div class="row" data-equalizer data-equalize-on="medium"><div class="column medium-6">{{#> 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}}</div><div class="column medium-6"> | ||
|
||
| ||
|
||
</div></div> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested text -
DocumentDB
is compatible withMongoDB
, which allowsNuxeo
to useDocumentDB
as a backend forMongoDB
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but DocumentDB is not a backend for MongoDB. maybe to Use DocumentDB as a backend like MongoDB.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a language perspective, I would suggest the following statement:
DocumentDB
is compatible withMongoDB
. Therefore, it can be used byNuxeo
as a backend database, likeMongoDB
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my reflection is the following counter-example:
so this seems to be the best fit to me: