Skip to content
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
6 changes: 3 additions & 3 deletions source/faq/developers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ All of the following MongoDB operations permit you to run arbitrary JavaScript
expressions directly on the server:

- :operator:`$where`
- :method:`~db.eval()`
- :method:`db.eval()`
- :dbcommand:`mapReduce`
- :dbcommand:`group`

Expand All @@ -326,7 +326,7 @@ JavaScript code to the :operator:`$where` field.
scope document, you can avoid evaluating them on the database
server.

- If you need to use :method:`~db.eval()` with user supplied values, you can
- If you need to use :method:`db.eval()` with user supplied values, you can
either use a ``CodeWScope`` or you can supply extra arguments to your
function. For instance:

Expand Down Expand Up @@ -549,7 +549,7 @@ exceptions:

If your collection name includes special characters, such as the
underscore character, then to access the collection use the
:method:`~db.getCollection()` method or a :api:`similar method for your
:method:`db.getCollection()` method or a :api:`similar method for your
driver <>`.

.. example:: To create a collection ``_foo`` and insert the
Expand Down
2 changes: 1 addition & 1 deletion source/faq/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ do one of the following:

- Wait for the index to finish building.

- Kill the current operation (see :method:`~db.killOp()`). The partial
- Kill the current operation (see :method:`db.killOp()`). The partial
index will be deleted.

.. _faq-index-min-max:
Expand Down
4 changes: 2 additions & 2 deletions source/includes/table-lock-behavior-per-operation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ op7: Create an index
lock7: |
Building an index in the foreground, which is the default, locks
the database for extended periods of time.
op8: :method:`~db.eval()`
op8: :method:`db.eval()`
lock8: |
Write lock. :method:`~db.eval()` blocks all other JavaScript
Write lock. :method:`db.eval()` blocks all other JavaScript
processes.
op9: :dbcommand:`eval`
lock9: |
Expand Down
2 changes: 1 addition & 1 deletion source/includes/table-sql-to-mongo-schema-examples.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ mongo1: |
ref1: |
See
:method:`~db.collection.insert()` and
:method:`~db.createCollection()`
:method:`db.createCollection()`
for more information.
sql2: |
.. code-block:: sql
Expand Down
2 changes: 1 addition & 1 deletion source/reference/database-profiler.txt
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ operation.
The IP address or hostname of the client connection where the
operation originates.

For some operations, such as :method:`~db.eval()`, the client is
For some operations, such as :method:`db.eval()`, the client is
``0.0.0.0:0`` instead of an actual client.

.. data:: system.profile.user
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/Mongo.setSlaveOk.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ mongo.setSlaveOk()
Indicates that ":term:`eventually consistent <eventual
consistency>`" read operations are acceptable for the current
application. This function provides the same functionality as
:method:`~rs.slaveOk()`.
:method:`rs.slaveOk()`.

See the :method:`~cursor.readPref()` method for more
fine-grained control over :doc:`read preference
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.changeUserPassword.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Definition

:throws exception:
If an error occurs, the
:method:`~db.changeUserPassword()` helper throws an exception with the
:method:`db.changeUserPassword()` helper throws an exception with the
error message and code.

Example
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.commandHelp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Description
Displays help text for the specified :term:`database command`. See
the :doc:`/reference/command`.

The :method:`~db.commandHelp()` method has the following parameter:
The :method:`db.commandHelp()` method has the following parameter:

.. include:: /reference/method/db.commandHelp-param.rst
4 changes: 2 additions & 2 deletions source/reference/method/db.createCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Definition
creating new :term:`capped collections <capped collection>`. This is
also used to pre-allocate space for an ordinary collection.

The :method:`~db.createCollection` has the following prototype form:
The :method:`db.createCollection()` has the following prototype form:

.. code-block:: javascript

db.createCollection(name, {capped: <Boolean>, autoIndexId: <Boolean>, size: <number>, max <number>} )

The :method:`~db.createCollection` method has the following parameters:
The :method:`db.createCollection()` method has the following parameters:

.. include:: /reference/method/db.createCollection-param.rst

Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.getCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Description
``_`` or that mirror the :doc:`database commands
</reference/command>`.

The :method:`~db.getCollection()` method has the following parameter:
The :method:`db.getCollection()` method has the following parameter:

.. include:: /reference/method/db.getCollection-param.rst
2 changes: 1 addition & 1 deletion source/reference/method/db.isMaster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ db.isMaster()
:term:`secondary` member of the replica set.

