Skip to content
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

DOCSP-34449 - Cosmos DB comparison page #938

Merged
merged 8 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ toc_landing_pages = [
"/use-cases",
"/ruby-drivers",
"/csharp-drivers",
"/other-document-dbs",
]

intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
Expand Down
79 changes: 79 additions & 0 deletions source/cosmosdb-support.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
.. _cosmosdb-compat:

:noprevnext:

=============================
Azure Cosmos DB Compatibility
=============================

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: microsoft, support

.. contents:: On this page
:local:
:backlinks: none
:depth: 1

.. figure:: /figures/cosmosdb.png
:alt: Azure Cosmos DB logo

`Azure Cosmos DB for MongoDB <https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/introduction>`__
makes it easy to use Azure Cosmos DB as if it were a MongoDB database.

Check failure on line 25 in source/cosmosdb-support.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.Simplicity] Avoid words like "easy" that imply ease of use. Raw Output: {"message": "[MongoDB.Simplicity] Avoid words like \"easy\" that imply ease of use.", "location": {"path": "source/cosmosdb-support.txt", "range": {"start": {"line": 25, "column": 10}}}, "severity": "ERROR"}
With Azure Cosmos DB, you can run the same application code and use the same drivers
and tools that you use with MongoDB.

Azure Cosmos DB for MongoDB implements MongoDB's
`Wire Protocol <https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/>`__
to allow MongoDB `drivers <https://www.mongodb.com/docs/drivers/>`__ to connect and
interact with Cosmos DB as though it were a MongoDB host. However, this
implementation has limitations, as outlined in the :ref:`cosmosdb-compat-section` section
of this page.

Version Information
-------------------

Azure Cosmos DB supports MongoDB v4.2, or MongoDB v5.0 for vCore clusters.
These versions don't support all the newer features and functionality in the versions of
MongoDB available on `MongoDB Atlas. <https://www.mongodb.com/docs/atlas/>`__

.. tip:: MongoDB Version History

To learn more about the features available in each version of MongoDB, see
`MongoDB Evolved - Version History. <https://www.mongodb.com/evolved>`__

.. _cosmosdb-compat-section:

Compatibility
-------------

As of October 2023, Azure Cosmos DB is about 32 percent compatible with the
MongoDB API.

On Azure Cosmos DB for MongoDB v4.2, the following MongoDB v4.2 features are
available in a limited capacity or are not supported at all:

- **Features**: `Text indexes <https://www.mongodb.com/docs/manual/core/indexes/index-types/index-text/>`__,
`2d indexes <https://www.mongodb.com/docs/manual/core/indexes/index-types/geospatial/2d/#std-label-2d-index>`__,
`hashed indexes <https://www.mongodb.com/docs/manual/core/indexes/index-types/index-hashed/#std-label-index-type-hashed>`__,
`case-insensitive indexes <https://www.mongodb.com/docs/manual/core/index-case-insensitive/>`__,
`sparse indexes <https://www.mongodb.com/docs/manual/core/index-sparse/>`__
- **Aggregation Stages**: ``$collStats``, ``$bucket``, ``$bucketAuto``, ``$currentOp``,
mongoKart marked this conversation as resolved.
Show resolved Hide resolved
``$indexStats``, ``$listLocalSessions``, ``$listSessions``, ``$lookup``

To learn more about Azure Cosmos DB's compatibility with MongoDB v4.2,
see Microsoft's `Azure Cosmos DB for MongoDB (4.2 server version): Supported features and syntax <https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/feature-support-42>`__
documentation.

For the most current compatibility status between Azure Cosmos DB and MongoDB, see the
`Is Cosmos DB Compatible with MongoDB Atlas? <https://www.iscosmosdbreallymongodb.com/>`__
mongoKart marked this conversation as resolved.
Show resolved Hide resolved
website.

Support
-------

MongoDB doesn't offer commercial support for Azure Cosmos DB. For help with this product,
contact `Azure Support. <https://azure.microsoft.com/en-us/support/>`__
5 changes: 4 additions & 1 deletion source/documentdb-support.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _documentdb-compat:

:noprevnext:

===============================
Amazon DocumentDB Compatibility
===============================
Expand Down Expand Up @@ -75,8 +77,9 @@ see the following AWS documentation:
- `Functional Differences: Amazon DocumentDB and MongoDB <https://docs.aws.amazon.com/documentdb/latest/developerguide/functional-differences.html>`__
- `Supported MongoDB APIs, Operations, and Data Types <https://docs.aws.amazon.com/documentdb/latest/developerguide/mongo-apis.html>`__

For the most current compatibility status between Amazon DocumentDB and MongoDB, see
For the most current compatibility status between Amazon DocumentDB and MongoDB, see the
`Is Amazon DocumentDB Compatible with MongoDB Atlas? <https://www.isdocumentdbreallymongodb.com/>`__
website.

Support
-------
Expand Down
Binary file added source/figures/cosmosdb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ See the following pages for information about other document databases' compatib
with MongoDB:

- :ref:`documentdb-compat`
- :ref:`cosmosdb-compat`

.. toctree::

Expand All @@ -168,3 +169,4 @@ with MongoDB:
Swift Driver </swift>
TypeScript </typescript>
About Compatibility Tables <about-compatibility>
Other Document Database Compatibility <other-document-dbs>
17 changes: 17 additions & 0 deletions source/other-document-dbs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
=====================================
Other Document Database Compatibility
=====================================

.. toctree::
:titlesonly:
:maxdepth: 1

/documentdb-support
/cosmosdb-support

See the following pages for information about other document databases' compatibility
with MongoDB:

- :ref:`documentdb-compat`
- :ref:`cosmosdb-compat`

mongoKart marked this conversation as resolved.
Show resolved Hide resolved
Loading