@@ -24,22 +24,38 @@ Flags
2424The :program:`mongo` shell provides several additional cursor flags to
2525modify the behavior of the cursor.
2626
27- .. data:: DBQuery.Option.tailable
28-
29- .. data:: DBQuery.Option.slaveOk
30-
31- .. data:: DBQuery.Option.oplogReplay
32-
33- .. data:: DBQuery.Option.noTimeout
34-
35- .. data:: DBQuery.Option.awaitData
36-
37- .. data:: DBQuery.Option.exhaust
38-
39- .. data:: DBQuery.Option.partial
40-
41- For a description of the flags, see
42- :meta-driver:`MongoDB wire protocol </legacy/mongodb-wire-protocol/?pageVersion=106#op-query>`.
27+ .. list-table::
28+ :header-rows: 1
29+ :widths: 30 70
30+
31+ * - Flag
32+ - Description
33+
34+ * - .. data:: DBQuery.Option.tailable
35+ - Sets the cursor not to close once the last data is
36+ received, allowing the query to continue returning data added
37+ after the initial results were exhausted.
38+
39+ * - .. data:: DBQuery.Option.slaveOk
40+ - Allows querying of a replica slave.
41+
42+ * - .. data:: DBQuery.Option.noTimeout
43+ - Prevents the server from timing out idle cursors.
44+
45+ * - .. data:: DBQuery.Option.awaitData
46+ - For use with .. data:: DBQuery.Option.tailable; sets the cursor
47+ to block and await data for a while rather than returning no
48+ data. The cursor will return no data once the timeout has
49+ expired.
50+
51+ * - .. data:: DBQuery.Option.exhaust
52+ - Sets the cursor to return all data returned by the
53+ query at once rather than splitting the results into batches.
54+
55+ * - .. data:: DBQuery.Option.partial
56+ - Sets the cursor to return partial data from a query against a
57+ sharded cluster in which some shards do not respond rather than
58+ throwing an error.
4359
4460Example
4561-------
0 commit comments