.. see:: :dbcommand:`isMaster` for the complete documentation of
the output of :method:`~db.isMaster()`.
the output of :method:`db.isMaster()`.
2 changes: 1 addition & 1 deletion source/reference/method/db.killOp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Description
Terminates an operation as specified by the operation ID. To find
operations and their corresponding IDs, see :method:`db.currentOp()`.

The :method:`~db.killOp()` method has the following parameter:
The :method:`db.killOp()` method has the following parameter:

.. include:: /reference/method/db.killOp-param.rst

Expand Down
14 changes: 7 additions & 7 deletions source/reference/mongo-shell.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The following table displays some common JavaScript operations:
* - **JavaScript Database Operations**
- **Description**

* - :method:`~db.auth()`
* - :method:`db.auth()`

- If running in secure mode, authenticate the user.

Expand Down Expand Up @@ -188,7 +188,7 @@ The following table displays some common JavaScript operations:
- Create a new index on the collection if the index does not
exist; otherwise, the operation has no effect.

* - :method:`~db.getSiblingDB()` or ``db.getSisterDB()``
* - :method:`db.getSiblingDB()`

- Return a reference to another database using this same
connection without explicitly switching the current database.
Expand Down Expand Up @@ -453,10 +453,10 @@ methods. These methods are:
* - **Error Checking Methods**
- **Description**

* - :method:`~db.getLastError()`
* - :method:`db.getLastError()`
- Returns error message from the last operation.

* - :method:`~db.getLastErrorObj()`
* - :method:`db.getLastErrorObj()`
- Returns the error document from the last operation.

.. _mongo-dba-helpers:
Expand Down Expand Up @@ -491,7 +491,7 @@ administration:

- Rename collection from ``fromColl`` to ``<toColl>``.

* - :method:`~db.repairDatabase()`
* - :method:`db.repairDatabase()`

- Repair and compact the current database. This operation can be
very slow on large databases.
Expand All @@ -500,11 +500,11 @@ administration:

- Add user to current database.

* - :method:`~db.getCollectionNames()`
* - :method:`db.getCollectionNames()`

- Get the list of all collections in the current database.

* - :method:`~db.dropDatabase()`
* - :method:`db.dropDatabase()`

- Drops the current database.

Expand Down
14 changes: 7 additions & 7 deletions source/release-notes/2.2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,18 +88,18 @@ procedure:
with the 2.2 binary. After upgrading a :program:`mongod` instance,
wait for the member to recover to ``SECONDARY`` state
before upgrading the next instance.
To check the member's state, issue :method:`~rs.status()` in the
To check the member's state, issue :method:`rs.status()` in the
:program:`mongo` shell.

