Skip to content

Commit 85de064

Browse files
author
Dave
authored
DOCSP- 20949 update mongosh naming (#378)
* DOCSP-20949 update mongosh naming * DOCSP-20949 update mongosh naming * DOCSP-20949 update mongosh naming * Update interspinx * DOCSP-20949 update mongosh naming * DOCSP-20949 update mongosh naming * review feedback
1 parent 2bfc2f8 commit 85de064

File tree

2 files changed

+30
-34
lines changed

2 files changed

+30
-34
lines changed

snooty.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
name = "compass"
22
title = "MongoDB Compass"
33

4-
intersphinx = ["https://docs.mongodb.com/manual/objects.inv", "https://docs.mongodb.com/database-tools/objects.inv"]
4+
intersphinx = [
5+
"https://docs.mongodb.com/manual/objects.inv",
6+
"https://docs.mongodb.com/database-tools/objects.inv",
7+
"https://docs.mongodb.com/mongodb-shell/objects.inv"
8+
]
59

610
toc_landing_pages = ["/install", "/connect", "/instance", "/query/filter", "/query/queries",
711
"/documents", "/schema", "/aggregation-pipeline-builder"]

source/embedded-shell.txt

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,23 @@ Embedded MongoDB Shell
1212
:depth: 1
1313
:class: singlecol
1414

15-
Starting in version 1.22, |compass| contains an embedded
16-
`MongoDB Shell <https://docs.mongodb.com/mongodb-shell/>`__. The
17-
MongoDB Shell is a fully functional JavaScript environment for
18-
interacting with MongoDB deployments. You can use the MongoDB Shell to
19-
test queries and operations directly with your database.
15+
Starting in version 1.22, |compass| contains an embedded shell,
16+
:binary:`mongosh`. :binary:`mongosh` is a JavaScript environment for
17+
interacting with MongoDB deployments. You can use :binary:`mongosh`
18+
to test queries and operations in your database.
2019

2120
Open the Embedded MongoDB Shell
2221
-------------------------------
2322

24-
To open the embedded MongoDB Shell, click :guilabel:`MongoSH Beta`
25-
along the bottom of |compass|.
23+
To open the embedded :binary:`mongosh`, click :guilabel:`_MONGOSH`
24+
at the bottom of the |compass| window.
2625

2726
Use the Embedded MongoDB Shell
2827
------------------------------
2928

30-
When you initially open the MongoDB Shell, it connects to the
31-
``test`` database. To switch to a different database, run
32-
the following command in the MongoDB Shell:
29+
By default, :binary:`mongosh`, connects to the ``test`` database.
30+
To use a different database, run the following command in
31+
:binary:`mongosh`:
3332

3433
.. code-block:: sh
3534

@@ -38,27 +37,27 @@ the following command in the MongoDB Shell:
3837
To run an operation in the embedded MongoDB Shell, type the operation
3938
into the shell and press :guilabel:`Enter`.
4039

40+
The following example runs a :method:`db.collection.find()` operation:
41+
4142
.. example::
4243

4344
.. code-block:: sh
4445

4546
db.employees.find( { "last_name": "Smith" } )
4647

47-
.. seealso::
48-
49-
:manual:`db.collection.find()
50-
</reference/method/db.collection.find>`
51-
5248
Multi-Line Operations in the Embedded MongoDB Shell
5349
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5450

5551
To write an operation that spans multiple lines in the embedded
56-
MongoDB Shell, press :guilabel:`Shift + Enter` to begin the next
57-
line of code.
52+
:binary:`mongosh`, begin with the first line, then press
53+
:guilabel:`Shift + Enter` to move to the next line of code.
5854

5955
When you are finished writing your operation, press :guilabel:`Enter`
6056
to run it.
6157

58+
The following multi-line example runs the :pipeline:`$match` stage in
59+
an :ref:`aggregation pipeline <aggregation-pipeline>`:
60+
6261
.. example::
6362

6463
.. code-block:: javascript
@@ -67,27 +66,20 @@ to run it.
6766
{ $match: { "last_name": "Smith" } } // press Shift + Enter
6867
] ) // Press Enter
6968

70-
.. seealso::
71-
72-
:pipeline:`$match`
73-
7469
Learn More
7570
~~~~~~~~~~
7671

7772
The following links direct to the
78-
`MongoDB Shell Documentation
79-
<https://docs.mongodb.com/mongodb-shell/>`__, which contains more
80-
complete reference for the MongoDB Shell, including syntax and
73+
:ref:`mongosh documentation <mdb-shell-overview>`, which contains
74+
more a complete reference for :binary:`mongosh`, including syntax and
8175
behaviors.
8276

83-
- Learn how to
84-
`Perform CRUD Operations in the MongoDB Shell
85-
<https://docs.mongodb.com/mongodb-shell/crud>`__.
77+
- Learn how to :ref:`perform CRUD operations <mdb-shell-crud>` in
78+
:binary:`mongosh`.
79+
80+
- Learn how to :ref:`run aggregation pipelines <mdb-shell-aggregation>`
81+
in :binary:`mongosh`.
8682

87-
- Learn how to
88-
`Run Aggregation Pipelines in the MongoDB Shell
89-
<https://docs.mongodb.com/mongodb-shell/run-agg-pipelines>`__.
83+
- See a complete list of :binary:`mongosh` :ref:`methods
84+
<mdb-shell-methods>`.
9085

91-
- See a complete list of
92-
`Available MongoDB Shell Methods
93-
<https://docs.mongodb.com/mongodb-shell/reference/methods>`__.

0 commit comments

Comments
 (0)