PYTHON-2536 Document Versioned API Usage #584
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ShaneHarvey
reviewed
Mar 30, 2021
pymongo/server_api.py
Outdated
|
|
||
| >>> client = MongoClient(server_api=ServerApi('1', strict=True)) | ||
| >>> server_api=ServerApi('1', strict=True) |
There was a problem hiding this comment.
server_api=ServerApi -> server_api = ServerApi
| >>> server_api=ServerApi('1', deprecation_errors=True) | ||
| >>> client = MongoClient(server_api=server_api) | ||
|
|
||
| Note that at the time of this writing, no deprecated APIs exist. |
There was a problem hiding this comment.
Do we have an example of what a deprecation would look like? Would it be an OperationFailure error?
There was a problem hiding this comment.
>>> client.db.command(command={'testDeprecationInVersion2': 1, 'apiVersion': '2', 'apiDeprecationErrors': True})
...
pymongo.errors.OperationFailure: Provided apiDeprecationErrors:true, but the command testDeprecationInVersion2 is deprecated in API Version 2, full error: {'ok': 0.0, 'errmsg': 'Provided apiDeprecationErrors:true, but the command testDeprecationInVersion2 is deprecated in API Version 2', 'code': 324, 'codeName': 'APIDeprecationError', '$clusterTime': {'clusterTime': Timestamp(1617170403, 1), 'signature': {'hash': b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00', 'keyId': 0}}, 'operationTime': Timestamp(1617170403, 1)}
There was a problem hiding this comment.
I'm reluctant to include this as an example because the server needs to be started with special testing parameters enabled to be able to see this behavior.
ShaneHarvey
approved these changes
Mar 31, 2021
| >>> server_api=ServerApi('1', deprecation_errors=True) | ||
| >>> client = MongoClient(server_api=server_api) | ||
|
|
||
| Note that at the time of this writing, no deprecated APIs exist. |
ShaneHarvey
reviewed
Mar 31, 2021
pymongo/server_api.py
Outdated
| @@ -27,6 +27,8 @@ | |||
| Declaring an API Version | |||
| ```````````````````````` | |||
|
|
|||
| .. attention: Versioned API requires MongoDB >=5.0. | |||
There was a problem hiding this comment.
Does this render correctly? Other places we use two colons:
.. attention:: ...
There was a problem hiding this comment.
fixed and confirmed that it renders correctly.
prashantmital
added a commit
that referenced
this pull request
Mar 31, 2021
(cherry picked from commit 1882e99)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.