diff --git a/snooty.toml b/snooty.toml index dcb33096b66..3944555c896 100644 --- a/snooty.toml +++ b/snooty.toml @@ -117,6 +117,7 @@ toc_landing_pages = [ "/reference/method/js-role-management", "/reference/method/js-sharding", "/reference/method/js-user-management", + "/reference/mongo", "/reference/operator/aggregation-pipeline", "/reference/operator/aggregation", "/reference/operator/query-array", diff --git a/source/contents.txt b/source/contents.txt index 17be3819063..350a00ab8cf 100644 --- a/source/contents.txt +++ b/source/contents.txt @@ -11,7 +11,6 @@ project, this Manual and additional editions of this text. - :doc:`/introduction` - :doc:`/installation` -- :doc:`/mongo` - :doc:`/crud` - :doc:`/aggregation` - :doc:`/data-modeling` @@ -35,7 +34,7 @@ project, this Manual and additional editions of this text. Introduction Installation - /mongo + MongoDB Shell (mongosh) /crud /aggregation /data-modeling diff --git a/source/includes/driver-examples/driver-example-indexes-2.rst b/source/includes/driver-examples/driver-example-indexes-2.rst index 058355dee97..5c8084b920b 100644 --- a/source/includes/driver-examples/driver-example-indexes-2.rst +++ b/source/includes/driver-examples/driver-example-indexes-2.rst @@ -11,7 +11,7 @@ .. note:: The following examples illustrate indexes and collation in - the :doc:`Mongo Shell `. + :mongosh:`mongosh `. Refer to the :compass:`MongoDB Compass Documentation diff --git a/source/includes/fact-collation-driver.rst b/source/includes/fact-collation-driver.rst index ce5099b49ef..8830f72a96e 100644 --- a/source/includes/fact-collation-driver.rst +++ b/source/includes/fact-collation-driver.rst @@ -1,7 +1,7 @@ .. note:: The following examples illustrate indexes and collation in - the :doc:`Mongo Shell `. + the :mongosh:`mongosh `. Refer to your :api:`driver documentation <>` for instructions on creating indexes with collation in your specific diff --git a/source/includes/footnote-set-shell-batch-size.rst b/source/includes/footnote-set-shell-batch-size.rst index 38354e4c248..fff68a1aecc 100644 --- a/source/includes/footnote-set-shell-batch-size.rst +++ b/source/includes/footnote-set-shell-batch-size.rst @@ -1,3 +1,4 @@ .. [#set-shell-batch-size] You can set the ``DBQuery.shellBatchSize`` attribute to change the number of documents from the default value of ``20``. + diff --git a/source/includes/steps-run-mongodb-on-linux-tarball.yaml b/source/includes/steps-run-mongodb-on-linux-tarball.yaml index 2c147f9b13f..d14e49ebf73 100644 --- a/source/includes/steps-run-mongodb-on-linux-tarball.yaml +++ b/source/includes/steps-run-mongodb-on-linux-tarball.yaml @@ -75,7 +75,7 @@ post: | For more information on connecting using the :binary:`~bin.mongo` shell, such as to connect to a :binary:`~bin.mongod` instance running - on a different host and/or port, see :doc:`/mongo`. + on a different host and/or port, see :doc:`/reference/mongo`. To help you start using MongoDB, MongoDB provides :ref:`Getting Started Guides ` in various driver editions. For the diff --git a/source/includes/steps-run-mongodb-on-linux.yaml b/source/includes/steps-run-mongodb-on-linux.yaml index 7d6c2ea391c..769712e6e74 100644 --- a/source/includes/steps-run-mongodb-on-linux.yaml +++ b/source/includes/steps-run-mongodb-on-linux.yaml @@ -97,7 +97,7 @@ post: | For more information on connecting using the :binary:`~bin.mongo` shell, such as to connect to a :binary:`~bin.mongod` instance running - on a different host and/or port, see :doc:`/mongo`. + on a different host and/or port, see :doc:`/reference/mongo`. To help you start using MongoDB, MongoDB provides :ref:`Getting Started Guides ` in various driver editions. For the diff --git a/source/includes/steps-run-mongodb-on-osx.yaml b/source/includes/steps-run-mongodb-on-osx.yaml index 75ce914cc41..abffe807625 100644 --- a/source/includes/steps-run-mongodb-on-osx.yaml +++ b/source/includes/steps-run-mongodb-on-osx.yaml @@ -118,7 +118,7 @@ post: | For more information on connecting using the :binary:`~bin.mongo` shell, such as to connect to a :binary:`~bin.mongod` instance running - on a different host and/or port, see :doc:`/mongo`. + on a different host and/or port, see :doc:`/reference/mongo`. To help you start using MongoDB, MongoDB provides :ref:`Getting Started Guides ` in various driver editions. See diff --git a/source/includes/steps-run-mongodb-on-windows.yaml b/source/includes/steps-run-mongodb-on-windows.yaml index 101dafbee11..0625aaa2182 100644 --- a/source/includes/steps-run-mongodb-on-windows.yaml +++ b/source/includes/steps-run-mongodb-on-windows.yaml @@ -66,7 +66,7 @@ content: | For more information on connecting a :binary:`mongo.exe ` shell, such as to connect to a MongoDB instance running on a different - host and/or port, see :doc:`/mongo`. For information on CRUD + host and/or port, see :doc:`/reference/mongo`. For information on CRUD (Create,Read,Update,Delete) operations, see: - :doc:`/tutorial/insert-documents` diff --git a/source/reference.txt b/source/reference.txt index dd481bcd3ca..46bb2a5e5bb 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -19,8 +19,12 @@ Reference command>` operations, syntax, and use. :doc:`/reference/method` - Documentation of all JavaScript methods and helpers in the - :binary:`~bin.mongo` shell. + Documentation of JavaScript methods and helpers in + :mongosh:`mongosh `. + +:doc:`/reference/mongo` + Documentation of JavaScript methods and helpers in + the legacy :binary:`~bin.mongo` shell. :doc:`/reference/program` Documentation of :binary:`~bin.mongod` and :binary:`~bin.mongos` @@ -95,6 +99,7 @@ Reference /reference/operator /reference/command /reference/method + /reference/mongo /reference/program /reference/configuration-options /reference/parameters diff --git a/source/mongo.txt b/source/reference/mongo.txt similarity index 77% rename from source/mongo.txt rename to source/reference/mongo.txt index 9794f6605e8..5135044e149 100644 --- a/source/mongo.txt +++ b/source/reference/mongo.txt @@ -1,9 +1,15 @@ -=================== -The ``mongo`` Shell -=================== +====================== +Legacy ``mongo`` Shell +====================== .. default-domain:: mongodb +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + .. note:: The ``mongo`` shell has been deprecated in MongoDB v5.0. The @@ -44,8 +50,15 @@ The list of methods supported by ``mongosh`` is here: .. seealso:: - - :doc:`Getting Started Guide for the mongo Shell - ` - :binary:`~bin.mongo` Reference Page - :mongosh:`mongosh Documentation ` +.. toctree:: + :titlesonly: + + /tutorial/configure-mongo-shell + /tutorial/access-mongo-shell-help + /tutorial/write-scripts-for-the-mongo-shell + /core/shell-types + /reference/mongo-shell + diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt index 06cf4d933fa..3fb214b33ee 100644 --- a/source/reference/program/mongo.txt +++ b/source/reference/program/mongo.txt @@ -1420,7 +1420,7 @@ to enclose the JavaScript, using the following form: - :doc:`/reference/mongo-shell` - :doc:`/reference/method` - - :doc:`/mongo` + - :doc:`/reference/mongo` - :method:`isInteractive()` diff --git a/source/tutorial/install-mongodb-enterprise-on-windows.txt b/source/tutorial/install-mongodb-enterprise-on-windows.txt index 258e1a2f6e5..ea03ea210f2 100644 --- a/source/tutorial/install-mongodb-enterprise-on-windows.txt +++ b/source/tutorial/install-mongodb-enterprise-on-windows.txt @@ -144,7 +144,7 @@ Interpreter` with Administrative privileges and run: For more information on connecting a :binary:`mongo.exe ` shell, such as to connect to a MongoDB instance running on a different -host and/or port, see :doc:`/mongo`. For information on CRUD +host and/or port, see :doc:`/reference/mongo`. For information on CRUD (Create,Read,Update,Delete) operations, see: - :doc:`/tutorial/insert-documents` diff --git a/source/tutorial/install-mongodb-on-windows.txt b/source/tutorial/install-mongodb-on-windows.txt index eae45e72cef..000d44723f0 100644 --- a/source/tutorial/install-mongodb-on-windows.txt +++ b/source/tutorial/install-mongodb-on-windows.txt @@ -133,7 +133,7 @@ Interpreter` with Administrative privileges and run: For more information on connecting a :binary:`mongo.exe ` shell, such as to connect to a MongoDB instance running on a different -host and/or port, see :doc:`/mongo`. For information on CRUD +host and/or port, see :doc:`/reference/mongo`. For information on CRUD (Create,Read,Update,Delete) operations, see: - :doc:`/tutorial/insert-documents`