diff --git a/pymongo/collection.py b/pymongo/collection.py index afaef480c..008838862 100644 --- a/pymongo/collection.py +++ b/pymongo/collection.py @@ -2553,13 +2553,15 @@ class Collection(common.BaseObject, Generic[_DocumentType]): pipeline stages are valid after a ``$changeStream`` stage, see the MongoDB documentation on change streams for the supported stages. - `full_document` (optional): The fullDocument to pass as an option - to the ``$changeStream`` stage. Allowed values: 'updateLookup'. - When set to 'updateLookup', the change notification for partial - updates will include both a delta describing the changes to the - document, as well as a copy of the entire document that was - changed from some time after the change occurred. - - `full_document_before_change`: Allowed values: `whenAvailable` and `required`. Change events - may now result in a `fullDocumentBeforeChange` response field. + to the ``$changeStream`` stage. Allowed values: 'updateLookup', + 'whenAvailable', 'required'. When set to 'updateLookup', the + change notification for partial updates will include both a delta + describing the changes to the document, as well as a copy of the + entire document that was changed from some time after the change + occurred. + - `full_document_before_change`: Allowed values: 'whenAvailable' + and 'required'. Change events may now result in a + 'fullDocumentBeforeChange' response field. - `resume_after` (optional): A resume token. If provided, the change stream will start returning changes that occur directly after the operation specified in the resume token. A resume token diff --git a/pymongo/database.py b/pymongo/database.py index d3746b0c5..fcf1f3e36 100644 --- a/pymongo/database.py +++ b/pymongo/database.py @@ -593,13 +593,15 @@ class Database(common.BaseObject, Generic[_DocumentType]): pipeline stages are valid after a ``$changeStream`` stage, see the MongoDB documentation on change streams for the supported stages. - `full_document` (optional): The fullDocument to pass as an option - to the ``$changeStream`` stage. Allowed values: 'updateLookup', 'whenAvailable', 'required'. - When set to 'updateLookup', the change notification for partial - updates will include both a delta describing the changes to the - document, as well as a copy of the entire document that was - changed from some time after the change occurred. - - `full_document_before_change`: Allowed values: `whenAvailable` and `required`. Change events - may now result in a `fullDocumentBeforeChange` response field. + to the ``$changeStream`` stage. Allowed values: 'updateLookup', + 'whenAvailable', 'required'. When set to 'updateLookup', the + change notification for partial updates will include both a delta + describing the changes to the document, as well as a copy of the + entire document that was changed from some time after the change + occurred. + - `full_document_before_change`: Allowed values: 'whenAvailable' + and 'required'. Change events may now result in a + 'fullDocumentBeforeChange' response field. - `resume_after` (optional): A resume token. If provided, the change stream will start returning changes that occur directly after the operation specified in the resume token. A resume token diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py index 2a4b8a1d9..4b20c2e5b 100644 --- a/pymongo/mongo_client.py +++ b/pymongo/mongo_client.py @@ -918,13 +918,15 @@ class MongoClient(common.BaseObject, Generic[_DocumentType]): pipeline stages are valid after a ``$changeStream`` stage, see the MongoDB documentation on change streams for the supported stages. - `full_document` (optional): The fullDocument to pass as an option - to the ``$changeStream`` stage. Allowed values: 'updateLookup'. - When set to 'updateLookup', the change notification for partial - updates will include both a delta describing the changes to the - document, as well as a copy of the entire document that was - changed from some time after the change occurred. - - `full_document_before_change`: Allowed values: `whenAvailable` and `required`. Change events - may now result in a `fullDocumentBeforeChange` response field. + to the ``$changeStream`` stage. Allowed values: 'updateLookup', + 'whenAvailable', 'required'. When set to 'updateLookup', the + change notification for partial updates will include both a delta + describing the changes to the document, as well as a copy of the + entire document that was changed from some time after the change + occurred. + - `full_document_before_change`: Allowed values: 'whenAvailable' + and 'required'. Change events may now result in a + 'fullDocumentBeforeChange' response field. - `resume_after` (optional): A resume token. If provided, the change stream will start returning changes that occur directly after the operation specified in the resume token. A resume token