Skip to content
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,8 @@ among all members of the set. Consider the following:
replication:
replSetName: set0

Use descriptive names for sets. Once configured, use the
:binary:`~bin.mongo` shell to add hosts to the replica set.
Use descriptive names for sets. Once configured, use
:mongosh:`mongosh </>` to add hosts to the replica set.

.. seealso::

Expand Down
6 changes: 3 additions & 3 deletions source/administration/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -499,15 +499,15 @@ has a background :term:`balancer` process that distributes data to ensure that
chunks are always optimally distributed among the :term:`shards <shard>`.

Issue the :method:`db.printShardingStatus()` or :method:`sh.status()`
command to the :binary:`~bin.mongos` by way of the :binary:`~bin.mongo`
shell. This returns an overview of the entire cluster including the
command to the :binary:`~bin.mongos` from within :mongosh:`mongosh </>`.
This returns an overview of the entire cluster including the
database name, and a list of the chunks.

Stale Locks
~~~~~~~~~~~

To check the lock status of the database, connect to a
:binary:`~bin.mongos` instance using the :binary:`~bin.mongo` shell. Issue the
:binary:`~bin.mongos` instance using :mongosh:`mongosh </>`. Issue the
following command sequence to switch to the ``config`` database and
display all outstanding locks on the shard database:

Expand Down
4 changes: 2 additions & 2 deletions source/administration/production-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ MongoDB requires the following minimum ``x86_64`` microarchitectures:
- For AMD ``x86_64``, MongoDB requires *Bulldozer* or later.

Starting in MongoDB 5.0, :binary:`~bin.mongod`, :binary:`~bin.mongos`,
and the :binary:`~bin.mongo` shell no longer support ``x86_64``
and the legacy :binary:`~bin.mongo` shell no longer support ``x86_64``
platforms which do not meet this minimum microarchitecture requirement.

.. include:: /includes/fact-platform-x86_64.rst
Expand All @@ -76,7 +76,7 @@ MongoDB on ``arm64`` requires the *ARMv8.2-A* or later
microarchitecture.

Starting in MongoDB 5.0, :binary:`~bin.mongod`, :binary:`~bin.mongos`,
and the :binary:`~bin.mongo` shell no longer support ``arm64``
and the legacy :binary:`~bin.mongo` shell no longer support ``arm64``
platforms which do not meet this minimum microarchitecture requirement.

.. include:: /includes/fact-platform-arm64.rst
Expand Down
2 changes: 1 addition & 1 deletion source/appendix/security/appendixA-openssl-ca.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ B. Generate the Test CA PEM File
cat mongodb-test-ca.crt mongodb-test-ia.crt > test-ca.pem

You can use the :red:`test` PEM file when configuring :binary:`~bin.mongod`,
:binary:`~bin.mongos`, or :binary:`~bin.mongo` for TLS/SSL :red:`testing`.
:binary:`~bin.mongos`, or :mongosh:`mongosh </>` for TLS/SSL :red:`testing`.

You can use the :red:`test` intermediate authority to sign the :red:`test`
certificates for both the server(s) and client(s). A single authority
Expand Down
12 changes: 6 additions & 6 deletions source/appendix/security/appendixC-openssl-client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ B. Generate the Test PEM File for Client

cat mongodb-test-client.crt mongodb-test-client.key > test-client.pem

You can use the :red:`test` PEM file to configure the :binary:`~bin.mongo`
shell for TLS/SSL :red:`testing`. For example, to connect to a
:binary:`~bin.mongod` or a :binary:`~bin.mongos`:
You can use the :red:`test` PEM file to configure
:mongosh:`mongosh </>` for TLS/SSL :red:`testing`. For example, to
connect to a :binary:`~bin.mongod` or a :binary:`~bin.mongos`:

.. example::

Expand Down Expand Up @@ -163,7 +163,7 @@ B. Generate the Test PEM File for Client
openssl pkcs12 -export -out test-client.pfx -inkey mongodb-test-client.key -in mongodb-test-client.crt -certfile mongodb-test-ia.crt

