DOCSP-37508 - Stable API (#46)

Author: mongoKart

source/connect/stable-api.txt

@@ -0,0 +1,115 @@
+.. _pymongo-stable-api:
+
+==============
+{+stable-api+}
+==============
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+.. facet::
+   :name: genre
+   :values: reference
+ 
+.. meta::
+   :keywords: compatible, backwards, upgrade
+
+.. note::
+
+   The {+stable-api+} feature requires MongoDB Server 5.0 or later.
+
+Overview
+--------
+
+In this guide, you can learn how to specify **{+stable-api+}** compatibility when 
+connecting to a MongoDB deployment.
+
+The {+stable-api+} feature forces the server to run operations with behaviors compatible 
+with the API version you specify. When you update either your driver or server, 
+the API version changes, which can change the way these operations behave.
+Using the {+stable-api+} ensures consistent responses from the server and 
+provides long-term API stability for your application.
+
+The following sections describe how you can enable and customize {+stable-api+} for
+your MongoDB client. For more information about the {+stable-api+}, including a list of 
+the commands it supports, see :manual:`Stable API </reference/stable-api/>` in the
+MongoDB Server manual.
+
+Enable the {+stable-api+}
+-------------------------
+
+To enable the {+stable-api+}, perform the following steps:
+
+1. Construct a ``ServerApi`` object and specify a {+stable-api+} version. You must use
+   a {+stable-api+} version defined in the ``ServerApiVersion`` enum.
+#. Construct a ``MongoClient`` object, passing in your ``ServerApi`` object for the
+   ``server_api`` argument.
+
+The following code example shows how to perform this process:
+
+.. literalinclude:: /includes/connect/stable_api.py
+   :start-after: # start stable api
+   :end-before: # end stable api
+   :language: python
+   :dedent:
+
+Once you create a ``MongoClient`` instance with
+a specified API version, all commands you run with the client use the specified
+version. If you need to run commands using more than one version of the 
+{+stable-api+}, create a new ``MongoClient``.
+
+.. _stable-api-options:
+
+Configure the {+stable-api+}
+------------------------
+
+The following table describes the parameters of the ``ServerApi`` class. You can use these
+parameters to customize the behavior of the {+stable-api+}.
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 25,75
+
+   * - Option Name
+     - Description
+
+   * - strict
+     - | **Optional**. When ``True``, if you call a command that isn't part of 
+         the declared API version, the driver raises an exception.
+       |
+       | Default: **False**
+
+   * -  deprecation_errors
+     - | **Optional**. When ``True``, if you call a command that is deprecated in the 
+         declared API version, the driver raises an exception.
+       |
+       | Default: **False**
+
+The following code example shows how you can use these parameters when constructing a 
+``ServerApi`` object:
+
+.. literalinclude:: /includes/connect/stable_api.py
+   :start-after: # start stable api options
+   :end-before: # end stable api options
+   :language: python
+   :dedent:
+
+Troubleshooting
+---------------
+
+.. include:: /includes/troubleshooting/stable-api.rst
+
+API Documentation
+-----------------
+
+For more information about using the {+stable-api+} with {+driver-short+}, see the 
+following API documentation: 
+
+- `MongoClient <{+api-root+}pymongo/mongo_client.html#pymongo.mongo_client.MongoClient>`__
+- `ServerApi <{+api-root+}pymongo/server_api.html#pymongo.server_api.ServerApi>`__
+- `ServerApiVersion <{+api-root+}pymongo/server_api.html#pymongo.server_api.ServerApiVersion>`__
+

source/includes/connect/stable_api.py

@@ -0,0 +1,7 @@
+# start stable api
+
+# end stable api
+
+# start stable api options
+
+# end stable api options

source/includes/troubleshooting/stable-api.rst

@@ -0,0 +1,14 @@
+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.
+
+Provided apiStrict:true, but the command count is not in API Version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+{+driver-short+} raises this exception if your ``MongoClient`` runs an operation that
+isn't in the {+stable-api+} version you specified. To avoid this error, use an alternative
+operation supported by the specified {+stable-api+} version, or set the ``strict``
+option to ``False`` when constructing your ``ServerApi`` object.