Skip to content

DOCS-17576 replaces links to mongosh with binary links #5562

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

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
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion source/administration/configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ among all members of the set. Consider the following:
replSetName: set0

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

.. seealso::

Expand Down
4 changes: 2 additions & 2 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` from within :mongosh:`mongosh </>`.
command to the :binary:`~bin.mongos` from within :binary:`~bin.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 :mongosh:`mongosh </>`. Issue the
:binary:`~bin.mongos` instance using :binary:`~bin.mongosh`. Issue the
following command sequence to switch to the ``config`` database and
display all outstanding locks on the shard database:

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 :mongosh:`mongosh </>` for TLS/SSL :red:`testing`.
:binary:`~bin.mongos`, or :binary:`~bin.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
2 changes: 1 addition & 1 deletion source/appendix/security/appendixC-openssl-client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ 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
:mongosh:`mongosh </>` for TLS/SSL :red:`testing`. For example, to
:binary:`~bin.mongosh` for TLS/SSL :red:`testing`. For example, to
connect to a :binary:`~bin.mongod` or a :binary:`~bin.mongos`:

.. example::
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 :mongosh:`mongosh </>` method
also the :binary:`~bin.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 :mongosh:`mongosh </>` method
documentation. See also the :binary:`~bin.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 :mongosh:`mongosh </>` method
documentation. See also the :binary:`~bin.mongosh` method
:method:`Mongo.watch()`.

.. note:: Change Stream Examples
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 :mongosh:`mongosh </>` and the MongoDB tools, you can also specify the
For :binary:`~bin.mongosh` and the MongoDB tools, you can also specify the
authentication mechanism from the command line.

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion source/core/capped-collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Create a Capped Collection

You must create capped collections explicitly using the
:method:`db.createCollection()` method, which is a
:mongosh:`mongosh </>` helper for the :dbcommand:`create` command.
:binary:`~bin.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
Expand Down
4 changes: 2 additions & 2 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 :mongosh:`mongosh </>`, issue the
select a database to use, in :binary:`~bin.mongosh`, issue the
``use <db>`` statement, as in the following example:

.. code-block:: javascript
Expand All @@ -34,7 +34,7 @@ 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
:mongosh:`mongosh </>`:
:binary:`~bin.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 :mongosh:`mongosh </>`:
create it using :binary:`~bin.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 :mongosh:`mongosh </>`:
create it using :binary:`~bin.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, :mongosh:`mongosh </>` provides the
Starting in version 4.0, :binary:`~bin.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 :mongosh:`mongosh </>`. To
:method:`db.currentOp()` method in :binary:`~bin.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, :mongosh:`mongosh </>` provides the
Starting in version 4.0, :binary:`~bin.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 :mongosh:`mongosh </>`:
operation in :binary:`~bin.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 :mongosh:`mongosh </>` helper
or :binary:`~bin.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 :mongosh:`mongosh </>` helper
or :binary:`~bin.mongosh` helper
:method:`db.collection.unhideIndex()`. You can specify either:

- the index key specification document to the
Expand Down
2 changes: 1 addition & 1 deletion source/core/index-sparse.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ 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
:mongosh:`mongosh </>` creates a sparse index on the ``xmpp_id`` field
:binary:`~bin.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 :mongosh:`mongosh </>`:
the following operation in :binary:`~bin.mongosh`:

.. code-block:: javascript

Expand Down
4 changes: 2 additions & 2 deletions source/core/index-unique.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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
:mongosh:`mongosh </>`:
:binary:`~bin.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 :mongosh:`mongosh </>`:
following operation in :binary:`~bin.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`).
:mongosh:`mongosh </>` or other clients may also specify a different
:binary:`~bin.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 :mongosh:`mongosh </>`, you can
field. [#ensureIndexOrder]_ In :binary:`~bin.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 :mongosh:`mongosh </>` provide the
MongoDB drivers and :binary:`~bin.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 :mongosh:`mongosh </>`, you can use the helper
- When using :binary:`~bin.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
:mongosh:`mongosh </>` method :method:`db.serverStatus()` return
:binary:`~bin.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 :mongosh:`mongosh </>`, see
When using :binary:`~bin.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.

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

.. _retryable-read-ops:

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

