Skip to content

DOCS-4913 - redact meta driver #2200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/applications/design-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ Consider:
Type Sensitive Fields
~~~~~~~~~~~~~~~~~~~~~

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

Consider the following document which has a field ``x`` with the
*string* value ``"123"``:
Expand Down
9 changes: 4 additions & 5 deletions source/core/cursors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,10 @@ Closure of Inactive Cursors

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

.. code-block:: javascript

Expand Down
9 changes: 3 additions & 6 deletions source/includes/apiargs-method-cursor.addOption-param.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
arg_name: param
description: |
``OP_QUERY`` wire protocol flag. See :meta-driver:`MongoDB wire
protocol </legacy/mongodb-wire-protocol/?pageVersion=106#op-query>`
for more information on MongoDB Wire Protocols and the OP_QUERY flags.
For the :program:`mongo` shell, you can use :ref:`cursor flags
<cursor-flags>`. For the driver-specific list, see your :doc:`driver
documentation </applications/drivers>`.
``OP_QUERY`` wire protocol flag. For the :program:`mongo` shell,
you can use the cursor flags listed below. For the driver-specific
list, see your :doc:`driver documentation </applications/drivers>`.
interface: method
name: flag
operation: cursor.addOption
Expand Down
48 changes: 32 additions & 16 deletions source/reference/method/cursor.addOption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,38 @@ Flags
The :program:`mongo` shell provides several additional cursor flags to
modify the behavior of the cursor.

.. data:: DBQuery.Option.tailable

.. data:: DBQuery.Option.slaveOk

.. data:: DBQuery.Option.oplogReplay

.. data:: DBQuery.Option.noTimeout

.. data:: DBQuery.Option.awaitData

.. data:: DBQuery.Option.exhaust

.. data:: DBQuery.Option.partial

For a description of the flags, see
:meta-driver:`MongoDB wire protocol </legacy/mongodb-wire-protocol/?pageVersion=106#op-query>`.
.. list-table::
:header-rows: 1
:widths: 30 70

* - Flag
- Description

* - .. data:: DBQuery.Option.tailable
- Sets the cursor not to close once the last data is
received, allowing the query to continue returning data added
after the initial results were exhausted.

* - .. data:: DBQuery.Option.slaveOk
- Allows querying of a replica slave.

* - .. data:: DBQuery.Option.noTimeout
- Prevents the server from timing out idle cursors.

* - .. data:: DBQuery.Option.awaitData
- For use with .. data:: DBQuery.Option.tailable; sets the cursor
to block and await data for a while rather than returning no
data. The cursor will return no data once the timeout has
expired.

* - .. data:: DBQuery.Option.exhaust
- Sets the cursor to return all data returned by the
query at once rather than splitting the results into batches.

* - .. data:: DBQuery.Option.partial
- Sets the cursor to return partial data from a query against a
sharded cluster in which some shards do not respond rather than
throwing an error.

Example
-------
Expand Down
2 changes: 0 additions & 2 deletions source/release-notes/2.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -322,8 +322,6 @@ command will report whether any inserts have failed, not just the
last one. If multiple errors occur, the client will only receive the
most recent :dbcommand:`getLastError` results.

See :meta-driver:`OP_INSERT </legacy/mongodb-wire-protocol#op-insert>`.

.. include:: /includes/note-bulk-inserts-on-sharded-clusters.rst

Map Reduce
Expand Down
5 changes: 1 addition & 4 deletions source/tutorial/create-tailable-cursor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,7 @@ Consider the following behaviors related to tailable cursors:
A *dead* cursor has an id of ``0``.

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

C++ Example
-----------
Expand Down