#. Use the :program:`mongo` shell method :method:`~rs.stepDown()` to
#. Use the :program:`mongo` shell method :method:`rs.stepDown()` to
step down the :term:`primary` to allow the normal :ref:`failover
<replica-set-failover>` procedure. :method:`~rs.stepDown()`
<replica-set-failover>` procedure. :method:`rs.stepDown()`
expedites the failover procedure and is preferable to shutting down
the primary directly.

Once the primary has stepped down and another member has assumed
``PRIMARY`` state, as observed in the output of
:method:`~rs.status()`, shut down the previous primary and replace
:method:`rs.status()`, shut down the previous primary and replace
:program:`mongod` binary with the 2.2 binary and start the new
process.

Expand Down Expand Up @@ -187,7 +187,7 @@ To reflect these changes, MongoDB now provides changed and improved
reporting for concurrency and use, see :ref:`locks` and
:ref:`server-status-record-stats` in :doc:`server status
</reference/command/serverStatus>` and see
:method:`~db.currentOp()`,
:method:`db.currentOp()`,
:doc:`mongotop </reference/program/mongotop>`, and :doc:`mongostat
</reference/program/mongostat>`.

Expand Down Expand Up @@ -572,7 +572,7 @@ consistency of the user interface for the :program:`mongo` shell:
Helper to load Server-Side Functions
````````````````````````````````````

The :method:`~db.loadServerScripts()` loads the contents of the current
The :method:`db.loadServerScripts()` loads the contents of the current
database's ``system.js`` collection into the current :program:`mongo`
shell session. See :issue:`SERVER-1651` for more information.

Expand Down Expand Up @@ -670,7 +670,7 @@ Replica Set Members can Sync from Specific Members
.. the following has been copied to source/administration/replica-sets.txt

The new :dbcommand:`replSetSyncFrom` command and new
:method:`~rs.syncFrom()` helper in the :program:`mongo` shell make it
:method:`rs.syncFrom()` helper in the :program:`mongo` shell make it
possible for you to manually configure from which member of the set a
replica will poll :term:`oplog` entries. Use these commands to
override the default selection logic if needed. Always exercise
Expand Down
4 changes: 2 additions & 2 deletions source/tutorial/access-mongo-shell-help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Database Help
``show databases`` is now an alias for ``show dbs``

- To see the list of help for methods you can use on the ``db``
object, call the :method:`~db.help()` method:
object, call the :method:`db.help()` method:

.. code-block:: javascript

Expand All @@ -64,7 +64,7 @@ Database Help
- To see the implementation of a method in the shell, type the
``db.<method name>`` without the parenthesis (``()``), as in the
following example which will return the implementation of the method
:method:`~db.addUser()`:
:method:`db.addUser()`:

.. code-block:: javascript

Expand Down
2 changes: 1 addition & 1 deletion source/tutorial/evaluate-operation-performance.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For more information, see :ref:`database-profiling`.
Use ``db.currentOp()`` to Evaluate ``mongod`` Operations
--------------------------------------------------------

The :method:`~db.currentOp()` method reports on current operations
The :method:`db.currentOp()` method reports on current operations
running on a :program:`mongod` instance.

Use ``$explain`` to Evaluate Query Performance
Expand Down
10 changes: 5 additions & 5 deletions source/tutorial/manage-chunks-in-sharded-cluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ You may want to split chunks manually if:

.. include:: /includes/warning-splitting-chunks.rst

Use :method:`~sh.status()` to determine the current chunks ranges across
Use :method:`sh.status()` to determine the current chunks ranges across
the cluster.

To split chunks manually, use the :dbcommand:`split` command with
operators: ``middle`` and ``find``. The equivalent shell helpers are
:method:`~sh.splitAt()` or :method:`~sh.splitFind()`.
:method:`sh.splitAt()` or :method:`sh.splitFind()`.

.. example::

Expand All @@ -63,16 +63,16 @@ operators: ``middle`` and ``find``. The equivalent shell helpers are

sh.splitFind( "records.people", { "zipcode": 63109 } )

:method:`~sh.splitFind()` will split the chunk that contains the
:method:`sh.splitFind()` will split the chunk that contains the
*first* document returned that matches this query into two equally
sized chunks. You must specify the full namespace
(i.e. "``<database>.<collection>``") of the sharded collection to
:method:`~sh.splitFind()`. The query in :method:`~sh.splitFind()` need
:method:`sh.splitFind()`. The query in :method:`sh.splitFind()` need
not contain the shard key, though it almost always makes sense to
query for the shard key in this case, and including the shard key will
expedite the operation.

Use :method:`~sh.splitAt()` to split a chunk in two using the queried
Use :method:`sh.splitAt()` to split a chunk in two using the queried
document as the partition point:

.. code-block:: javascript
Expand Down
6 changes: 3 additions & 3 deletions source/tutorial/manage-mongodb-processes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ press ``Control+C``. MongoDB stops when all ongoing operations are
complete and does a clean exit, flushing and closing all data files.

To stop a :program:`mongod` instance running in the background or
foreground, issue the :method:`~db.shutdownServer()` helper in the
foreground, issue the :method:`db.shutdownServer()` helper in the
:program:`mongo` shell. Use the following sequence:

1. To open the :program:`mongo` shell for a :program:`mongod` instance
Expand All @@ -129,7 +129,7 @@ foreground, issue the :method:`~db.shutdownServer()` helper in the
use admin
db.shutdownServer()

You may only use :method:`~db.shutdownServer()` when connected to the
You may only use :method:`db.shutdownServer()` when connected to the
:program:`mongod` when authenticated to the ``admin`` database or on
systems without authentication connected via the localhost interface.

Expand Down Expand Up @@ -183,7 +183,7 @@ set to ``5``:
db.adminCommand({shutdown : 1, timeoutSecs : 5})

Alternately you can use the ``timeoutSecs`` argument with the
:method:`~db.shutdownServer()` method:
:method:`db.shutdownServer()` method:

.. code-block:: javascript

Expand Down