:mongosh:`mongosh </>`
To enable retryable writes in :mongosh:`mongosh </>`, use
:binary:`~bin.mongosh`
To enable retryable writes in :binary:`~bin.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 :mongosh:`mongosh </>`
The :dbcommand:`serverStatus` command, and its :binary:`~bin.mongosh`
shell helper :method:`db.serverStatus()` includes statistics on
retryable writes in the :serverstatus:`transactions` section.

Expand Down
10 changes: 5 additions & 5 deletions source/core/security-automatic-client-side-encryption.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Automatic Client-Side Field Level Encryption
Overview
--------

Official MongoDB 4.2+ compatible drivers, :mongosh:`mongosh </>`, and
Official MongoDB 4.2+ compatible drivers, :binary:`~bin.mongosh`, and
the MongoDB 4.2 or later legacy :binary:`~bin.mongo` shell support
automatically encrypting fields in read and write operations. For a
complete list of official 4.2+ compatible drivers with support for
Expand All @@ -34,7 +34,7 @@ code associated with constructing the read/write operation. See
:ref:`field-level-encryption-json-schema` for complete documentation on
automatic encryption rules.

The official MongoDB 4.2+ compatible drivers, :mongosh:`mongosh </>`,
The official MongoDB 4.2+ compatible drivers, :binary:`~bin.mongosh`,
and the MongoDB 4.2 or later legacy :binary:`~bin.mongo` shell use the
Enterprise-only :ref:`field-level-encryption-mongocryptd` process to
parse the automatic encryption rules and apply the encryption rules when
Expand All @@ -61,7 +61,7 @@ key management. Defer to your preferred :ref:`driver's documentation
<field-level-encryption-drivers>` for language-specific instructions on
implementing automatic client-side field level encryption.

:mongosh:`mongosh </>` adds an additional option
:binary:`~bin.mongosh` adds an additional option
to the :method:`Mongo()` method for instantiating a database
connection with automatic client-side field level encryption.
For a complete example, see
Expand All @@ -72,7 +72,7 @@ Automatic client-side field level encryption requires access to the
:ref:`mongocryptd` for complete documentation on installation. The
official MongoDB 4.2+ compatible drivers have additional options for
managing the ``mongocryptd`` process. Generally, the 4.2+ compatible
drivers and :mongosh:`mongosh </>` can access the
drivers and :binary:`~bin.mongosh` can access the
``mongocryptd`` process if it is in the system ``PATH``.

Applications must specify the following components when instantiating
Expand All @@ -89,7 +89,7 @@ encryption:
specified CMK *prior* to storing them in the key vault, leaving only
metadata unencrypted.

4.2+ compatible drivers, :mongosh:`mongosh </>`, and the MongoDB 4.2
4.2+ compatible drivers, :binary:`~bin.mongosh`, and the MongoDB 4.2
or later legacy :binary:`~bin.mongo` shell need access to the KMS to
encrypt and decrypt protected fields *or* to create new data
encryption keys.
Expand Down
12 changes: 6 additions & 6 deletions source/core/security-client-side-encryption-key-management.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ transmits the data encryption key to AWS KMS for encrypting or
decrypting using the specified Customer Master Key (CMK). The CMK never
leaves the AWS KMS.

:mongosh:`mongosh </>` supports two methods for configuring
:binary:`~bin.mongosh` supports two methods for configuring
access to an AWS KMS:

- Use the client-side field level encryption :ref:`command-line options
Expand Down Expand Up @@ -113,7 +113,7 @@ transmits the data encryption key to Azure Key Vault for encrypting or
decrypting using the specified Customer Master Key (CMK). The CMK never
leaves the Azure Key Vault.

:mongosh:`mongosh </>` supports specifying Azure Key Vault
:binary:`~bin.mongosh` supports specifying Azure Key Vault
as a KMS using the :method:`Mongo()` constructor using the
:ref:`KMS configuration options
<ClientSideFieldLevelEncryptionOptions>`.
Expand Down Expand Up @@ -152,7 +152,7 @@ transmits the data encryption key to Google Cloud KMS for encrypting or
decrypting using the specified Customer Master Key (CMK). The CMK never
leaves the Google Cloud KMS.

:mongosh:`mongosh </>` supports specifying Google Cloud KMS
:binary:`~bin.mongosh` supports specifying Google Cloud KMS
as a KMS using the :method:`Mongo()` constructor using the
:ref:`KMS configuration options
<ClientSideFieldLevelEncryptionOptions>`.
Expand Down Expand Up @@ -182,7 +182,7 @@ Google Cloud KMS, see
Locally Managed Key
~~~~~~~~~~~~~~~~~~~

:mongosh:`mongosh </>` supports specifying a locally managed key
:binary:`~bin.mongosh` supports specifying a locally managed key
as a KMS using the :method:`Mongo()` constructor. The local key *must*
be a 96-byte long string.

Expand All @@ -201,7 +201,7 @@ with client-side field level encryption. Data encryption keys are
encrypted using a Customer Master Key (CMK) managed through a supported
:ref:`Key Management System (KMS) <field-level-encryption-kms>`.

:mongosh:`mongosh </>` provides helper methods for data
:binary:`~bin.mongosh` provides helper methods for data
encryption key management:

.. list-table::
Expand Down Expand Up @@ -264,7 +264,7 @@ Data encryption keys have the following structure:
}

Client-side field level encryption depends on uniqueness of
``keyAltNames`` values. The :mongosh:`mongosh </>`
``keyAltNames`` values. The :binary:`~bin.mongosh`
:method:`KeyVault.createKey()` method creates a :ref:`unique index
<index-type-unique>` on ``keyAltNames`` if one does not exist.
Applications can use the :dbcommand:`listIndexes` command against the
Expand Down
Loading