From b429adcdd12c8d2d21a04ace93b4816c2a1527a7 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Mon, 4 May 2020 13:53:31 -0400 Subject: [PATCH] DOCSP-8644 install doc and availability updates --- README.md | 17 +- source/bsondump.txt | 42 +++-- source/includes/extracts-compatibility.yaml | 24 +-- .../extracts-download-from-tools.yaml | 81 ---------- source/includes/extracts-version.yaml | 32 ++++ source/includes/fact-platform-support.rst | 102 ++++++++++++ source/includes/fact-see-install-guide.rst | 6 + source/index.txt | 148 ++---------------- source/installation.txt | 136 ++++++++++++++++ source/mongodump.txt | 82 ++++++---- source/mongoexport.txt | 46 +++--- source/mongofiles.txt | 41 +++-- source/mongoimport.txt | 45 ++++-- source/mongorestore.txt | 68 ++++---- source/mongostat.txt | 41 +++-- source/mongotop.txt | 40 +++-- 16 files changed, 562 insertions(+), 389 deletions(-) delete mode 100644 source/includes/extracts-download-from-tools.yaml create mode 100644 source/includes/extracts-version.yaml create mode 100644 source/includes/fact-platform-support.rst create mode 100644 source/includes/fact-see-install-guide.rst create mode 100644 source/installation.txt diff --git a/README.md b/README.md index cd5bd15c..83a201e7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # docs-commandline-tools -This repository contains documentation for the MongoDB commandline tools (v4.4+) +This repository contains documentation for the MongoDB Database Tools +(`mongoimport`, `mongoexport`, etc.). Beginning with MongoDB 4.4, the +Database Tools are released separately from the core server package. +Consequently, the MongoDB Database Tools documentation has also been +moved to its own repository, maintained here, and is no longer part of +the core Server Manual from version 4.4 onwards. -This project is currently under construction. Please pardon our dust! +The documentation for previous versions of the Database Tools can be +found in the Server Manual repository: + +- https://github.com/mongodb/docs + +The live documentation for the Database Tools can be found at the +following URL: + +- https://docs.mongodb.com/database-tools/ Report Issues ------------- diff --git a/source/bsondump.txt b/source/bsondump.txt index e6c11f39..87b93c66 100644 --- a/source/bsondump.txt +++ b/source/bsondump.txt @@ -12,6 +12,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.bsondump` Synopsis @@ -21,8 +22,6 @@ 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`. -.. include:: /includes/extracts/require-cmd-line-bsondump.rst - .. important:: :binary:`~bin.bsondump` is a diagnostic tool for inspecting BSON files, not a tool for data ingestion or other application use. @@ -30,33 +29,42 @@ for reading the output files generated by :binary:`~bin.mongodump`. (Canonical mode) ` to format its data. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-bsondump.rst -.. note:: +Versioning +~~~~~~~~~~ - This documentation is for {+release+} of :binary:`~bin.bsondump`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``bsondump``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 bsondump `__ - `MongoDB 4.0 bsondump `__ - `MongoDB 3.6 bsondump `__ -.. include:: /includes/extracts/require-cmd-line-bsondump.rst - -Availability ------------- - -.. include:: /includes/extracts/download-from-tools-bsondump.rst +This documentation is for version ``{+release+}`` of |tool-binary|. Compatibility ------------- -.. include:: /includes/extracts/dbtool-compatibility-single.rst +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-compatibility-single.rst + +Platform Support +~~~~~~~~~~~~~~~~ + +|tool-binary| version ``{+release+}`` is supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst + +Installation +------------ + +.. include:: /includes/fact-see-install-guide.rst Options ------- diff --git a/source/includes/extracts-compatibility.yaml b/source/includes/extracts-compatibility.yaml index 6e389439..4a39bf44 100644 --- a/source/includes/extracts-compatibility.yaml +++ b/source/includes/extracts-compatibility.yaml @@ -1,22 +1,23 @@ ref: dbtools-compatibility-all content: | - The {+dbtools+} support the following versions of the MongoDB server: + {+dbtools+} version ``{+release+}`` supports the following versions + of the MongoDB server: - MongoDB 4.4 - MongoDB 4.2 - MongoDB 4.0 - MongoDB 3.6 - While the tools may work on earlier versions of MongoDB server, any such - compatibility is not guaranteed. + While the tools may work on earlier versions of MongoDB server, any + such compatibility is not guaranteed. --- -ref: dbtool-compatibility-single +ref: dbtools-compatibility-single content: | - The |tool-binary| supports the following versions of the MongoDB - Server: + |tool-binary| version ``{+release+}`` supports the following versions + of the MongoDB Server: - MongoDB 4.4 - MongoDB 4.2 @@ -25,13 +26,4 @@ content: | While |tool-binary| may work on earlier versions of MongoDB server, any such compatibility is not guaranteed. ---- -ref: dbtool-new-release -content: | - - |tool-binary| releases as version ``100`` and has an independent - release schedule from the MongoDB Server. Previously, |tool-binary| - was released alongside the MongoDB Server and used matching - versioning. - -... \ No newline at end of file +... diff --git a/source/includes/extracts-download-from-tools.yaml b/source/includes/extracts-download-from-tools.yaml deleted file mode 100644 index a21f56d5..00000000 --- a/source/includes/extracts-download-from-tools.yaml +++ /dev/null @@ -1,81 +0,0 @@ -ref: _download-from-tools -content: | - The {{command}} tool is part of the {+dbtools+} package. You can - install the {+dbtools+} package in one of two ways: - - #. Follow the :ref:`installation guide` for - your platform to install the {+dbtools+} as part of a MongoDB - Server installation. The {+dbtools+} are included with both - Community Edition and Enterprise Edition installations. - - #. Download the {+dbtools+} separately from the - `MongoDB Download Center - `__, - either as a separate {+dbtools-pkg+} download, or contained within the - ``TGZ`` or ``ZIP`` downloads, depending on platform. {{windows}} - ---- -ref: download-from-tools-mongodump -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongodump` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongorestore -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongorestore` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-bsondump -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.bsondump` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongoimport -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongoimport` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongoexport -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongoexport` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongostat -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongostat` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongotop -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongotop` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." ---- -ref: download-from-tools-mongofiles -inherit: - file: extracts-download-from-tools.yaml - ref: _download-from-tools -replacement: - command: :binary:`~bin.mongofiles` - windows: "On Windows, the ``MSI`` installer includes all tools as part of the default installation." -... diff --git a/source/includes/extracts-version.yaml b/source/includes/extracts-version.yaml new file mode 100644 index 00000000..93b2678c --- /dev/null +++ b/source/includes/extracts-version.yaml @@ -0,0 +1,32 @@ +ref: dbtools-version-all +content: | + + Starting with MongoDB 4.4, the {+dbtools+} are now released separately + from the MongoDB Server and use their own versioning, with an initial + version of ``100``. Previously, these tools were released alongside + the MongoDB Server and used matching versioning. + + For documentation on the MongoDB 4.2 or earlier versions of these + tools, reference the :manual:`MongoDB Server Documentation + ` for that version of the tool: + + .. admonition:: Quick links to older documentation + :class: note + + - `MongoDB 4.2 Tools `__ + - `MongoDB 4.0 Tools `__ + - `MongoDB 3.6 Tools `__ + +--- +ref: dbtools-version-single +content: | + + Starting with MongoDB 4.4, |tool-binary| is now released separately + from the MongoDB Server and uses its own versioning, with an initial + version of ``100``. Previously, |tool-binary| was released alongside + the MongoDB Server and used matching versioning. + + For documentation on the MongoDB 4.2 or earlier versions of + |tool-binary|, reference the :manual:`MongoDB Server Documentation + ` for that version of the tool: + diff --git a/source/includes/fact-platform-support.rst b/source/includes/fact-platform-support.rst new file mode 100644 index 00000000..0c5d298b --- /dev/null +++ b/source/includes/fact-platform-support.rst @@ -0,0 +1,102 @@ +.. |checkmark| unicode:: U+2713 + +.. list-table:: + :header-rows: 1 + :class: compatibility + :widths: 40 15 15 15 15 + + * - + - x86_64 + - ARM64 + - PPC64LE + - s390x + + * - Amazon 2 + - |checkmark| + - + - + - + + * - Amazon 2013.03+ + - |checkmark| + - + - + - + + * - Debian 10 + - |checkmark| + - + - + - + + * - Debian 9 + - |checkmark| + - + - + - + + * - Debian 8 + - |checkmark| + - + - + - + + * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 8 + - |checkmark| + - + - |checkmark| + - + + * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 7 + - |checkmark| + - + - |checkmark| + - |checkmark| + + * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 6 + - |checkmark| + - + - + - |checkmark| + + * - SUSE 12 + - |checkmark| + - + - + - + + * - Ubuntu 20 + - |checkmark| + - + - + - + + * - Ubuntu 18 + - |checkmark| + - |checkmark| + - |checkmark| + - |checkmark| + + * - Ubuntu 16 + - |checkmark| + - |checkmark| + - |checkmark| + - |checkmark| + + * - Windows 8 and later + - |checkmark| + - + - + - + + * - Windows Server 2012 and later + - |checkmark| + - + - + - + + * - macOS 10.12 or later + - |checkmark| + - + - + - \ No newline at end of file diff --git a/source/includes/fact-see-install-guide.rst b/source/includes/fact-see-install-guide.rst new file mode 100644 index 00000000..7e8da71a --- /dev/null +++ b/source/includes/fact-see-install-guide.rst @@ -0,0 +1,6 @@ +The |tool-binary| tool is part of the *{+dbtools+}* package: + +.. container:: + + |arrow| Follow the :ref:`{+dbtools-short+} Installation Guide + ` to install |tool-binary|. diff --git a/source/index.txt b/source/index.txt index 4e219b86..3b2b0236 100644 --- a/source/index.txt +++ b/source/index.txt @@ -8,7 +8,6 @@ The MongoDB Database Tools Documentation .. Above is a hack for indenting the table contents, since other .. strategies failed. - The {+dbtools+} are a collection of command-line utilities for working with a MongoDB deployment. The {+dbtools-short+} include the following binaries: @@ -43,7 +42,6 @@ binaries: - Produces a :term:`JSON` or :term:`CSV` export of data stored in a :binary:`~bin.mongod` instance. - * - :guilabel:`Diagnostic Tools` - @@ -58,133 +56,14 @@ binaries: * - :guilabel:`GridFS Tools` - - * - |nbspc| |nbspc| :binary:`~bin.mongofiles` - Supports manipulating files stored in your MongoDB instance in :term:`GridFS` objects. -The {+dbtools+} release as version ``100`` and have an independent -release schedule from the MongoDB Server. Previously, these tools were -released alongside the MongoDB Server and used matching versioning. For -documentation on the MongoDB 4.2 or earlier versions of these tools, -reference the :manual:`MongoDB Server Documentation -` for that version of the tool: - -.. admonition:: Quick links to older documentation - :class: note - - - `MongoDB 4.2 Tools `__ - - `MongoDB 4.0 Tools `__ - - `MongoDB 3.6 Tools `__ - -.. toctree:: - :maxdepth: 1 - :hidden: - - mongodump - mongorestore - bsondump - mongoimport - mongoexport - mongostat - mongotop - mongofiles - - -MongoDB Server Compatibility ----------------------------- +Versioning +---------- -.. include:: /includes/extracts/dbtools-compatibility-all.rst - -Supported Platforms -------------------- - -The {+dbtools+} are supported on the following platforms: - -.. |checkmark| unicode:: U+2713 - -.. list-table:: - :header-rows: 1 - :class: borderless - :widths: 40 15 15 15 15 - - * - - - x86_64 - - ARM64 - - PPC64LE - - s390x - - * - Amazon 2 - - |checkmark| - - - - - - - - * - Amazon 2013.03+ - - |checkmark| - - - - - - - - * - Debian 9 - - |checkmark| - - - - - - - - * - Debian 8 - - |checkmark| - - - - - - - - * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 7 - - |checkmark| - - - - |checkmark| - - |checkmark| - - * - :abbr:`RHEL (Red Hat Enterprise Linux)` / CentOS 6 - - |checkmark| - - - - - - |checkmark| - - * - SUSE 12 - - |checkmark| - - - - - - - - * - Ubuntu 18 - - |checkmark| - - |checkmark| - - |checkmark| - - |checkmark| - - * - Ubuntu 16 - - |checkmark| - - |checkmark| - - |checkmark| - - |checkmark| - - * - Ubuntu 14 - - |checkmark| - - - - - - - - * - Windows 8 and later - - |checkmark| - - - - - - - - * - macOS 10.14 or later - - |checkmark| - - - - - - +.. include:: /includes/extracts/dbtools-version-all.rst Additional Resources -------------------- @@ -196,7 +75,6 @@ For instructions on how to file a JIRA ticket for the MongoDB server or one of the related projects, see ``_. - Community ~~~~~~~~~ @@ -236,11 +114,17 @@ Further Reading .. _`MongoDB, Inc.`: https://www.mongodb.com?tck=docs_databasetools -.. |arrow| unicode:: U+27A4 - -.. class:: hidden - - .. toctree:: - :titlesonly: - +.. toctree:: + :maxdepth: 1 + :hidden: + /installation + mongodump + mongorestore + bsondump + mongoimport + mongoexport + mongostat + mongotop + mongofiles + \ No newline at end of file diff --git a/source/installation.txt b/source/installation.txt new file mode 100644 index 00000000..e31dfa48 --- /dev/null +++ b/source/installation.txt @@ -0,0 +1,136 @@ +.. _dbtools_installation: + +============================== +Installation and Compatibility +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Overview +-------- + +The {+dbtools+} are command-line utilities for working with MongoDB. +Use this guide to install the {+dbtools-short+} on your platform. + +Versioning +~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-version-all.rst + +Compatibility +------------- + +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-compatibility-all.rst + +Platform Support +~~~~~~~~~~~~~~~~ + +The {+dbtools+} version ``{+release+}`` are supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst + +.. _install-tools: + +Installation +------------ + +The {+dbtools+} can be :ref:`installed with the MongoDB Server +` on Linux platforms, or as a +:ref:`standalone installation ` on all +platforms. + +.. _installed-with-server: + +Install with Server - Linux Platforms +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To install the {+dbtools+} as part of a MongoDB Server installation on +Linux, you must use your Linux distribution's package manager to install +the Server: + +- Follow the instructions for your platform according to the MongoDB + Edition you wish to install: + + - :manual:`Install MongoDB Server Community Edition `. + + - :manual:`Install MongoDB Server Enterprise Edition `. + +- After completing the installation, the {+dbtools-short+} are available + in the same location as the Server. + +If you wish to install the {+dbtools-short+} via your Linux package +manager without installing the Server, see +:ref:`standalone-installation-package-manager`. + +.. _standalone-installation: + +Install as Standalone - All Platforms +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To install the {+dbtools+} as a standalone installation, for all +supported platforms: + +- Follow the download link for your MongoDB Edition: + + - `MongoDB Community Download Center `_ + + - `MongoDB Enterprise Download Center `_ + +- Select your :guilabel:`OS` (operating system) from the dropdown menu, + then select the appropriate :guilabel:`Package` for your platform + according to the following chart: + + .. list-table:: + :header-rows: 1 + :class: borderless + + * - OS + + - Package + + * - *Linux* + + - ``TGZ`` package + + * - *Windows* + + - ``ZIP`` package + + * - *macOS* + + - ``TGZ`` package + +- Once downloaded, unpack the archive and copy the tools to a location + on your hard drive. + + .. tip:: + + Linux and macOS users may wish to copy the tools to a filesystem + location that is defined in the ``$PATH`` environment variable, + such as ``/usr/bin``. Doing so allows referencing each tool + directly on the command line by name, without needing to specify + its full path, or first navigating to its parent directory. See the + :ref:`installation guide ` for your platform + for more information. + +.. _standalone-installation-package-manager: + +Install as Standalone - Linux Package Manager +````````````````````````````````````````````` + +Linux users may alternatively choose to install the {+dbtools-short+} +using their system's package manager (e.g. ``yum`` or ``apt``) +separately from the Server. To do so, follow the +:ref:`installation guide ` for your platform, +specifying ``mongodb-database-tools`` instead of ``mongodb-org`` or +``mongodb-enterprise`` during the installation step. diff --git a/source/mongodump.txt b/source/mongodump.txt index 1eaacfda..75f42cf8 100644 --- a/source/mongodump.txt +++ b/source/mongodump.txt @@ -15,6 +15,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongodump` Synopsis @@ -26,58 +27,47 @@ from either :binary:`~bin.mongod` or :binary:`~bin.mongos` instances; i.e. can export data from standalone, replica set, and sharded cluster deployments. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongodump.rst -.. note:: +.. seealso:: - This documentation is for version ``{+release+}`` of - :binary:`~bin.mongodump`. - - For documentation on the MongoDB 4.2 or earlier version of - ``mongodump``, reference the :manual:`MongoDB Server Documentation - ` for that version. + :binary:`~bin.mongorestore` which provides the corresponding + binary data import capability. - *Quick links to older documentation* +Versioning +~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-version-single.rst + +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongodump `__ - `MongoDB 4.0 mongodump `__ - `MongoDB 3.6 mongodump `__ -.. include:: /includes/extracts/require-cmd-line-mongodump.rst - -Availability ------------- - -.. include:: /includes/extracts/download-from-tools-mongodump.rst +This documentation is for version ``{+release+}`` of |tool-binary|. Compatibility ------------- -.. include:: /includes/extracts/dbtool-compatibility-single.rst - -Usage in Backup Strategy ------------------------- - -Standalones/Replica Sets -~~~~~~~~~~~~~~~~~~~~~~~~ +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For standalone or a replica set, :binary:`~bin.mongodump` can be a part -of a :ref:`backup strategy ` with -:binary:`~bin.mongorestore` for partial backups based on a query, -syncing from production to staging or development environments, or -changing the storage engine of a standalone. +.. include:: /includes/extracts/dbtools-compatibility-single.rst -For an overview of :binary:`~bin.mongodump` in conjunction with -:binary:`~bin.mongorestore` part of a backup and recovery strategy, see: +Platform Support +~~~~~~~~~~~~~~~~ -- :manual:`Back Up and Restore with MongoDB Tools` +|tool-binary| version ``{+release+}`` is supported on the following +platforms: -- :manual:`MongoDB Backup Methods` +.. include:: /includes/fact-platform-support.rst -Sharded Clusters -~~~~~~~~~~~~~~~~ +Installation +------------ -.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst +.. include:: /includes/fact-see-install-guide.rst Syntax ------ @@ -334,6 +324,30 @@ privileges that grant :authaction:`find` action for each database to back up. The built-in :authrole:`backup` role provides the required privileges to perform backup of any and all databases. +Usage in Backup Strategy +------------------------ + +Standalones/Replica Sets +~~~~~~~~~~~~~~~~~~~~~~~~ + +For standalone or a replica set, :binary:`~bin.mongodump` can be a part +of a :ref:`backup strategy ` with +:binary:`~bin.mongorestore` for partial backups based on a query, +syncing from production to staging or development environments, or +changing the storage engine of a standalone. + +For an overview of :binary:`~bin.mongodump` in conjunction with +:binary:`~bin.mongorestore` part of a backup and recovery strategy, see: + +- :manual:`Back Up and Restore with MongoDB Tools` + +- :manual:`MongoDB Backup Methods` + +Sharded Clusters +~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst + .. _mongodump-options: Options diff --git a/source/mongoexport.txt b/source/mongoexport.txt index 7914b9df..d03d8c08 100644 --- a/source/mongoexport.txt +++ b/source/mongoexport.txt @@ -14,6 +14,8 @@ :backlinks: none :depth: 1 :class: singlecol + +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongoexport` Synopsis @@ -22,39 +24,47 @@ Synopsis :binary:`~bin.mongoexport` is a command-line tool that produces a JSON or CSV export of data stored in a MongoDB instance. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongoexport.rst -.. note:: +.. seealso:: - This documentation is for {+release+} of :binary:`~bin.mongoexport`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongoexport``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: + :binary:`~bin.mongoimport` which provides the corresponding + structured data import capability. - *Quick links to older documentation* +Versioning +~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-version-single.rst + +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongoexport `__ - `MongoDB 4.0 mongoexport `__ - `MongoDB 3.6 mongoexport `__ -.. include:: /includes/extracts/require-cmd-line-mongoexport.rst +This documentation is for version ``{+release+}`` of |tool-binary|. -.. seealso:: +Compatibility +------------- - :binary:`~bin.mongoimport` which provides the corresponding "import" - capability. +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: /includes/extracts/dbtools-compatibility-single.rst -Availability ------------- +Platform Support +~~~~~~~~~~~~~~~~ -.. include:: /includes/extracts/download-from-tools-mongoexport.rst +|tool-binary| version ``{+release+}`` is supported on the following +platforms: -Compatibility -------------- +.. include:: /includes/fact-platform-support.rst + +Installation +------------ -.. include:: /includes/extracts/dbtool-compatibility-single.rst +.. include:: /includes/fact-see-install-guide.rst Syntax ------- diff --git a/source/mongofiles.txt b/source/mongofiles.txt index 62fa6c7e..168e257d 100644 --- a/source/mongofiles.txt +++ b/source/mongofiles.txt @@ -10,6 +10,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongofiles` .. only:: (not man) @@ -45,34 +46,42 @@ The components of the :binary:`~bin.mongofiles` command are: :binary:`~bin.mongofiles` can only read from the set's :term:`primary`. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongofiles.rst -.. note:: +Versioning +~~~~~~~~~~ - This documentation is for version ``{+release+}`` of - :binary:`~bin.mongofiles`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongofiles``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongofiles `__ - `MongoDB 4.0 mongofiles `__ - `MongoDB 3.6 mongofiles `__ -.. include:: /includes/extracts/require-cmd-line-mongofiles.rst - -Availability ------------- - -.. include:: /includes/extracts/download-from-tools-mongofiles.rst +This documentation is for version ``{+release+}`` of |tool-binary|. Compatibility ------------- -.. include:: /includes/extracts/dbtool-compatibility-single.rst +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-compatibility-single.rst + +Platform Support +~~~~~~~~~~~~~~~~ + +|tool-binary| version ``{+release+}`` is supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst + +Installation +------------ + +.. include:: /includes/fact-see-install-guide.rst Required Access --------------- diff --git a/source/mongoimport.txt b/source/mongoimport.txt index ad30a26f..64085905 100644 --- a/source/mongoimport.txt +++ b/source/mongoimport.txt @@ -11,6 +11,8 @@ :backlinks: none :depth: 1 :class: singlecol + +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongoimport` Synopsis @@ -21,32 +23,47 @@ The :binary:`~bin.mongoimport` tool imports content from an created by :binary:`~bin.mongoexport`, or potentially, another third-party export tool. -See the :doc:`/mongoexport` document for more information regarding -:binary:`~bin.mongoexport`, which provides the inverse "exporting" -capability. +.. include:: /includes/extracts/require-cmd-line-mongoimport.rst -.. note:: +.. seealso:: - This documentation is for {+release+} of :binary:`~bin.mongoimport`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongoimport``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: + :binary:`~bin.mongoexport` which provides the corresponding + structured data export capability. + +Versioning +~~~~~~~~~~ - *Quick links to older documentation* +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongoimport `__ - `MongoDB 4.0 mongoimport `__ - `MongoDB 3.6 mongoimport `__ -.. include:: /includes/extracts/require-cmd-line-mongoimport.rst +This documentation is for version ``{+release+}`` of |tool-binary|. + +Compatibility +------------- + +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-compatibility-single.rst + +Platform Support +~~~~~~~~~~~~~~~~ + +|tool-binary| version ``{+release+}`` is supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst -Availability +Installation ------------ -.. include:: /includes/extracts/download-from-tools-mongoimport.rst +.. include:: /includes/fact-see-install-guide.rst Behavior -------- diff --git a/source/mongorestore.txt b/source/mongorestore.txt index 5d0aa32e..f7417fb3 100644 --- a/source/mongorestore.txt +++ b/source/mongorestore.txt @@ -12,6 +12,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongorestore` Synopsis @@ -21,50 +22,48 @@ 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. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongorestore.rst -.. note:: +.. seealso:: - This documentation is for version ``{+release+}`` of - :binary:`~bin.mongorestore`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongorestore``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: + :binary:`~bin.mongodump` which provides the corresponding + binary data export capability. + +Versioning +~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongorestore `__ - `MongoDB 4.0 mongorestore `__ - `MongoDB 3.6 mongorestore `__ -.. include:: /includes/extracts/require-cmd-line-mongorestore.rst - -Availability ------------- - -.. include:: /includes/extracts/download-from-tools-mongorestore.rst +This documentation is for version ``{+release+}`` of |tool-binary|. Compatibility ------------- -.. include:: /includes/extracts/dbtool-compatibility-single.rst +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Usage in Backup Strategy ------------------------- +.. include:: /includes/extracts/dbtools-compatibility-single.rst -Standalones/Replica Sets -~~~~~~~~~~~~~~~~~~~~~~~~ +Platform Support +~~~~~~~~~~~~~~~~ -For an overview of :binary:`~bin.mongorestore` usage as part of a -backup and recovery strategy, see -:manual:`Back Up and Restore with MongoDB Tools`. +|tool-binary| version ``{+release+}`` is supported on the following +platforms: -Sharded Clusters -~~~~~~~~~~~~~~~~ +.. include:: /includes/fact-platform-support.rst + +Installation +------------ + +.. include:: /includes/fact-see-install-guide.rst -.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst - Syntax ------ @@ -246,6 +245,21 @@ additional privileges: Grant only to users who must run :binary:`~bin.mongorestore` with :option:`--oplogReplay `. +Usage in Backup Strategy +------------------------ + +Standalones/Replica Sets +~~~~~~~~~~~~~~~~~~~~~~~~ + +For an overview of :binary:`~bin.mongorestore` usage as part of a +backup and recovery strategy, see +:manual:`Back Up and Restore with MongoDB Tools`. + +Sharded Clusters +~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst + .. _mongorestore-options: Options diff --git a/source/mongostat.txt b/source/mongostat.txt index efc9f5c4..60def5b6 100644 --- a/source/mongostat.txt +++ b/source/mongostat.txt @@ -12,6 +12,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongostat` Synopsis @@ -24,34 +25,42 @@ similar to the UNIX/Linux file system utility ``vmstat``, but provides data regarding :binary:`~bin.mongod` and :binary:`~bin.mongos` instances. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongostat.rst -.. note:: +Versioning +~~~~~~~~~~ - This documentation is for version ``{+release+}`` of - :binary:`~bin.mongostat`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongostat``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongostat `__ - `MongoDB 4.0 mongostat `__ - `MongoDB 3.6 mongostat `__ -.. include:: /includes/extracts/require-cmd-line-mongostat.rst - -Availability ------------- - -.. include:: /includes/extracts/download-from-tools-mongostat.rst +This documentation is for version ``{+release+}`` of |tool-binary|. Compatibility ------------- -.. include:: /includes/extracts/dbtool-compatibility-single.rst +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: /includes/extracts/dbtools-compatibility-single.rst + +Platform Support +~~~~~~~~~~~~~~~~ + +|tool-binary| version ``{+release+}`` is supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst + +Installation +------------ + +.. include:: /includes/fact-see-install-guide.rst Required Access --------------- diff --git a/source/mongotop.txt b/source/mongotop.txt index d6436ce2..0780b7ee 100644 --- a/source/mongotop.txt +++ b/source/mongotop.txt @@ -12,6 +12,7 @@ :depth: 1 :class: singlecol +.. |arrow| unicode:: U+27A4 .. |tool-binary| replace:: :binary:`~bin.mongotop` Description @@ -22,35 +23,42 @@ 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. -.. include:: /includes/extracts/dbtool-new-release.rst +.. include:: /includes/extracts/require-cmd-line-mongotop.rst -.. note:: +Versioning +~~~~~~~~~~ - This documentation is for version ``{+release+}`` of - :binary:`~bin.mongotop`. - - For documentation on the MongoDB 4.2 or earlier versions of - ``mongotop``, reference the :manual:`MongoDB Server Documentation - ` for that version of the tool: +.. include:: /includes/extracts/dbtools-version-single.rst - *Quick links to older documentation* +.. admonition:: Quick links to older documentation + :class: note - `MongoDB 4.2 mongotop `__ - `MongoDB 4.0 mongotop `__ - `MongoDB 3.6 mongotop `__ -.. include:: /includes/extracts/require-cmd-line-mongotop.rst +This documentation is for version ``{+release+}`` of |tool-binary|. +Compatibility +------------- -Availability ------------- +MongoDB Server Compatibility +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: /includes/extracts/download-from-tools-mongotop.rst +.. include:: /includes/extracts/dbtools-compatibility-single.rst -Compatibility -------------- +Platform Support +~~~~~~~~~~~~~~~~ + +|tool-binary| version ``{+release+}`` is supported on the following +platforms: + +.. include:: /includes/fact-platform-support.rst + +Installation +------------ -.. include:: /includes/extracts/dbtool-compatibility-single.rst +.. include:: /includes/fact-see-install-guide.rst Syntax -------