PYTHON-1063 - Add an example doc for tailable cursors
This commit is contained in:
parent
57cc383286
commit
cb4a80a28a
@ -27,3 +27,4 @@ MongoDB, you can start it like so:
|
||||
high_availability
|
||||
mod_wsgi
|
||||
requests
|
||||
tailable
|
||||
|
||||
41
doc/examples/tailable.rst
Normal file
41
doc/examples/tailable.rst
Normal file
@ -0,0 +1,41 @@
|
||||
Tailable Cursors
|
||||
================
|
||||
|
||||
By default, MongoDB will automatically close a cursor when the client has
|
||||
exhausted all results in the cursor. However, for `capped collections
|
||||
<https://docs.mongodb.org/manual/core/capped-collections/>`_ you may
|
||||
use a `tailable cursor
|
||||
<https://docs.mongodb.org/manual/reference/glossary/#term-tailable-cursor>`_
|
||||
that remains open after the client exhausts the results in the initial cursor.
|
||||
|
||||
The following is a basic example of using a tailable cursor to tail the oplog
|
||||
of a replica set member::
|
||||
|
||||
import time
|
||||
|
||||
import pymongo
|
||||
|
||||
client = pymongo.MongoClient()
|
||||
oplog = client.local.oplog.rs
|
||||
first = oplog.find().sort('$natural', pymongo.ASCENDING).limit(-1).next()
|
||||
print(first)
|
||||
ts = first['ts']
|
||||
|
||||
while True:
|
||||
# The tailable and await_data options make this a tailable cursor.
|
||||
cursor = oplog.find({'ts': {'$gt': ts}},
|
||||
tailable=True,
|
||||
await_data=True)
|
||||
# Enable the OplogReplay cursor option. This enables an optimization
|
||||
# to quickly find the 'ts' value we're looking for. It can only be used
|
||||
# when querying the oplog.
|
||||
cursor.add_option(8)
|
||||
while cursor.alive:
|
||||
for doc in cursor:
|
||||
ts = doc['ts']
|
||||
print(doc)
|
||||
# We end up here if the find() returned no documents or if the
|
||||
# tailable cursor timed out (no new documents were added to the
|
||||
# collection for more than 1 second).
|
||||
time.sleep(1)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user