(DOCSP-10727): Add topic for embedded mdb shell (#266)

Author: jeff-allen-mongo

source/embedded-shell.txt

@@ -0,0 +1,93 @@
+.. _embedded-mongodb-shell:
+
+======================
+Embedded MongoDB Shell
+======================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Starting in version 1.22, |compass| contains an embedded
+`MongoDB Shell <https://docs.mongodb.com/mongodb-shell/>`__. The
+MongoDB Shell is a fully functional JavaScript environment for
+interacting with MongoDB deployments. You can use the MongoDB Shell to
+test queries and operations directly with your database.
+
+Open the Embedded MongoDB Shell
+-------------------------------
+
+To open the embedded MongoDB Shell, click :guilabel:`MongoSH Beta`
+along the bottom of |compass|.
+
+Use the Embedded MongoDB Shell
+------------------------------
+
+When you initially open the MongoDB Shell, it connects to the
+``test`` database. To switch to a different database, run
+the following command in the MongoDB Shell:
+
+.. code-block:: sh
+
+   use <database name>
+
+To run an operation in the embedded MongoDB Shell, type the operation
+into the shell and press :guilabel:`Enter`.
+
+.. example::
+
+   .. code-block:: sh
+
+      db.employees.find( { "last_name": "Smith" } )
+
+   .. seealso::
+
+      :manual:`db.collection.find()
+      </reference/method/db.collection.find>`
+
+Multi-Line Operations in the Embedded MongoDB Shell
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To write an operation that spans multiple lines in the embedded
+MongoDB Shell, press :guilabel:`Shift + Enter` to begin the next 
+line of code.
+
+When you are finished writing your operation, press :guilabel:`Enter`
+to run it.
+
+.. example::
+
+   .. code-block:: javascript
+
+      db.employees.aggregate( [              // press Shift + Enter
+        { $match: { "last_name": "Smith" } } // press Shift + Enter
+      ] )                                    // Press Enter
+
+   .. seealso::
+
+      :pipeline:`$match`
+
+Learn More
+~~~~~~~~~~
+
+The following links direct to the
+`MongoDB Shell Documentation
+<https://docs.mongodb.com/mongodb-shell/>`__, which contains more
+complete reference for the MongoDB Shell, including syntax and
+behaviors.
+
+- Learn how to
+  `Perform CRUD Operations in the MongoDB Shell
+  <https://docs.mongodb.com/mongodb-shell/crud>`__.
+
+- Learn how to
+  `Run Aggregation Pipelines in the MongoDB Shell
+  <https://docs.mongodb.com/mongodb-shell/run-agg-pipelines>`__.
+
+- See a complete list of
+  `Available MongoDB Shell Methods
+  <https://docs.mongodb.com/mongodb-shell/reference/methods>`__.

source/index.txt

@@ -170,6 +170,7 @@ suit your needs.
       /manage-data
       /aggregation-pipeline-builder
       /import-export
+      /embedded-shell
       /troubleshooting
       /faq
       /learn-more