Skip to content

docs: add warning about Cosmos dB incompatibility#13350

Merged
paulpopus merged 4 commits intopayloadcms:mainfrom
Braggedtooth:patch-3
Apr 2, 2026
Merged

docs: add warning about Cosmos dB incompatibility#13350
paulpopus merged 4 commits intopayloadcms:mainfrom
Braggedtooth:patch-3

Conversation

@Braggedtooth
Copy link
Copy Markdown
Contributor

Update the docs to warn about Cosmos dB incompatibility with payload,

add warning about Cosmos dB incompatibility
Copy link
Copy Markdown
Contributor

@DanRibbens DanRibbens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could really be improved by talking about the new importable compatibilityOptions.cosmosdb option that was added recently. By spreading that option object into the adapter, devs don't need to flip individual switches and can instead have all the recommended settings applied.

@Braggedtooth
Copy link
Copy Markdown
Contributor Author

This could really be improved by talking about the new importable compatibilityOptions.cosmosdb option that was added recently. By spreading that option object into the adapter, devs don't need to flip individual switches and can instead have all the recommended settings applied.

Sure, I’ll include this! Although I see it’s already mentioned here.
Do you think it would make more sense to add the warning there about Cosmos DB’s limitations, or just update the pr to mention the compatibilityOptions.cosmosdb import as the recommended setup or both?

Happy to adjust based on what you think works best.

@paulpopus paulpopus requested a review from DanRibbens April 2, 2026 17:45
@paulpopus paulpopus dismissed DanRibbens’s stale review April 2, 2026 17:46

added the compatibility options example

@paulpopus paulpopus merged commit c4375bd into payloadcms:main Apr 2, 2026
16 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 8, 2026

🚀 This is included in version v3.82.0

milamer pushed a commit to milamer/payload that referenced this pull request Apr 20, 2026
Update the docs to warn about Cosmos dB incompatibility with payload,
<!--

Thank you for the PR! Please go through the checklist below and make
sure you've completed all the steps.

Please review the
[CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md)
document in this repository if you haven't already.

The following items will ensure that your PR is handled as smoothly as
possible:

- PR Title must follow conventional commits format. For example, `feat:
my new feature`, `fix(plugin-seo): my fix`.
- Minimal description explained as if explained to someone not
immediately familiar with the code.
- Provide before/after screenshots or code diffs if applicable.
- Link any related issues/discussions from GitHub or Discord.
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Fixes #

-->

---------

Co-authored-by: Paul Popus <paul@payloadcms.com>
Co-authored-by: Paul <paul@nouance.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants