Toggle table of contents sidebar
change_stream – Watch changes on a collection, database, or cluster¶
Watch changes on a collection, a database, or the entire cluster.
The internal abstract base class for change stream cursors.
Should not be called directly by application developers. Use pymongo.asynchronous.collection.AsyncCollection.watch(), pymongo.asynchronous.database.AsyncDatabase.watch(), or pymongo.asynchronous.mongo_client.AsyncMongoClient.watch() instead.
Added in version 3.6.
target (Union[AsyncMongoClient[_DocumentType], AsyncDatabase[_DocumentType], AsyncCollection[_DocumentType]])
pipeline (Optional[_Pipeline])
full_document (Optional[str])
resume_after (Optional[Mapping[str, Any]])
max_await_time_ms (Optional[int])
batch_size (Optional[int])
collation (Optional[_CollationIn])
start_at_operation_time (Optional[Timestamp])
session (Optional[AsyncClientSession])
start_after (Optional[Mapping[str, Any]])
comment (Optional[Any])
full_document_before_change (Optional[str])
show_expanded_events (Optional[bool])
Does this cursor have the potential to return more data?
Added in version 3.8.
Close this AsyncChangeStream.
None
Advance the cursor.
This method blocks until the next change document is returned or an unrecoverable error is raised. This method is used when iterating over all changes in the cursor. For example:
try:
resume_token = None
pipeline = [{'$match': {'operationType': 'insert'}}]
async with await db.collection.watch(pipeline) as stream:
async for insert_change in stream:
print(insert_change)
resume_token = stream.resume_token
except pymongo.errors.PyMongoError:
# The AsyncChangeStream encountered an unrecoverable error or the
# resume attempt failed to recreate the cursor.
if resume_token is None:
# There is no usable resume token because there was a
# failure during AsyncChangeStream initialization.
logging.error('...')
else:
# Use the interrupted AsyncChangeStream's resume token to create
# a new AsyncChangeStream. The new stream will continue from the
# last seen insert change without missing any events.
async with await db.collection.watch(
pipeline, resume_after=resume_token) as stream:
async for insert_change in stream:
print(insert_change)
Raises StopIteration if this AsyncChangeStream is closed.
_DocumentType
The cached resume token that will be used to resume after the most recently returned change.
Added in version 3.9.
Advance the cursor without blocking indefinitely.
This method returns the next change document without waiting indefinitely for the next change. For example:
async with await db.collection.watch() as stream:
while stream.alive:
change = await stream.try_next()
# Note that the AsyncChangeStream's resume token may be updated
# even when no changes are returned.
print("Current resume token: %r" % (stream.resume_token,))
if change is not None:
print("Change document: %r" % (change,))
continue
# We end up here when there are no recent changes.
# Sleep for a while before trying again to avoid flooding
# the server with getMore requests when no changes are
# available.
asyncio.sleep(10)
If no change document is cached locally then this method runs a single getMore command. If the getMore yields any documents, the next document is returned, otherwise, if the getMore returns no documents (because there have been no changes) then None is returned.
The next change document or None when no document is available after running a single getMore or when the cursor is closed.
_DocumentType | None
Added in version 3.8.
A change stream that watches changes on all collections in the cluster.
Should not be called directly by application developers. Use helper method pymongo.asynchronous.mongo_client.AsyncMongoClient.watch() instead.
Added in version 3.7.
target (Union[AsyncMongoClient[_DocumentType], AsyncDatabase[_DocumentType], AsyncCollection[_DocumentType]])
pipeline (Optional[_Pipeline])
full_document (Optional[str])
resume_after (Optional[Mapping[str, Any]])
max_await_time_ms (Optional[int])
batch_size (Optional[int])
collation (Optional[_CollationIn])
start_at_operation_time (Optional[Timestamp])
session (Optional[AsyncClientSession])
start_after (Optional[Mapping[str, Any]])
comment (Optional[Any])
full_document_before_change (Optional[str])
show_expanded_events (Optional[bool])
A change stream that watches changes on a single collection.
Should not be called directly by application developers. Use helper method pymongo.asynchronous.collection.AsyncCollection.watch() instead.
Added in version 3.7.
target (Union[AsyncMongoClient[_DocumentType], AsyncDatabase[_DocumentType], AsyncCollection[_DocumentType]])
pipeline (Optional[_Pipeline])
full_document (Optional[str])
resume_after (Optional[Mapping[str, Any]])
max_await_time_ms (Optional[int])
batch_size (Optional[int])
collation (Optional[_CollationIn])
start_at_operation_time (Optional[Timestamp])
session (Optional[AsyncClientSession])
start_after (Optional[Mapping[str, Any]])
comment (Optional[Any])
full_document_before_change (Optional[str])
show_expanded_events (Optional[bool])
A change stream that watches changes on all collections in a database.
Should not be called directly by application developers. Use helper method pymongo.asynchronous.database.AsyncDatabase.watch() instead.
Added in version 3.7.
target (Union[AsyncMongoClient[_DocumentType], AsyncDatabase[_DocumentType], AsyncCollection[_DocumentType]])
pipeline (Optional[_Pipeline])
full_document (Optional[str])
resume_after (Optional[Mapping[str, Any]])
max_await_time_ms (Optional[int])
batch_size (Optional[int])
collation (Optional[_CollationIn])
start_at_operation_time (Optional[Timestamp])
session (Optional[AsyncClientSession])
start_after (Optional[Mapping[str, Any]])
comment (Optional[Any])
full_document_before_change (Optional[str])
show_expanded_events (Optional[bool])
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4