Skip to content

(DOCSP-11251): Clarify that MongoDB Shell and mongosh are synonymous #23

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
merged 1 commit into from
Jul 21, 2020
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/includes/admonitions/fact-mdb-shell-beta.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. admonition:: Beta
:class: note

|mdb-shell| is currently available as a **Beta** release. The
product, its features, and the corresponding documentation may
change during the Beta stage.
The |mdb-shell| (``mongosh``) is currently available as a **Beta**
release. The product, its features, and the corresponding
documentation may change during the Beta stage.
10 changes: 5 additions & 5 deletions source/includes/steps-install-shell-base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ content: |

chmod +x /path/to/mongosh
---
title: "Add the MongoDB Shell binary to your ``PATH`` environment
title: "Add the ``mongosh`` binary to your ``PATH`` environment
variable."
ref: add-shell-to-path
level: 4
content: |

You can either:

- Copy the |mdb-shell| binary into a directory listed in your ``PATH``
- Copy the ``mongosh`` binary into a directory listed in your ``PATH``
variable, such as ``/usr/local/bin`` (Update
``/path/to/mongosh`` with your installation directory as
appropriate)
Expand All @@ -53,9 +53,9 @@ content: |

sudo cp /path/to/mongosh /usr/local/bin/

- Create a symbolic link to the |mdb-shell| binary from a directory listed in
your ``PATH`` variable, such as ``/usr/local/bin`` (Update
``/path/to/mongosh`` with your installation directory as
- Create a symbolic link to the ``mongosh`` binary from a directory
listed in your ``PATH`` variable, such as ``/usr/local/bin``
(Update ``/path/to/mongosh`` with your installation directory as
appropriate):

.. code-block:: sh
Expand Down
27 changes: 15 additions & 12 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ MongoDB Shell

.. include:: /includes/admonitions/fact-mdb-shell-beta.rst

The |mdb-shell| is a fully functional JavaScript environment for
interacting with MongoDB deployments. You can use the |mdb-shell| to
test queries and operations directly with your database.
The |mdb-shell|, ``mongosh``, is a fully functional JavaScript
environment for interacting with MongoDB deployments. You can use the
|mdb-shell| to test queries and operations directly with your database.

The |mdb-shell| is available as a standalone package in the MongoDB
``mongosh`` is available as a standalone package in the MongoDB
download center.

Download and Install the |mdb-shell|
------------------------------------

To learn how to download and install the |mdb-shell|, see
To learn how to download and install the ``mongosh`` binary, see
:ref:`mdb-shell-install`.

Connect to a MongoDB Deployment
Expand Down Expand Up @@ -78,21 +78,24 @@ you had entered into the editor.
The |mdb-shell| versus the Legacy ``mongo`` Shell
-------------------------------------------------

The |mdb-shell| offers numerous advantages over the legacy
:binary:`mongo <mongo>` shell, such as:
The new MongoDB Shell, ``mongosh``, offers numerous
advantages over the legacy :binary:`~bin.mongo` shell, such as:

- Improved syntax highlighting.

- Improved command history.

- Improved logging.

During the beta stage, the |mdb-shell| supports a subset of the legacy
:binary:`mongo <mongo>` shell commands. Extending the |mdb-shell| |api|
coverage is an ongoing effort.
During the beta stage, ``mongosh`` supports a subset of the
:binary:`~bin.mongo` shell methods. Achieving feature parity between
``mongosh`` and the ``mongo`` shell is an ongoing effort.

The commands that the |mdb-shell| supports use the same syntax as the
corresponding commands in the legacy :binary:`mongo <mongo>` shell.
To maintain backwards compatibility, the methods that ``mongosh``
supports use the same syntax as the corresponding methods in the
:binary:`~bin.mongo` shell. To see the complete list of methods
supported by ``mongosh``, see
:doc:`MongoDB Shell Methods </reference/methods>`.

Learn More
----------
Expand Down
6 changes: 3 additions & 3 deletions source/install.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _mdb-shell-install:

=======================
Install the |mdb-shell|
=======================
===================
Install ``mongosh``
===================

.. default-domain:: mongodb

Expand Down