Skip to content

Commit f266727

Browse files
(DOCSP-10907): Add info on launching mongodb shell for active deployment (mongodb#19)
* (DOCSP-10907): Add info on launching mongodb shell for active deployment * Updates per review
1 parent 9712a21 commit f266727

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

source/connect.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,43 @@ deployment from which you were disconnected:
105105

106106
.. include:: /includes/steps/activate-connection.rst
107107

108+
Launch MongoDB Shell
109+
~~~~~~~~~~~~~~~~~~~~
110+
111+
You can connect the
112+
`MongoDB Shell <https://docs.mongodb.com/mongodb-shell/>`__ or legacy
113+
:binary:`mongo <mongo>` shell to your active deployment.
114+
115+
Considerations
116+
``````````````
117+
118+
- The shell that |vsce| uses to connect to your deployment is
119+
determined by the :guilabel:`Shell` setting in your
120+
:ref:`extension settings <vsce-settings>`. You can choose either
121+
the `MongoDB Shell <https://docs.mongodb.com/mongodb-shell/>`__ or
122+
legacy :binary:`mongo <mongo>` shell.
123+
124+
- The path to your selected shell must exist in your system's ``PATH``.
125+
If it does not exist in your ``PATH``, the operation errors.
126+
127+
Procedure
128+
`````````
129+
130+
To connect the shell to your active deployment:
131+
132+
1. In the |vsce| :guilabel:`Connections` list, right-click your active
133+
deployment.
134+
135+
#. Select :guilabel:`Launch MongoDB Shell`.
136+
137+
|vsce| opens the :guilabel:`Terminal` window in VS Code and launches
138+
the shell connected to your selected deployment.
139+
140+
.. seealso::
141+
142+
`Perform CRUD Operations in the MongoDB Shell
143+
<https://docs.mongodb.com/mongodb-shell/crud>`__
144+
108145
.. _vsce-rename-connection:
109146

110147
Rename a Connection

source/index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ You can use MongoDB for |vscode-short| to:
2929
- :ref:`Connect to a MongoDB Cluster <vsce-connect>`.
3030

3131
- Once you connect to a cluster, you can launch the
32-
:binary:`mongo <mongo>` shell and automatically connect the shell
33-
to your cluster.
32+
`MongoDB Shell <https://docs.mongodb.com/mongodb-shell/>`__ and
33+
automatically connect the shell to your cluster.
3434

3535
- :ref:`Navigate your databases, collections, and documents
3636
<vsce-databases-collections>`.

0 commit comments

Comments
 (0)