From a6868f01bc4af612a278322a19543a1c62aa3bfb Mon Sep 17 00:00:00 2001 From: andf-mongodb Date: Thu, 5 Aug 2021 12:17:21 -0400 Subject: [PATCH] DOCSP-15031 remove DB Tools stub pages --- config/redirects | 13 ++ source/reference/program.txt | 171 +++------------------- source/reference/program/bsondump.txt | 36 ----- source/reference/program/mongodump.txt | 37 ----- source/reference/program/mongoexport.txt | 34 ----- source/reference/program/mongofiles.txt | 34 ----- source/reference/program/mongoimport.txt | 34 ----- source/reference/program/mongorestore.txt | 33 ----- source/reference/program/mongostat.txt | 36 ----- source/reference/program/mongotop.txt | 34 ----- 10 files changed, 34 insertions(+), 428 deletions(-) delete mode 100644 source/reference/program/bsondump.txt delete mode 100644 source/reference/program/mongodump.txt delete mode 100644 source/reference/program/mongoexport.txt delete mode 100644 source/reference/program/mongofiles.txt delete mode 100644 source/reference/program/mongoimport.txt delete mode 100644 source/reference/program/mongorestore.txt delete mode 100644 source/reference/program/mongostat.txt delete mode 100644 source/reference/program/mongotop.txt diff --git a/config/redirects b/config/redirects index 1f9f6bd6d39..98a824ba8ba 100644 --- a/config/redirects +++ b/config/redirects @@ -1920,3 +1920,16 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/ [v4.4]: /${version}/release-notes/5.0-compatibility -> ${base}/${version}/release-notes/4.4-compatibility/ [v4.2]: /${version}/release-notes/5.0-compatibility -> ${base}/${version}/release-notes/4.2-compatibility/ [v4.0]: /${version}/release-notes/5.0-compatibility -> ${base}/${version}/release-notes/4.0-compatibility/ + +# +# Redirecting DB Tools program pages to DB Tools repo directly +# + +[v5.0-*]: /${version}/reference/program/mongodump --> https://docs.mongodb.com/database-tools/mongodump/ +[v5.0-*]: /${version}/reference/program/mongorestore --> https://docs.mongodb.com/database-tools/mongorestore/ +[v5.0-*]: /${version}/reference/program/bsondump --> https://docs.mongodb.com/database-tools/bsondump/ +[v5.0-*]: /${version}/reference/program/mongoimport --> https://docs.mongodb.com/database-tools/mongoimport/ +[v5.0-*]: /${version}/reference/program/mongoexport --> https://docs.mongodb.com/database-tools/mongoexport/ +[v5.0-*]: /${version}/reference/program/mongostat --> https://docs.mongodb.com/database-tools/mongostat/ +[v5.0-*]: /${version}/reference/program/mongotop --> https://docs.mongodb.com/database-tools/mongotop/ +[v5.0-*]: /${version}/reference/program/mongofiles --> https://docs.mongodb.com/database-tools/mongofiles/ diff --git a/source/reference/program.txt b/source/reference/program.txt index 1bd428496e7..4181ab5c300 100644 --- a/source/reference/program.txt +++ b/source/reference/program.txt @@ -57,126 +57,6 @@ options. /reference/program/mongod.exe /reference/program/mongos.exe -Binary Import and Export Tools ------------------------------- - -:binary:`~bin.mongodump` provides a method for creating :term:`BSON` -dump files from the :binary:`~bin.mongod` instances, while -:binary:`~bin.mongorestore` makes it possible to restore these -dumps. :binary:`~bin.bsondump` converts BSON dump files into -:term:`JSON`. - -.. note:: Tools documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for these - tools have been migrated to `docs.mongodb.com/database-tools - `__: - - - :binary:`~bin.mongodump` - - :binary:`~bin.mongorestore` - - :binary:`~bin.bsondump` - - For documentation on previous versions of these tools, use the - version selector in the top-left corner of the web page to - view the documentation for your desired MongoDB version. - - *Quick Links to older documentation* - - - :v4.2:`MongoDB 4.2 Tools ` - - :v4.0:`MongoDB 4.0 Tools ` - - :v3.6:`MongoDB 3.6 Tools ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - /reference/program/mongodump - /reference/program/mongorestore - /reference/program/bsondump - -Data Import and Export Tools ----------------------------- - -:binary:`~bin.mongoimport` provides a method for taking data in :term:`JSON`, -:term:`CSV`, or :term:`TSV` and importing it into a :binary:`~bin.mongod` -instance. :binary:`~bin.mongoexport` provides a method to export data from -a :binary:`~bin.mongod` instance into JSON, CSV, or TSV. - -.. note:: - - The conversion between BSON and other formats lacks full - type fidelity. Therefore you cannot use :binary:`~bin.mongoimport` and - :binary:`~bin.mongoexport` for round-trip import and export operations. - -.. note:: Tools documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for these - tools have been migrated to `docs.mongodb.com/database-tools - `__: - - - :binary:`~bin.mongoimport` - - :binary:`~bin.mongoexport` - - For documentation on previous versions of these tools, use the - version selector in the top-left corner of the web page to - view the documentation for your desired MongoDB version. - - *Quick Links to older documentation* - - - :v4.2:`MongoDB 4.2 Tools ` - - :v4.0:`MongoDB 4.0 Tools ` - - :v3.6:`MongoDB 3.6 Tools ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - /reference/program/mongoimport - /reference/program/mongoexport - -Diagnostic Tools ----------------- - -.. note:: - - Starting in version 4.0, MongoDB offers :doc:`free Cloud monitoring - ` for standalones and replica sets. - For more information, see :doc:`/administration/free-monitoring`. - -:binary:`~bin.mongostat` and :binary:`~bin.mongotop` -provide diagnostic information related to the current operation of a -:binary:`~bin.mongod` instance. - -.. note:: Tools documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for these - tools have been migrated to `docs.mongodb.com/database-tools - `__: - - - :binary:`~bin.mongotop` - - :binary:`~bin.mongostat` - - For documentation on previous versions of these tools, use the - version selector in the top-left corner of the web page to - view the documentation for your desired MongoDB version. - - *Quick Links to older documentation* - - - :v4.2:`MongoDB 4.2 Tools ` - - :v4.0:`MongoDB 4.0 Tools ` - - :v3.6:`MongoDB 3.6 Tools ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - /reference/program/mongostat - /reference/program/mongotop - /reference/program/mongoreplay - Security Tools -------------- @@ -192,48 +72,39 @@ succeeds for a given username. /reference/program/mongoldap /reference/program/mongokerberos -GridFS ------- - -:binary:`~bin.mongofiles` provides a command-line interact to a MongoDB -:term:`GridFS` storage system. - -.. note:: Tools documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for this - tool has been migrated to `docs.mongodb.com/database-tools - `__: - - - :binary:`~bin.mongofiles` - - For documentation on previous versions of this tool, use the - version selector in the top-left corner of the web page to - view the documentation for your desired MongoDB version. +MongoDB Compass +--------------- - *Quick Links to older documentation* +.. versionadded:: 3.6 - - :v4.2:`MongoDB 4.2 Tools ` - - :v4.0:`MongoDB 4.0 Tools ` - - :v3.6:`MongoDB 3.6 Tools ` + MongoDB is packaged with an ``install_compass`` script, which + is a platform-specific installer for + :ref:`MongoDB Compass Community Edition `. .. toctree:: :maxdepth: 1 :hidden: - /reference/program/mongofiles + /reference/program/install_compass -MongoDB Compass ---------------- +MongoDB Database Tools +---------------------- -.. versionadded:: 3.6 +Starting in MongoDB 4.4, the documentation for these +tools have been migrated to `docs.mongodb.com/database-tools +`__: - MongoDB is packaged with an ``install_compass`` script, which - is a platform-specific installer for - :ref:`MongoDB Compass Community Edition `. +For documentation on previous versions of these tools, use the +version selector in the top-left corner of the web page to +view the documentation for your desired MongoDB version. + +*Quick Links to older documentation* + +- :v4.2:`MongoDB 4.2 Tools ` +- :v4.0:`MongoDB 4.0 Tools ` .. toctree:: :maxdepth: 1 :hidden: - /reference/program/install_compass \ No newline at end of file + MongoDB Database Tools \ No newline at end of file diff --git a/source/reference/program/bsondump.txt b/source/reference/program/bsondump.txt deleted file mode 100644 index ee278c68a75..00000000000 --- a/source/reference/program/bsondump.txt +++ /dev/null @@ -1,36 +0,0 @@ -============ -``bsondump`` -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -The :binary:`~bin.bsondump` converts :term:`BSON` files into human-readable -formats, including :term:`JSON`. For example, :binary:`~bin.bsondump` is useful -for reading the output files generated by :binary:`~bin.mongodump`. - -.. important:: :binary:`~bin.bsondump` is a diagnostic tool for inspecting - BSON files, not a tool for data ingestion or other application use. - -.. note:: ``bsondump`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``bsondump`` - has migrated to: - - - https://docs.mongodb.com/database-tools/bsondump - - For documentation on previous versions of ``bsondump``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`bsondump 4.2 ` - - :v4.0:`bsondump 4.0 ` - - :v3.6:`bsondump 3.6 ` diff --git a/source/reference/program/mongodump.txt b/source/reference/program/mongodump.txt deleted file mode 100644 index 2f13de3e5b8..00000000000 --- a/source/reference/program/mongodump.txt +++ /dev/null @@ -1,37 +0,0 @@ -============= -``mongodump`` -============= - -.. default-domain:: mongodb - - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -:binary:`~bin.mongodump` is a utility for creating a binary export of -the contents of a database. :binary:`~bin.mongodump` can export data -from either :binary:`~bin.mongod` or :binary:`~bin.mongos` instances; -i.e. can export data from standalone, replica set, and sharded cluster -deployments. - -.. note:: ``mongodump`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongodump`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongodump - - For documentation on previous versions of ``mongodump``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongodump 4.2 ` - - :v4.0:`mongodump 4.0 ` - - :v3.6:`mongodump 3.6 ` diff --git a/source/reference/program/mongoexport.txt b/source/reference/program/mongoexport.txt deleted file mode 100644 index 66022c8b108..00000000000 --- a/source/reference/program/mongoexport.txt +++ /dev/null @@ -1,34 +0,0 @@ -=============== -``mongoexport`` -=============== - -.. default-domain:: mongodb - - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -:binary:`~bin.mongoexport` is a command-line tool that produces a JSON -or CSV export of data stored in a MongoDB instance. - -.. note:: ``mongoexport`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongoexport`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongoexport - - For documentation on previous versions of ``mongoexport``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongoexport 4.2 ` - - :v4.0:`mongoexport 4.0 ` - - :v3.6:`mongoexport 3.6 ` diff --git a/source/reference/program/mongofiles.txt b/source/reference/program/mongofiles.txt deleted file mode 100644 index 98823f84a35..00000000000 --- a/source/reference/program/mongofiles.txt +++ /dev/null @@ -1,34 +0,0 @@ -============== -``mongofiles`` -============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -The :binary:`~bin.mongofiles` utility makes it possible to manipulate files -stored in your MongoDB instance in :term:`GridFS` objects from the -command line. It is particularly useful as it provides an interface -between objects stored in your file system and GridFS. - -.. note:: ``mongofiles`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongofiles`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongofiles - - For documentation on previous versions of ``mongofiles``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongofiles 4.2 ` - - :v4.0:`mongofiles 4.0 ` - - :v3.6:`mongofiles 3.6 ` diff --git a/source/reference/program/mongoimport.txt b/source/reference/program/mongoimport.txt deleted file mode 100644 index f47d6f53ad0..00000000000 --- a/source/reference/program/mongoimport.txt +++ /dev/null @@ -1,34 +0,0 @@ -=============== -``mongoimport`` -=============== - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -The :binary:`~bin.mongoimport` tool imports content from an -:doc:`Extended JSON `, CSV, or TSV -export created by :binary:`~bin.mongoexport`, or potentially, another -third-party export tool. - -.. note:: ``mongoimport`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongoimport`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongoimport - - For documentation on previous versions of ``mongoimport``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongoimport 4.2 ` - - :v4.0:`mongoimport 4.0 ` - - :v3.6:`mongoimport 3.6 ` diff --git a/source/reference/program/mongorestore.txt b/source/reference/program/mongorestore.txt deleted file mode 100644 index 6d212b1680c..00000000000 --- a/source/reference/program/mongorestore.txt +++ /dev/null @@ -1,33 +0,0 @@ -================ -``mongorestore`` -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -The :binary:`~bin.mongorestore` program loads data from either a binary -database dump created by :binary:`~bin.mongodump` or the standard input -into a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance. - -.. note:: ``mongorestore`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongorestore`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongorestore - - For documentation on previous versions of ``mongorestore``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongorestore 4.2 ` - - :v4.0:`mongorestore 4.0 ` - - :v3.6:`mongorestore 3.6 ` diff --git a/source/reference/program/mongostat.txt b/source/reference/program/mongostat.txt deleted file mode 100644 index c61638dc837..00000000000 --- a/source/reference/program/mongostat.txt +++ /dev/null @@ -1,36 +0,0 @@ -============= -``mongostat`` -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -The :binary:`~bin.mongostat` utility provides a quick overview of the -status of a currently running :binary:`~bin.mongod` or -:binary:`~bin.mongos` instance. :binary:`~bin.mongostat` is functionally -similar to the UNIX/Linux file system utility ``vmstat``, but provides -data regarding :binary:`~bin.mongod` and :binary:`~bin.mongos` -instances. - -.. note:: ``mongostat`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongostat`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongostat - - For documentation on previous versions of ``mongostat``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongostat 4.2 ` - - :v4.0:`mongostat 4.0 ` - - :v3.6:`mongostat 3.6 ` diff --git a/source/reference/program/mongotop.txt b/source/reference/program/mongotop.txt deleted file mode 100644 index a8e792f1139..00000000000 --- a/source/reference/program/mongotop.txt +++ /dev/null @@ -1,34 +0,0 @@ -============ -``mongotop`` -============ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -:binary:`~bin.mongotop` provides a method to track the amount of time a -MongoDB instance :binary:`~bin.mongod` spends reading and writing data. -:binary:`~bin.mongotop` provides statistics on a per-collection level. -By default, :binary:`~bin.mongotop` returns values every second. - -.. note:: ``mongotop`` documentation migrated to `MongoDB Database Tools `__ - - - Starting in MongoDB 4.4, the documentation for ``mongotop`` - has migrated to: - - - https://docs.mongodb.com/database-tools/mongotop - - For documentation on previous versions of ``mongotop``, - use the version selector in the top-left corner of this web page - to select the desired version. - - *Quick Links to older documentation* - - - :v4.2:`mongotop 4.2 ` - - :v4.0:`mongotop 4.0 ` - - :v3.6:`mongotop 3.6 `