Skip to content

Commit 3ec4bc3

Browse files
committed
DOCSP-15525 update Manual for mongosh - binary link
1 parent f75d68b commit 3ec4bc3

File tree

357 files changed

+1256
-1243
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

357 files changed

+1256
-1243
lines changed

source/administration/configuration.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,8 @@ among all members of the set. Consider the following:
235235
replication:
236236
replSetName: set0
237237

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

241241
.. seealso::
242242

source/administration/monitoring.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -499,15 +499,15 @@ has a background :term:`balancer` process that distributes data to ensure that
499499
chunks are always optimally distributed among the :term:`shards <shard>`.
500500

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

506506
Stale Locks
507507
~~~~~~~~~~~
508508

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

source/administration/production-notes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ MongoDB requires the following minimum ``x86_64`` microarchitectures:
5656
- For AMD ``x86_64``, MongoDB requires *Bulldozer* or later.
5757

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

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

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

8282
.. include:: /includes/fact-platform-arm64.rst

source/appendix/security/appendixA-openssl-ca.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ B. Generate the Test CA PEM File
159159
cat mongodb-test-ca.crt mongodb-test-ia.crt > test-ca.pem
160160

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

164164
You can use the :red:`test` intermediate authority to sign the :red:`test`
165165
certificates for both the server(s) and client(s). A single authority

source/appendix/security/appendixC-openssl-client.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ B. Generate the Test PEM File for Client
132132

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

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

139139
.. example::
140140

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

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

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

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

source/changeStreams.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ You can open change streams against:
6969

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

7575
* - A database
@@ -80,7 +80,7 @@ You can open change streams against:
8080
collections.
8181

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

8686

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

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

9898
.. note:: Change Stream Examples

source/core/aggregation-pipeline.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ exception of :pipeline:`$out`, :pipeline:`$merge`, and
4949
of all available stages, see
5050
:ref:`aggregation-pipeline-operator-reference`.
5151

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

5655
For example usage of the aggregation pipeline, consider
5756
:doc:`/tutorial/aggregation-with-user-preference-data` and

source/core/authentication-mechanisms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ To specify the authentication mechanism to use, set the
4646
:binary:`~bin.mongos`.
4747

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

5252
.. toctree::

source/core/capped-collections.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,12 +144,12 @@ Create a Capped Collection
144144
~~~~~~~~~~~~~~~~~~~~~~~~~~
145145

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

154154
.. code-block:: javascript
155155

source/core/databases-and-collections.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ gathered together in :term:`collections <collection>`. A
2121
Databases
2222
---------
2323
In MongoDB, databases hold one or more collections of documents. To
24-
select a database to use, in the :binary:`~bin.mongo` shell, issue the
24+
select a database to use, in :mongosh:`mongosh </>`, issue the
2525
``use <db>`` statement, as in the following example:
2626

2727
.. code-block:: javascript
@@ -33,8 +33,8 @@ Create a Database
3333

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

3939
.. code-block:: javascript
4040

0 commit comments

Comments
 (0)