Skip to content

Commit 9475b45

Browse files
author
Michael Paik
committed
DOCS-4913 - redact meta driver
1 parent 51e5883 commit 9475b45

File tree

6 files changed

+44
-37
lines changed

6 files changed

+44
-37
lines changed

source/applications/design-notes.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ Consider:
5353
Type Sensitive Fields
5454
~~~~~~~~~~~~~~~~~~~~~
5555

56-
MongoDB data is stored in the :meta-driver:`BSON </legacy/bson/>`
57-
format, a binary encoded serialization of JSON-like documents. BSON
58-
encodes additional type information. See `bsonspec.org
59-
<http://bsonspec.org/#/specification>`_ for more information.
56+
MongoDB data is stored in the BSON format, a binary encoded
57+
serialization of JSON-like documents. BSON encodes additional type
58+
information. See `bsonspec.org <http://bsonspec.org/#/specification>`_
59+
for more information.
6060

6161
Consider the following document which has a field ``x`` with the
6262
*string* value ``"123"``:

source/core/cursors.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,10 @@ Closure of Inactive Cursors
4141

4242
By default, the server will automatically close the cursor after 10
4343
minutes of inactivity or if client has exhausted the cursor. To
44-
override this behavior, you can specify the ``noTimeout``
45-
:meta-driver:`wire protocol flag </legacy/mongodb-wire-protocol>` in
46-
your query; however, you should either close the cursor manually or
47-
exhaust the cursor. In the :program:`mongo` shell, you can set the
48-
``noTimeout`` flag:
44+
override this behavior, you can specify the ``noTimeout`` flag in your
45+
query using :method:`cursor.addOption()`; however, you should either
46+
close the cursor manually or exhaust the cursor. In the
47+
:program:`mongo` shell, you can set the ``noTimeout`` flag:
4948

5049
.. code-block:: javascript
5150

source/includes/apiargs-method-cursor.addOption-param.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
arg_name: param
22
description: |
3-
``OP_QUERY`` wire protocol flag. See :meta-driver:`MongoDB wire
4-
protocol </legacy/mongodb-wire-protocol/?pageVersion=106#op-query>`
5-
for more information on MongoDB Wire Protocols and the OP_QUERY flags.
6-
For the :program:`mongo` shell, you can use :ref:`cursor flags
7-
<cursor-flags>`. For the driver-specific list, see your :doc:`driver
8-
documentation </applications/drivers>`.
3+
``OP_QUERY`` wire protocol flag. For the :program:`mongo` shell,
4+
you can use the cursor flags listed below. For the driver-specific
5+
list, see your :doc:`driver documentation </applications/drivers>`.
96
interface: method
107
name: flag
118
operation: cursor.addOption

source/reference/method/cursor.addOption.txt

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,38 @@ Flags
2424
The :program:`mongo` shell provides several additional cursor flags to
2525
modify 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

4460
Example
4561
-------

source/release-notes/2.0.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,8 +322,6 @@ command will report whether any inserts have failed, not just the
322322
last one. If multiple errors occur, the client will only receive the
323323
most recent :dbcommand:`getLastError` results.
324324

325-
See :meta-driver:`OP_INSERT </legacy/mongodb-wire-protocol#op-insert>`.
326-
327325
.. include:: /includes/note-bulk-inserts-on-sharded-clusters.rst
328326

329327
Map Reduce

source/tutorial/create-tailable-cursor.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ Consider the following behaviors related to tailable cursors:
5454
A *dead* cursor has an id of ``0``.
5555

5656
See your :doc:`driver documentation </applications/drivers>` for the
57-
driver-specific method to specify the tailable cursor. For more
58-
information on the details of specifying a tailable cursor, see
59-
:meta-driver:`MongoDB wire protocol </legacy/mongodb-wire-protocol>`
60-
documentation.
57+
driver-specific method to specify the tailable cursor.
6158

6259
C++ Example
6360
-----------

0 commit comments

Comments
 (0)