Once added to Keychain Access, instead of specifying the Certificate Key
file, you can use the :option:`--tlsCertificateSelector <mongo
file, you can use the :option:`--tlsCertificateSelector <mongosh
--tlsCertificateSelector>` to specify the certificate to use. If
the CA file is also in Keychain Access, you can omit
``--tlsCAFile`` as well as in the following example:
Expand All @@ -174,8 +174,8 @@ B. Generate the Test PEM File for Client

mongo --tls --tlsCertificateSelector subject="<TestClientCertificateCommonName>"

Although still available, :option:`--ssl <mongo --ssl>` and
:option:`--sslCertificateSelector <mongo
Although still available, :option:`--ssl <mongosh --ssl>` and
:option:`--sslCertificateSelector <mongosh
--sslCertificateSelector>` are :ref:`deprecated as of MongoDB 4.2
<4.2-tls>`.

Expand Down
6 changes: 3 additions & 3 deletions source/changeStreams.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can open change streams against:

The examples on this page use the MongoDB drivers to open and
work with a change stream cursor for a single collection. See
also the :binary:`~bin.mongo` shell method
also the :mongosh:`mongosh </>` method
:method:`db.collection.watch()`.

* - A database
Expand All @@ -80,7 +80,7 @@ You can open change streams against:
collections.

For the MongoDB driver method, refer to your driver
documentation. See also the :binary:`~bin.mongo` shell method
documentation. See also the :mongosh:`mongosh </>` method
:method:`db.watch()`.


Expand All @@ -92,7 +92,7 @@ You can open change streams against:
databases except for ``admin``, ``local``, and ``config``.

For the MongoDB driver method, refer to your driver
documentation. See also the :binary:`~bin.mongo` shell method
documentation. See also the :mongosh:`mongosh </>` method
:method:`Mongo.watch()`.

.. note:: Change Stream Examples
Expand Down
5 changes: 2 additions & 3 deletions source/core/aggregation-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,8 @@ exception of :pipeline:`$out`, :pipeline:`$merge`, and
of all available stages, see
:ref:`aggregation-pipeline-operator-reference`.

MongoDB provides the :method:`db.collection.aggregate()` method in the
:binary:`~bin.mongo` shell and the :dbcommand:`aggregate` command to
run the aggregation pipeline.
MongoDB provides the :method:`db.collection.aggregate()` shell method
and the :dbcommand:`aggregate` command to run the aggregation pipeline.

For example usage of the aggregation pipeline, consider
:doc:`/tutorial/aggregation-with-user-preference-data` and
Expand Down
2 changes: 1 addition & 1 deletion source/core/authentication-mechanisms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To specify the authentication mechanism to use, set the
:binary:`~bin.mongos`.

Clients specify the authentication mechanism in the :method:`db.auth()` method.
For the :binary:`~bin.mongo` shell and the MongoDB tools, you can also specify the
For :mongosh:`mongosh </>` and the MongoDB tools, you can also specify the
authentication mechanism from the command line.

.. toctree::
Expand Down
12 changes: 6 additions & 6 deletions source/core/capped-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,12 @@ Create a Capped Collection
~~~~~~~~~~~~~~~~~~~~~~~~~~

You must create capped collections explicitly using the
:method:`db.createCollection()` method, which is a helper in the
:binary:`~bin.mongo` shell for the :dbcommand:`create` command. When
creating a capped collection you must specify the maximum size of the
collection in bytes, which MongoDB will pre-allocate for the collection.
The size of the capped collection includes a small amount of space for
internal overhead.
:method:`db.createCollection()` method, which is a
:mongosh:`mongosh </>` helper for the :dbcommand:`create` command.
When creating a capped collection you must specify the maximum size of
the collection in bytes, which MongoDB will pre-allocate for the
collection. The size of the capped collection includes a small amount of
space for internal overhead.

.. code-block:: javascript

Expand Down
6 changes: 3 additions & 3 deletions source/core/databases-and-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ gathered together in :term:`collections <collection>`. A
Databases
---------
In MongoDB, databases hold one or more collections of documents. To
select a database to use, in the :binary:`~bin.mongo` shell, issue the
select a database to use, in :mongosh:`mongosh </>`, issue the
``use <db>`` statement, as in the following example:

.. code-block:: javascript
Expand All @@ -33,8 +33,8 @@ Create a Database

If a database does not exist, MongoDB creates the database when you
first store data for that database. As such, you can switch to a
non-existent database and perform the following operation in the
:binary:`~bin.mongo` shell:
non-existent database and perform the following operation in
:mongosh:`mongosh </>`:

.. code-block:: javascript

Expand Down
4 changes: 2 additions & 2 deletions source/core/gridfs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ exists before read and write operations. See the relevant driver
documentation for the specific behavior of your GridFS application.

If this index does not exist, you can issue the following operation to
create it using the :binary:`~bin.mongo` shell:
create it using :mongosh:`mongosh </>`:

