DOCSP-39194 - Specify MDB Server (#93)

mongoKart · web-flow · commit 865a6cc3b52c · 2024-06-11T09:34:09.000-05:00
diff --git a/snooty.toml b/snooty.toml
@@ -25,6 +25,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
 driver-short = "PyMongo"
 driver-long = "PyMongo, the MongoDB synchronous Python driver,"
 language = "Python"
+mdb-server = "MongoDB Server"
 mongo-community = "MongoDB Community Edition"
 mongo-enterprise = "MongoDB Enterprise Edition"
 docs-branch = "master"                                                       # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
diff --git a/source/connect/connection-targets.txt b/source/connect/connection-targets.txt
@@ -41,7 +41,7 @@ Then, pass your connection string to the ``MongoClient`` constructor.
    to retrieve your connection string.
 
 When you connect to Atlas, we recommend using the {+stable-api+} client option to avoid
-breaking changes when Atlas upgrades to a new version of MongoDB Server.
+breaking changes when Atlas upgrades to a new version of {+mdb-server+}.
 To learn more about the {+stable-api+} feature, see the :ref:`{+stable-api+} page
 <pymongo-stable-api>`.
 
diff --git a/source/connect/stable-api.txt b/source/connect/stable-api.txt
@@ -19,7 +19,7 @@
 
 .. note::
 
-   The {+stable-api+} feature requires MongoDB Server 5.0 or later.
+   The {+stable-api+} feature requires {+mdb-server+} 5.0 or later.
 
 Overview
 --------
diff --git a/source/connect/tls.txt b/source/connect/tls.txt
@@ -57,7 +57,7 @@ option to ``True``. You can do this in two ways: by passing an argument to the
 
    To learn more about the SRV connection format, see
    :manual:`SRV Connection Format </reference/connection-string/#srv-connection-format>`
-   in the MongoDB Server documentation.
+   in the {+mdb-server+} documentation.
 
 .. _pymongo-specify-ca-file:
 
@@ -101,7 +101,7 @@ example:
 
    python -m pip install pymongo[ocsp]
 
-The certificate-validation process varies depending on the version of MongoDB Server you're
+The certificate-validation process varies depending on the version of {+mdb-server+} you're
 connecting to:
 
 - **MongoDB v4.4 or later:** The server staples a
diff --git a/source/databases-collections.txt b/source/databases-collections.txt
@@ -30,7 +30,7 @@ MongoDB organizes data into a hierarchy of the following levels:
 - **Documents**: Contain literal data such as string, numbers, dates, and other embedded documents.
 
 For more information about document field types and structure, see the
-:manual:`Documents </core/document/>` guide in the MongoDB Server manual.
+:manual:`Documents </core/document/>` guide in the {+mdb-server+} manual.
 
 .. TODO: Add a diagram here
 
@@ -202,7 +202,7 @@ MongoDB Server manual:
 Tag Sets
 ~~~~~~~~
 
-In MongoDB Server, you can apply key-value :manual:`tags
+In {+mdb-server+}, you can apply key-value :manual:`tags
 </core/read-preference-tags/>` to replica-set
 members according to any criteria you choose. You can then use
 those tags to target one or more members for a read operation.
diff --git a/source/faq.txt b/source/faq.txt
@@ -149,7 +149,7 @@ any ongoing operations by using this method. The driver closes these
 sockets only when the process completes.
 
 For more information, see the :manual:`<administration/connection-pool-overview/>`
-in the MongoDB Server documentation.
+in the {+mdb-server+} documentation.
 
 Why Does {+driver-short+} Add an _id Field to All My Documents?
 ------------------------------------------------------
diff --git a/source/includes/troubleshooting/connection-targets.rst b/source/includes/troubleshooting/connection-targets.rst
@@ -1,7 +1,7 @@
 Server Reports Wire Version X, PyMongo Requires Y
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If you try to connect to MongoDB Server v3.4 or earlier,
+If you try to connect to {+mdb-server+} v3.4 or earlier,
 {+driver-short+} might raise the following error:
 
 .. code-block:: 
@@ -10,7 +10,7 @@ If you try to connect to MongoDB Server v3.4 or earlier,
 
 This occurs when the driver version is too new for the server it's connecting to.
 To resolve this issue, upgrade your MongoDB deployment to v3.6 or later, or downgrade to
-{+driver-short+} v3.x, which supports MongoDB Server v2.6 and later.
+{+driver-short+} v3.x, which supports {+mdb-server+} v2.6 and later.
 
 AutoReconnect
 ~~~~~~~~~~~~~
diff --git a/source/includes/troubleshooting/stable-api.rst b/source/includes/troubleshooting/stable-api.rst
@@ -3,7 +3,7 @@ Unrecognized field 'apiVersion' on server
 
 {+driver-short+} raises this exception if you specify an API version and connect to a
 MongoDB server that doesn't support the {+stable-api+}. Ensure you're connecting to a
-deployment running MongoDB Server v5.0 or later.
+deployment running {+mdb-server+} v5.0 or later.
 
 Provided apiStrict:true, but the command count is not in API Version
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/source/includes/troubleshooting/tls.rst b/source/includes/troubleshooting/tls.rst
@@ -109,7 +109,7 @@ see errors similar to the following messages:
    SSL handshake failed: localhost:27017: [SSL: SSLV3_ALERT_HANDSHAKE_FAILURE] sslv3 alert handshake failure (_ssl.c:997)
    SSL handshake failed: localhost:27017: EOF occurred in violation of protocol (_ssl.c:997)
 
-The MongoDB Server logs might also show the following error:
+The {+mdb-server+} logs might also show the following error:
 
 .. code-block:: python
 
@@ -121,5 +121,5 @@ with MongoDB versions earlier than v4.0. To resolve this issue, try one or more
 following steps:
 
 - Downgrade Python to v3.9 or earlier
-- Upgrade MongoDB Server to v4.2 or later
+- Upgrade {+mdb-server+} to v4.2 or later
 - Install {+driver-short+} with the :ref:`OCSP <pymongo-disable-ocsp>` option, which relies on PyOpenSSL
diff --git a/source/index.txt b/source/index.txt
@@ -136,7 +136,7 @@ Compatibility
 -------------
 
 For compatibility tables that show the recommended {+driver-short+}
-version to use for specific Python and MongoDB Server versions, see the
+version to use for specific Python and {+mdb-server+} versions, see the
 :ref:`pymongo-compatibility` section.
 
 API Documentation
diff --git a/source/indexes/clustered-index.txt b/source/indexes/clustered-index.txt
@@ -49,4 +49,4 @@ a new ``movie_reviews`` collection:
 For more information, see the :manual:`Clustered Index
 </reference/method/db.createCollection/#std-label-db.createCollection.clusteredIndex>`
 and :manual:`Clustered Collections </core/clustered-collections>` sections in
-the MongoDB Server manual.
+the {+mdb-server+} manual.
diff --git a/source/indexes/compound-index.txt b/source/indexes/compound-index.txt
@@ -50,4 +50,4 @@ the preceding code example:
    :end-before: end-index-compound-query
 
 For more information, see :manual:`Compound Indexes </core/index-compound>` in
-the MongoDB Server manual.
+the {+mdb-server+} manual.
diff --git a/source/indexes/multikey-index.txt b/source/indexes/multikey-index.txt
@@ -50,4 +50,4 @@ The following is an example of a query that uses the index created in the preced
 
 Multikey indexes behave differently from other indexes in terms of query coverage, index bound computation, and
 sort behavior. To learn more about multikey indexes, including a discussion of their behavior and limitations,
-see the :manual:`Multikey Indexes </core/index-multikey>` guide in the MongoDB Server manual.
+see the :manual:`Multikey Indexes </core/index-multikey>` guide in the {+mdb-server+} manual.
diff --git a/source/indexes/single-field-index.txt b/source/indexes/single-field-index.txt
@@ -56,4 +56,4 @@ The following is an example of a query that is covered by the index created in t
    :end-before: end-index-single-query
 
 To learn more, see :manual:`Single Field Indexes
-</core/index-single>` in the MongoDB Server manual.
+</core/index-single>` in the {+mdb-server+} manual.
diff --git a/source/indexes/text-index.txt b/source/indexes/text-index.txt
@@ -76,4 +76,4 @@ fields:
 
 For more information, see :manual:`Compound Text Index Restrictions
 </core/index-text/#std-label-text-index-compound>` and
-:manual:`Text Indexes </core/index-text>` in the MongoDB Server manual.
+:manual:`Text Indexes </core/index-text>` in the {+mdb-server+} manual.
diff --git a/source/indexes/unique-index.txt b/source/indexes/unique-index.txt
@@ -46,7 +46,7 @@ The following example creates a descending unique index on the ``theaterId`` fie
    :end-before: end-index-unique
 
 For more information, see the :manual:`Unique Indexes </core/index-unique>` guide
-in the MongoDB Server manual.
+in the {+mdb-server+} manual.
 
 Troubleshooting
 ---------------
diff --git a/source/indexes/wildcard-index.txt b/source/indexes/wildcard-index.txt
@@ -43,4 +43,4 @@ values of the ``location`` field, including values nested in subdocuments and ar
    :end-before: end-index-wildcard
 
 For more information, see the :manual:`Wildcard Indexes</core/index-wildcard>`
-page in the MongoDB Server manual.
+page in the {+mdb-server+} manual.
diff --git a/source/read/change-streams.txt b/source/read/change-streams.txt
@@ -21,7 +21,7 @@ Overview
 --------
 
 In this guide, you can learn how to use a **change stream** to monitor real-time
-changes to your database. A change stream is a MongoDB Server feature that
+changes to your database. A change stream is a {+mdb-server+} feature that
 allows your application to subscribe to data changes on a collection, database,
 or deployment.
 
@@ -103,7 +103,7 @@ that records only update operations:
 
 To learn more about modifying your change stream output, see the
 :manual:`Modify Change Stream Output
-</changeStreams/#modify-change-stream-output>` section in the MongoDB Server
+</changeStreams/#modify-change-stream-output>` section in the {+mdb-server+}
 manual.
 
 Modify ``watch()`` Behavior
@@ -165,7 +165,7 @@ of ``watch()``:
          empty batch. Defaults to 1000 milliseconds.
 
    * - ``show_expanded_events``
-     - | Starting in MongoDB Server v6.0, change streams support change notifications
+     - | Starting in {+mdb-server+} v6.0, change streams support change notifications
          for Data Definition Language (DDL) events, such as the ``createIndexes`` and ``dropIndexes`` events. To
          include expanded events in a change stream, create the change stream
          cursor and set this parameter to ``True``.
@@ -244,13 +244,13 @@ With the change stream application running, updating a document in the
 
 To learn more about pre-images and post-images, see 
 :manual:`Change Streams with Document Pre- and Post-Images </changeStreams#change-streams-with-document-pre--and-post-images>` 
-in the MongoDB Server manual.
+in the {+mdb-server+} manual.
 
 Additional Information
 ----------------------
 
 To learn more about change streams, see :manual:`Change Streams
-</changeStreams>` in the MongoDB Server manual.
+</changeStreams>` in the {+mdb-server+} manual.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/read/cursors.txt b/source/read/cursors.txt
@@ -123,7 +123,7 @@ of a replica-set member:
    :emphasize-lines: 8
 
 To learn more about tailable cursors, see the :manual:`Tailable Cursors guide
-</core/tailable-cursors/>` in the MongoDB Server manual.
+</core/tailable-cursors/>` in the {+mdb-server+} manual.
 
 Troubleshooting
 ---------------
diff --git a/source/read/project.txt b/source/read/project.txt
@@ -137,7 +137,7 @@ Additional Information
 ----------------------
 
 To learn more about projections, see the :manual:`Project Fields guide
-</tutorial/project-fields-from-query-results/>` in the MongoDB Server Manual.
+</tutorial/project-fields-from-query-results/>` in the {+mdb-server+} manual.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/read/specify-a-query.txt b/source/read/specify-a-query.txt
@@ -95,7 +95,7 @@ in your query filter. The following is a list of common comparison operators:
 - ``$ne``: Not equal
 
 To view a full list of comparison operators, see the :manual:`Comparison Query Operators
-</reference/operator/query-comparison/>` guide in the MongoDB Server manual.
+</reference/operator/query-comparison/>` guide in the {+mdb-server+} manual.
 
 The following example specifies a comparison operator in a query filter as a
 parameter to the ``find()`` method. The code returns all documents with a
@@ -127,7 +127,7 @@ more sets of expressions. The following is a list of logical operators:
 - ``$not``, which returns all documents that *do not* match the expression
 
 To learn more about logical operators, see the :manual:`Logical Query Operators
-</reference/operator/query-logical/>` guide in the MongoDB Server manual.
+</reference/operator/query-logical/>` guide in the {+mdb-server+} manual.
 
 The following example specifies a logical operator in a query filter as a
 parameter to the ``find()`` method. The code returns all documents with a
@@ -159,7 +159,7 @@ array field. The following is a list of available array operators:
 - ``$size``, which returns all documents with arrays of a specified size
 
 To learn more about array operators, see the :manual:`Array Query Operators
-</reference/operator/query-array/>` guide in the MongoDB Server manual.
+</reference/operator/query-array/>` guide in the {+mdb-server+} manual.
 
 The following example specifies an array operator in a query filter as a
 parameter to the ``find()`` method. The code returns all documents with a
@@ -184,7 +184,7 @@ Element Operators
 Element operators query data based on the presence or type of a field.
 
 To learn more about element operators, see the :manual:`Element Query Operators
-</reference/operator/query-element/>` guide in the MongoDB Server manual.
+</reference/operator/query-element/>` guide in the {+mdb-server+} manual.
 
 The following example specifies an element operator in a query filter as a
 parameter to the ``find()`` method. The code returns all documents that have a
@@ -218,7 +218,7 @@ The following is a list of common evaluation operators:
   returns documents where the remainder is a specified value
 
 To view a full list of evaluation operators, see the :manual:`Evaluation Query Operators
-</reference/operator/query-evaluation/>` guide in the MongoDB Server manual.
+</reference/operator/query-evaluation/>` guide in the {+mdb-server+} manual.
 
 The following example specifies an evaluation operator in a query filter as a
 parameter to the ``find()`` method. The code uses a regular expression to return
@@ -242,7 +242,7 @@ Additional Information
 ----------------------
 
 To learn more about querying documents, see the :manual:`Query Documents
-</tutorial/query-documents/>` guide in the MongoDB Server manual.
+</tutorial/query-documents/>` guide in the {+mdb-server+} manual.
 
 To learn more about retrieving documents with PyMongo, see
 :ref:`pymongo-retrieve`.
diff --git a/source/security/enterprise-authentication.txt b/source/security/enterprise-authentication.txt
@@ -205,7 +205,7 @@ MONGODB-OIDC
 
 .. important::
 
-   The MONGODB-OIDC authentication mechanism requires MongoDB v7.0 or later running
+   The MONGODB-OIDC authentication mechanism requires {+mdb-server+} v7.0 or later running
    on a Linux platform.
 
 {+driver-short+} supports OIDC authentication for **workload identities**. A workload
@@ -218,7 +218,7 @@ authenticate to various platforms.
 For more information about the MONGODB-OIDC authentication mechanism, see
 :manual:`OpenID Connect Authentication </core/security-oidc/>` and
 :manual:`MongoDB Server Parameters </reference/parameters/#mongodb-parameter-param.oidcIdentityProviders>`
-in the MongoDB Server manual.
+in the {+mdb-server+} manual.
 
 .. _pymongo-mongodb-oidc-azure-imds:
 
@@ -460,4 +460,4 @@ To learn more about using enterprise authentication mechanisms with {+driver-sho
 see the following API documentation:
 
 - `MongoClient <{+api-root+}pymongo/mongo_client.html#pymongo.mongo_client.MongoClient>`__
-- `OIDCCallback <{+api-root+}pymongo/auth_oidc.html#pymongo.auth_oidc.OIDCCallback>`__
+- `OIDCCallback <{+api-root+}pymongo/auth_oidc.html#pymongo.auth_oidc.OIDCCallback>`__
diff --git a/source/security/in-use-encryption.txt b/source/security/in-use-encryption.txt
@@ -55,7 +55,7 @@ Queryable Encryption
 --------------------
 
 Queryable Encryption is the next-generation in-use encryption feature,
-first introduced as a preview feature in MongoDB Server version 6.0 and
+first introduced as a preview feature in {+mdb-server+} version 6.0 and
 as a generally available (GA) feature in MongoDB 7.0. Queryable
 Encryption supports searching encrypted fields for equality and encrypts
 each value uniquely.
diff --git a/source/troubleshooting.txt b/source/troubleshooting.txt
@@ -251,7 +251,7 @@ subdocument that exactly matches the subdocument in the collection.
    
    For more information about subdocument matching, see the
    `Query on Embedded/Nested Documents <https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/>`__
-   guide in the MongoDB Server documentation.
+   guide in the {+mdb-server+} documentation.
 
 Cursors
 -------
diff --git a/source/upgrade.txt b/source/upgrade.txt
@@ -31,7 +31,7 @@ when you upgrade to a new version of {+driver-short+}.
 
 Before you upgrade, perform the following actions:
 
-- Ensure the new {+driver-short+} version is compatible with the MongoDB Server versions
+- Ensure the new {+driver-short+} version is compatible with the {+mdb-server+} versions
   your application connects to and the Python version your
   application runs on. For version compatibility information, see the
   :ref:`{+driver-short+} Compatibility <pymongo-compatibility>`
@@ -162,5 +162,5 @@ Version 4.2 Breaking Changes
 - The ``estimated_document_count()`` method always uses the count command.
   This command is not available in the Stable API in MongoDB versions 5.0.0 through 5.0.8.
   If you use the ``estimated_document_count()`` method with the Stable API, you must
-  either upgrade to MongoDB Server v5.0.9 or later, or set the
+  either upgrade to {+mdb-server+} v5.0.9 or later, or set the
   ``pymongo.server_api.ServerApi.strict`` option to ``False``.
diff --git a/source/work-with-indexes.txt b/source/work-with-indexes.txt
@@ -60,7 +60,7 @@ planning.
 
 For more information about designing your data model and choosing indexes appropriate for your application, see the
 :manual:`Data Modeling and Indexes </core/data-model-operations/#indexes>` guide
-in the MongoDB Server manual.
+in the {+mdb-server+} manual.
 
 Sample Data
 ~~~~~~~~~~~
@@ -139,7 +139,7 @@ Additional Information
 ----------------------
 
 To learn more about indexes in MongoDB, see the :manual:`Indexes </indexes>`
-guide in the MongoDB Server manual.
+guide in the {+mdb-server+} manual.
 
 API Documentation
 ~~~~~~~~~~~~~~~~~
diff --git a/source/write/bulk-write.txt b/source/write/bulk-write.txt
@@ -76,7 +76,7 @@ the following arguments:
 - A **query filter** that specifies the criteria used to match documents in your collection
 - The update operation you want to perform. For more information about update
   operations, see the :manual:`Field Update Operators
-  </reference/operator/update-field/>` guide in the MongoDB Server manual.
+  </reference/operator/update-field/>` guide in the {+mdb-server+} manual.
 
 ``UpdateOne`` updates *the first* document that matches your query filter.
 
@@ -216,14 +216,14 @@ the bulk write operation.
    * - ``comment``
      - | A comment to attach to the operation. For more information, see the :manual:`delete command
          fields </reference/command/delete/#command-fields>` guide in the
-         MongoDB Server manual.
+         {+mdb-server+} manual.
 
    * - ``let``
      - | A map of parameter names and values. Values must be constant or closed
          expressions that don't reference document fields. For more information,
          see the :manual:`let statement
          </reference/command/delete/#std-label-delete-let-syntax>` in the
-         MongoDB Server manual.
+         {+mdb-server+} manual.
 
 The following example calls the ``bulk_write()`` method from the preceding example, with the ``ordered`` option set
 to ``False``:
diff --git a/source/write/delete.txt b/source/write/delete.txt
diff --git a/source/write/gridfs.txt b/source/write/gridfs.txt
diff --git a/source/write/insert.txt b/source/write/insert.txt
diff --git a/source/write/replace.txt b/source/write/replace.txt
diff --git a/source/write/update.txt b/source/write/update.txt
