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

Backports DOCSP-32271 to v4.11 #798

Merged
merged 1 commit into from
Sep 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
11 changes: 11 additions & 0 deletions source/fundamentals/connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ learn:
- :ref:`How to Enable TLS on a Connection <node-connect-tls>`
- :atlas:`How to Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`

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

.. |page-topic| replace:: use the {+driver-short+}
.. |link-topic-ing| replace:: using drivers to connect

.. |atlas-url| replace:: :atlas:`Connect Your Application </driver-connection>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

For information about authenticating to MongoDB,
see :ref:`node-authentication-mechanisms` and
:ref:`node-enterprise-authentication-mechanisms`.
11 changes: 11 additions & 0 deletions source/fundamentals/crud.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ Some operations combine aspects of read and write operations. See our
guide on :doc:`compound operations </fundamentals/crud/compound-operations>`
to learn more about these hybrid methods.

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

.. |page-topic| replace:: perform CRUD operations
.. |link-topic-ing| replace:: performing CRUD operations in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

.. note::

If you are looking for additional resources for learning topics related
Expand Down
11 changes: 11 additions & 0 deletions source/fundamentals/crud/read-operations/retrieve.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ matching data is inserted.

.. include:: /includes/access-cursor-note.rst

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

.. |page-topic| replace:: perform read operations
.. |link-topic-ing| replace:: performing read operations in the Atlas UI

.. |atlas-url| replace:: :atlas:`View, Filter, and Sort Documents </atlas-ui/documents/#view--filter--and-sort-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Find
----

Expand Down
4 changes: 4 additions & 0 deletions source/includes/fact-atlas-compatible.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
You can use the {+driver-short+} to connect and |page-topic| for
deployments hosted in the following environments:

.. include:: /includes/fact-environments.rst
2 changes: 2 additions & 0 deletions source/includes/fact-atlas-link.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To learn more about |link-topic-ing| for deployments hosted in MongoDB
Atlas, see |atlas-url|.
7 changes: 7 additions & 0 deletions source/includes/fact-environments.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- `MongoDB Atlas
<https://www.mongodb.com/docs/atlas>`__: The fully
managed service for MongoDB deployments in the cloud
- :ref:`MongoDB Enterprise <install-mdb-enterprise>`: The
subscription-based, self-managed version of MongoDB
- :ref:`MongoDB Community <install-mdb-community-edition>`: The
source-available, free-to-use, and self-managed version of MongoDB
4 changes: 4 additions & 0 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ installing the {+driver-short+}, see
:ref:`Download and Install <node-quick-start-download-and-install>` in the
Quick Start guide.

You can connect using the {+driver-short+} for
deployments hosted in the following environments:

.. include:: /includes/fact-environments.rst

Quick Start
-----------
Expand Down
11 changes: 11 additions & 0 deletions source/quick-reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ Quick Reference
This page shows the driver syntax for several MongoDB commands and links to
their related reference and API documentation.

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

.. |page-topic| replace:: execute commands
.. |link-topic-ing| replace:: performing common CRUD operations in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

.. list-table::
:header-rows: 1
:widths: 25 75
Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/find.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ documents using one of the following :ref:`cursor methods <cursor-methods>`:

If no documents match the query, ``find()`` returns an empty cursor.

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

.. |page-topic| replace:: use the ``find()`` method
.. |link-topic-ing| replace:: finding documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#view--filter--and-sort-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/findOne.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ in the ``options`` object passed as the second parameter of the
``findOne`` method. For detailed reference documentation, see
`collection.findOne() <{+api+}/classes/Collection.html#findOne>`__.

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

.. |page-topic| replace:: use the ``findOne()`` method
.. |link-topic-ing| replace:: finding documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#view--filter--and-sort-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down
11 changes: 11 additions & 0 deletions source/usage-examples/insertOne.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ If the operation successfully inserts a document, it appends an
``insertedId`` field to the object passed in the method call, and sets the
value of the field to the ``_id`` of the inserted document.

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

.. |page-topic| replace:: use the ``insertOne()`` method
.. |link-topic-ing| replace:: inserting documents in the Atlas UI

.. |atlas-url| replace:: :atlas:`Create, View, Update, and Delete Documents </atlas-ui/documents/#insert-documents>`

.. include:: /includes/fact-atlas-compatible.rst
.. include:: /includes/fact-atlas-link.rst

Example
-------

Expand Down
Loading