.. code-block:: javascript

Expand All @@ -312,7 +312,7 @@ read and write operations. See the relevant driver documentation for the
specific behavior of your GridFS application.

If this index does not exist, you can issue the following operation to
create it using the :binary:`~bin.mongo` shell:
create it using :mongosh:`mongosh </>`:

.. code-block:: javascript

Expand Down
2 changes: 1 addition & 1 deletion source/core/hashed-sharding.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Sharding on a Compound Hashed Index
.. include:: /includes/warning-hashed-index-floating-point.rst

.. [#hashvalue]
Starting in version 4.0, the :binary:`~bin.mongo` shell provides the
Starting in version 4.0, :mongosh:`mongosh </>` provides the
method :method:`convertShardKeyToHashed()`. This method uses the
same hashing function as the hashed index and can be used to see
what the hashed value would be for a key.
Expand Down
2 changes: 1 addition & 1 deletion source/core/index-creation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Monitor In Progress Index Builds
--------------------------------

To see the status of an index build operation, you can use the
:method:`db.currentOp()` method in the :binary:`~bin.mongo` shell. To
:method:`db.currentOp()` method in :mongosh:`mongosh </>`. To
filter the current operations for index creation operations, see
:ref:`currentOp-index-creation` for an example.

Expand Down
4 changes: 2 additions & 2 deletions source/core/index-hashed.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ an array into a hashed indexed field returns an error.
.. include:: /includes/tip-applications-do-not-need-to-compute-hashes.rst

.. [#hashvalue]
Starting in version 4.0, the :binary:`~bin.mongo` shell provides the
Starting in version 4.0, :mongosh:`mongosh </>` provides the
method :method:`convertShardKeyToHashed()`. This method uses the
same hashing function as the hashed index and can be used to see
what the hashed value would be for a key.
Expand Down Expand Up @@ -121,7 +121,7 @@ indexed field has the value 2\ :sup:`63`.

To list all ``hashed`` indexes for all
collections in your deployment, you can use the following
operation in the :binary:`~bin.mongo` shell:
operation in :mongosh:`mongosh </>`:

.. code-block:: javascript

Expand Down
4 changes: 2 additions & 2 deletions source/core/index-hidden.txt
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Hide an Existing Index
- You cannot hide the ``_id`` index.

To hide an existing index, you can use the :dbcommand:`collMod` command
or the :binary:`~bin.mongo` shell helper
or :mongosh:`mongosh </>` helper
:method:`db.collection.hideIndex()`.

For example, create an index without hiding:
Expand Down Expand Up @@ -196,7 +196,7 @@ Unhide an Existing Index
~~~~~~~~~~~~~~~~~~~~~~~~

To unhide a hidden index, you can use the :dbcommand:`collMod` command
or the :binary:`~bin.mongo` shell helper
or :mongosh:`mongosh </>` helper
:method:`db.collection.unhideIndex()`. You can specify either:

- the index key specification document to the
Expand Down
4 changes: 2 additions & 2 deletions source/core/index-sparse.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Create a Sparse Index

To create a ``sparse`` index, use the
:method:`db.collection.createIndex()` method with the ``sparse`` option
set to ``true``. For example, the following operation in the
:binary:`~bin.mongo` shell creates a sparse index on the ``xmpp_id`` field
set to ``true``. For example, the following operation in
:mongosh:`mongosh </>` creates a sparse index on the ``xmpp_id`` field
of the ``addresses`` collection:

.. code-block:: javascript
Expand Down
2 changes: 1 addition & 1 deletion source/core/index-ttl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ option with the desired TTL value in seconds.

For example, to create a TTL index on the ``lastModifiedDate`` field of
the ``eventlog`` collection, with a TTL value of ``3600`` seconds, use
the following operation in the :binary:`~bin.mongo` shell:
the following operation in :mongosh:`mongosh </>`:

.. code-block:: javascript

Expand Down
6 changes: 3 additions & 3 deletions source/core/index-unique.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Unique Index on a Single Field
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For example, to create a unique index on the ``user_id`` field of the
``members`` collection, use the following operation in the
:binary:`~bin.mongo` shell:
``members`` collection, use the following operation in
:mongosh:`mongosh </>`:

.. code-block:: javascript

Expand All @@ -65,7 +65,7 @@ uniqueness on the *combination* of the index key values.

For example, to create a unique index on ``groupNumber``, ``lastname``,
and ``firstname`` fields of the ``members`` collection, use the
following operation in the :binary:`~bin.mongo` shell:
following operation in :mongosh:`mongosh </>`:

.. code-block:: javascript

Expand Down
2 changes: 1 addition & 1 deletion source/core/kerberos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ principal name ``mongodb/[email protected]``.
To specify a different value for ``<service>``, use
:setting:`~security.sasl.serviceName` during the start up of :binary:`~bin.mongod` or
:binary:`~bin.mongos` (or :binary:`~bin.mongod.exe` or :binary:`~bin.mongos.exe`).
:binary:`~bin.mongo` shell or other clients may also specify a different
:mongosh:`mongosh </>` or other clients may also specify a different
service principal name using :setting:`~security.sasl.serviceName`.

Service principal names must be reachable over the network using the
Expand Down
2 changes: 1 addition & 1 deletion source/core/query-optimization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ indexes in MongoDB </indexes>`.

To improve the performance of this query, add an ascending or a
descending index to the ``inventory`` collection on the ``type``
field. [#ensureIndexOrder]_ In the :binary:`~bin.mongo` shell, you can
field. [#ensureIndexOrder]_ In :mongosh:`mongosh </>`, you can
create indexes using the :method:`db.collection.createIndex()`
method:

Expand Down
2 changes: 1 addition & 1 deletion source/core/read-isolation-consistency-recency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ For causally related operations:
.. note::

Operations can be causally consistent across different sessions.
MongoDB drivers and the :binary:`~bin.mongo` shell provide the
MongoDB drivers and :mongosh:`mongosh </>` provide the
methods to advance the operation time and the cluster time for a
client session. So, a client can advance the cluster time and the
operation time of one client session to be consistent with the
Expand Down
4 changes: 2 additions & 2 deletions source/core/read-preference-hedge-option.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ read by default.
- When using the drivers, refer to the :driver:`drivers' read preference API
</>`.

- When using the :binary:`~bin.mongo` shell, you can use the helper
- When using :mongosh:`mongosh </>`, you can use the helper
methods :method:`cursor.readPref()` and :method:`Mongo.setReadPref()`.

Additional Information
Expand All @@ -47,5 +47,5 @@ Hedged Reads Diagnostics
~~~~~~~~~~~~~~~~~~~~~~~~

The command :dbcommand:`serverStatus` and its corresponding
:binary:`~bin.mongo` shell method :method:`db.serverStatus()` return
:mongosh:`mongosh </>` method :method:`db.serverStatus()` return
:serverstatus:`hedgingMetrics`.
2 changes: 1 addition & 1 deletion source/core/read-preference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ For a given read preference, the MongoDB drivers use the same
:ref:`member selection logic
<replica-set-read-preference-behavior-member-selection>`.

When using the :binary:`~bin.mongo` shell, see
When using :mongosh:`mongosh </>`, see
:method:`cursor.readPref()` and :method:`Mongo.setReadPref()`.

Read Preference and Transactions
Expand Down
2 changes: 1 addition & 1 deletion source/core/retryable-reads.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ enable retryable reads by default. To explicitly disable retryable
reads, specify :urioption:`retryReads=false <retryReads>` in the
:ref:`connection string <mongodb-uri>` for the deployment.

The :binary:`~bin.mongo` shell does not support retryable reads.
:mongosh:`mongosh </>` does not support retryable reads.

.. _retryable-read-ops:

Expand Down
8 changes: 4 additions & 4 deletions source/core/retryable-writes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ Enabling Retryable Writes
MongoDB Drivers
.. include:: /includes/extracts/4.2-changes-drivers-retryWrites-default.rst

:binary:`~bin.mongo` shell
To enable retryable writes in the :binary:`~bin.mongo` shell, use
the :option:`--retryWrites <mongo --retryWrites>` command line option:
:mongosh:`mongosh </>`
To enable retryable writes in :mongosh:`mongosh </>`, use
the :option:`--retryWrites <mongosh --retryWrites>` command line option:

.. code-block:: bash

Expand Down Expand Up @@ -363,7 +363,7 @@ Diagnostics

.. versionadded:: 3.6.3

The :dbcommand:`serverStatus` command, and its :binary:`~bin.mongo`
The :dbcommand:`serverStatus` command, and its :mongosh:`mongosh </>`
shell helper :method:`db.serverStatus()` includes statistics on
retryable writes in the :serverstatus:`transactions` section.

Expand Down
Loading