From 08e02ed35513c861dbf54f92f690e939904032ea Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 19 Nov 2024 18:46:55 -0500 Subject: [PATCH 01/10] DOCSP-45459 Mark Compass-Exclusive Content --- .../export-pipeline-results.txt | 4 ++++ source/agg-pipeline-builder/maxtime-ms-pipeline.txt | 4 ++++ .../view-pipeline-explain-plan.txt | 2 +- source/collections.txt | 6 +++++- source/documents/delete-multiple.txt | 4 ++++ source/documents/delete.txt | 6 ++++++ source/documents/modify-multiple.txt | 13 +++++++++++++ source/documents/modify.txt | 2 ++ source/includes/steps-create-collection.yaml | 4 ++++ source/indexes.txt | 8 ++++++++ source/query-plan.txt | 2 +- .../ai-and-data-usage-information.txt | 11 ++++++++++- .../enable-natural-language-querying.txt | 4 ++++ source/query/filter.txt | 4 ++++ 14 files changed, 70 insertions(+), 4 deletions(-) diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt index 0ec4cc4ab..cd6c8e573 100644 --- a/source/agg-pipeline-builder/export-pipeline-results.txt +++ b/source/agg-pipeline-builder/export-pipeline-results.txt @@ -59,6 +59,10 @@ Steps Learn More ---------- +.. BEGIN-COMPASS-ONLY + - :ref:`export-data-collection` +.. END-COMPASS-ONLY + - :ref:`compass-export-pipeline` diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt index cf59c4e91..abcea1c4b 100644 --- a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt +++ b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt @@ -25,12 +25,16 @@ frequently time out. Alternatively, consider lowering the :guilabel:`Max Time MS` value to quickly identify inefficient or resource-intensive pipeline operations. +.. BEGIN-COMPASS-ONLY + If you already specified a ``maxTimeMS`` value in the :ref:`Compass Settings panel `, the :ref:`command line `, or a :ref:`configuration file `, the :guilabel:`Max Time MS` that you specify for your pipeline must be lower than the limit you previously specified. +.. END-COMPASS-ONLY + If your aggregation operation goes over the time limit, |compass-short| raises a timeout error. diff --git a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt index ca38502d3..90ee5d2ee 100644 --- a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt +++ b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt @@ -72,4 +72,4 @@ Learn More - :manual:`Analyze Query Performance ` -- :ref:`explain-plans` +- :ref:`compass-explain-plans` diff --git a/source/collections.txt b/source/collections.txt index 1897a9612..559772f3c 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -100,13 +100,17 @@ view: - :ref:`compass-documents` +.. BEGIN-COMPASS-ONLY + - :ref:`compass-import-export` to and from the collection +.. END-COMPASS-ONLY + - :ref:`compass-agg-builder` - :ref:`Schema Analysis ` -- :ref:`explain-plans` +- :ref:`compass-explain-plans` - :ref:`compass-indexes` diff --git a/source/documents/delete-multiple.txt b/source/documents/delete-multiple.txt index 016d3650c..9b02efa95 100644 --- a/source/documents/delete-multiple.txt +++ b/source/documents/delete-multiple.txt @@ -26,6 +26,8 @@ Validate documents in the :guilabel:`Preview` of the :guilabel:`Delete Documents` modal before confirming the delete operation. +.. BEGIN-COMPASS-ONLY + Before you Begin ---------------- @@ -33,6 +35,8 @@ The :guilabel:`Delete Documents` modal is available starting in Compass version ``1.42.0``. For instructions on updating or installing the latest Compass version, see :ref:`download-install`. +.. END-COMPASS-ONLY + Steps ----- diff --git a/source/documents/delete.txt b/source/documents/delete.txt index 7b482cdce..ec3d20a1b 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -12,11 +12,15 @@ Delete Single Document :depth: 1 :class: singlecol +.. BEGIN-COMPASS-ONLY + .. important:: Deleting documents is not permitted in :guilabel:`MongoDB Compass Readonly Edition`. +.. END-COMPASS-ONLY + Select the appropriate tab based on whether you are viewing your documents in List, JSON, or Table view: @@ -76,9 +80,11 @@ Delete Multiple Documents You can use the bulk delete operations workflow to delete multiple documents in Compass. For details, see :ref:`compass-bulk-delete`. +.. BEGIN-COMPASS-ONLY .. note:: You can also use the :manual:`db.collection.deleteMany() ` method in the :ref:`embedded MongoDB Shell ` to delete multiple documents in a single operation. +.. END-COMPASS-ONLY diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 1f180b578..6e9b7ae08 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -32,6 +32,8 @@ About this Task only visible if your database is configured to support transactions. For details, see :ref:`transactions`. +.. BEGIN-COMPASS-ONLY + Before you Begin ---------------- @@ -39,6 +41,8 @@ The :guilabel:`Update Documents` modal is available starting in Compass version ``1.42.0``. For instructions on updating or installing the latest Compass version, see :ref:`download-install`. +.. END-COMPASS-ONLY + Steps ----- @@ -95,6 +99,8 @@ Steps The documents under the :guilabel:`Preview` header show how the :guilabel:`Update` syntax affects documents in your collection. +.. BEGIN-COMPASS-ONLY + .. step:: (Optional) Name and save your :guilabel:`Update` You can name and save the update query in the @@ -108,6 +114,8 @@ Steps #. Enter a name for the update syntax. #. Click the green :guilabel:`Save` button. +.. END-COMPASS-ONLY + .. step:: Update your documents Click :guilabel:`Update Documents`. @@ -169,4 +177,9 @@ Learn More ---------- - :ref:`compass-bulk-delete` + +.. BEGIN-COMPASS-ONLY + - :ref:`compass-saved-favorite-query-view` + +.. END-COMPASS-ONLY diff --git a/source/documents/modify.txt b/source/documents/modify.txt index d0f9204bc..97959741f 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -213,9 +213,11 @@ Modify Multiple Documents You can use the bulk update operations workflow to update multiple documents in Compass. For details, see :ref:`compass-bulk-update`. +.. BEGIN-COMPASS-ONLY .. note:: You can also use the :manual:`db.collection.updateMany() ` method in the :ref:`embedded MongoDB Shell ` to update multiple documents in a single operation. +.. END-COMPASS-ONLY diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index 6a0144507..6a6af070c 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -20,9 +20,13 @@ content: | - :ref:`Create a Clustered Collection ` - :ref:`Create a Collection with Collation ` + + .. BEGIN-COMPASS-ONLY - :ref:`Create a Collection with Encrypted Fields ` + .. END-COMPASS-ONLY + - :ref:`Create a Time Series Collection ` --- title: Click :guilabel:`Create Collection` to create the collection. diff --git a/source/indexes.txt b/source/indexes.txt index e79749d92..8442254f1 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -81,6 +81,8 @@ Create an Index .. include:: /includes/steps/create-index.rst +.. BEGIN-COMPASS-ONLY + Create an Atlas Search Index ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -95,6 +97,8 @@ Atlas Vector Search indexes enable you to index vector data *and* other data types, which facilitates semantic searches on the indexed fields. For more information, see :ref:`compass-create-vector-search`. +.. END-COMPASS-ONLY + .. _compass-wildcard-index: Create a Wildcard Index @@ -185,8 +189,12 @@ Limitations :ref:`Atlas CLI `, or the :ref:`Atlas Administration API `. +.. BEGIN-COMPASS-ONLY + .. toctree:: :titlesonly: Atlas Search Index Atlas Vector Search Index + +.. END-COMPASS-ONLY diff --git a/source/query-plan.txt b/source/query-plan.txt index d11dd7629..89e5a7d92 100644 --- a/source/query-plan.txt +++ b/source/query-plan.txt @@ -1,4 +1,4 @@ -.. _explain-plans: +.. _compass-explain-plans: ====================== View Query Performance diff --git a/source/query-with-natural-language/ai-and-data-usage-information.txt b/source/query-with-natural-language/ai-and-data-usage-information.txt index 83ba9f1b4..be193d80c 100644 --- a/source/query-with-natural-language/ai-and-data-usage-information.txt +++ b/source/query-with-natural-language/ai-and-data-usage-information.txt @@ -31,16 +31,23 @@ AI provider: - The full text of your natural language prompt. - The schema of the collection you are querying, including database name, collection name, field names, and types. + +.. BEGIN-COMPASS-ONLY + - Enable sending sample field values. This is an optional setting to improve the quality of recommendations. You can manage this through the ``Enable sending sample field values`` setting in :ref:`Compass settings `. This setting is off by default. +.. END-COMPASS-ONLY + The information that is sent will not be shared with any other third parties or stored by the AI provider. We do not send database connection strings, credentials, or rows/documents from your databases. +.. BEGIN-COMPASS-ONLY + Disable Natural Language Querying --------------------------------- @@ -51,4 +58,6 @@ Disable Natural Language Querying :guilabel:`Enable AI Features` in the :guilabel:`Artificial Intelligence` settings. - To prevent usage of this feature entirely, you can disable it in the - :ref:`global configuration file `. \ No newline at end of file + :ref:`global configuration file `. + +.. END-COMPASS-ONLY \ No newline at end of file diff --git a/source/query-with-natural-language/enable-natural-language-querying.txt b/source/query-with-natural-language/enable-natural-language-querying.txt index d64468eea..6e078a004 100644 --- a/source/query-with-natural-language/enable-natural-language-querying.txt +++ b/source/query-with-natural-language/enable-natural-language-querying.txt @@ -36,6 +36,8 @@ you must: - Sign into Atlas. For details on how to get a free Atlas account and deploy a free M0 cluster, see :ref:`atlas-getting-started`. +.. BEGIN-COMPASS-ONLY + - Install |compass-short| version 1.40.0 or later. For instructions on downloading and installing the latest version, see :ref:`download-install`. @@ -44,6 +46,8 @@ you must: You can also enable Natural Language Querying using the configuration file. For details, see :ref:`config-file`. +.. END-COMPASS-ONLY + Steps ----- diff --git a/source/query/filter.txt b/source/query/filter.txt index 4fbbeb439..c550578a9 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -448,11 +448,15 @@ Clear the Query .. include:: /includes/clear-query.rst +.. BEGIN-COMPASS-ONLY + Query Collections with Invalid UTF8 Data ---------------------------------------- .. include:: /includes/fact-non-utf8-data.rst +.. END-COMPASS-ONLY + How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- From f383c0fcacbfa692a10d664b8b59f9291d9c3b41 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Tue, 19 Nov 2024 18:52:08 -0500 Subject: [PATCH 02/10] fix yaml syntax --- source/includes/steps-create-collection.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index 6a6af070c..8d083875a 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -21,11 +21,11 @@ content: | - :ref:`Create a Collection with Collation ` - .. BEGIN-COMPASS-ONLY +# BEGIN-COMPASS-ONLY - :ref:`Create a Collection with Encrypted Fields ` - .. END-COMPASS-ONLY +# END-COMPASS-ONLY - :ref:`Create a Time Series Collection ` --- From 616a012622d7d857827e7b541b8bb0e62cf9a3c4 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 10:29:47 -0500 Subject: [PATCH 03/10] * --- source/connect/required-access.txt | 2 +- source/editions.txt | 2 +- source/includes/steps-create-collection.yaml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index 23b30735b..ef3d7ad98 100644 --- a/source/connect/required-access.txt +++ b/source/connect/required-access.txt @@ -82,7 +82,7 @@ privileges: - :authrole:`readWrite` * - :guilabel:`Explain Plan` - - :ref:`Query/View a query plan ` + - :ref:`Query/View a query plan ` - :authaction:`find` - :authrole:`read` diff --git a/source/editions.txt b/source/editions.txt index ceec65b96..2decae2ad 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -35,7 +35,7 @@ suit your needs. - |checkmark| * - View and optimize query performance with visual - :ref:`explain plans ` + :ref:`explain plans ` - |checkmark| - |checkmark| - |checkmark| diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index 8d083875a..dc0f55233 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -21,11 +21,11 @@ content: | - :ref:`Create a Collection with Collation ` -# BEGIN-COMPASS-ONLY + # BEGIN-COMPASS-ONLY - :ref:`Create a Collection with Encrypted Fields ` -# END-COMPASS-ONLY + # END-COMPASS-ONLY - :ref:`Create a Time Series Collection ` --- From fe4fbf8c1d8021c00acc39d21abe87f4cd1e66ce Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 11:10:03 -0500 Subject: [PATCH 04/10] * --- source/includes/steps-create-collection.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index dc0f55233..6a6af070c 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -21,11 +21,11 @@ content: | - :ref:`Create a Collection with Collation ` - # BEGIN-COMPASS-ONLY + .. BEGIN-COMPASS-ONLY - :ref:`Create a Collection with Encrypted Fields ` - # END-COMPASS-ONLY + .. END-COMPASS-ONLY - :ref:`Create a Time Series Collection ` --- From e101961da66c01909b8e70aef211368c7d97d533 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 14:20:35 -0500 Subject: [PATCH 05/10] databases - documents --- source/collections.txt | 8 ++++++++ source/collections/clustered-collection.txt | 2 +- source/databases.txt | 4 ++++ source/documents.txt | 4 ++++ source/documents/clone.txt | 8 ++++---- source/documents/delete.txt | 4 ---- source/documents/insert.txt | 10 +++++++++- source/documents/modify-multiple.txt | 2 +- source/documents/modify.txt | 9 +++++---- source/documents/view.txt | 10 ++++------ 10 files changed, 40 insertions(+), 21 deletions(-) diff --git a/source/collections.txt b/source/collections.txt index 559772f3c..04eda077c 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -116,6 +116,8 @@ view: - :ref:`compass-validation` +.. BEGIN-COMPASS-ONLY + .. note:: Data Lake Limitations The following functionality is not available if you are connected to @@ -131,6 +133,8 @@ view: - Set Validation Rules for Your Schema +.. END-COMPASS-ONLY + .. _compass-tabbed-view: Tabbed View @@ -141,6 +145,8 @@ open a new tab to view collection details: .. include:: /includes/steps/open-new-tab.rst +.. BEGIN-COMPASS-ONLY + Limitations ----------- @@ -149,6 +155,8 @@ Limitations - The :guilabel:`Create Collection` button is not available if you are connected to a :atlas:`Data Lake `. +.. END-COMPASS-ONLY + .. |home| unicode:: U+2302 .. toctree:: diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt index c9736703a..0990ed08c 100644 --- a/source/collections/clustered-collection.txt +++ b/source/collections/clustered-collection.txt @@ -69,6 +69,6 @@ Next Steps - :ref:`Manage Documents ` -- :ref:`Query Your Data` +- :ref:`Query Your Data ` - :ref:`Analyze Your Data Scheme ` diff --git a/source/databases.txt b/source/databases.txt index 691cdf332..2d3efc852 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -51,6 +51,8 @@ Drop a Database .. include:: /includes/steps/delete-database.rst +.. BEGIN-COMPASS-ONLY + Limitations ----------- @@ -58,3 +60,5 @@ Limitations - Creating databases is not permitted if you are connected to a :atlas:`Data Lake `. + +.. END-COMPASS-ONLY \ No newline at end of file diff --git a/source/documents.txt b/source/documents.txt index 3b01d0218..1bad8228b 100644 --- a/source/documents.txt +++ b/source/documents.txt @@ -21,11 +21,15 @@ From the :guilabel:`Documents` tab, you can :ref:`delete multiple ` documents in your selected collection or view. +.. BEGIN-COMPASS-ONLY + .. note:: For query result sets larger than 20 documents, Compass shows paginated results. By default, pages display 20 documents at a time. +.. END-COMPASS-ONLY + From the :ref:`query bar `, you can specify a query to filter the displayed documents. Click :guilabel:`Options` to specify query options. diff --git a/source/documents/clone.txt b/source/documents/clone.txt index 571466626..36e6af397 100644 --- a/source/documents/clone.txt +++ b/source/documents/clone.txt @@ -12,11 +12,15 @@ Clone Documents :depth: 1 :class: singlecol +.. BEGIN-COMPASS-ONLY + .. important:: Cloning documents is not permitted in :guilabel:`MongoDB Compass Readonly Edition`. +.. END-COMPASS-ONLY + You can insert new documents by cloning the schema and values of an existing document in a collection. @@ -38,10 +42,6 @@ documents in List, JSON, or Table view: .. tab:: JSON View :tabid: json - .. note:: - - JSON View is available starting in Compass 1.20. - To clone a document, hover over the desired document and click the :guilabel:`Clone` button. diff --git a/source/documents/delete.txt b/source/documents/delete.txt index ec3d20a1b..fa0e45b7e 100644 --- a/source/documents/delete.txt +++ b/source/documents/delete.txt @@ -43,10 +43,6 @@ documents in List, JSON, or Table view: .. tab:: JSON View :tabid: json - .. note:: - - JSON View is available starting in Compass 1.20. - To delete a document, hover over the document and click the :icon-fa5:`trash-alt` icon. diff --git a/source/documents/insert.txt b/source/documents/insert.txt index e96b09fc3..fb341d157 100644 --- a/source/documents/insert.txt +++ b/source/documents/insert.txt @@ -12,15 +12,19 @@ Insert Documents :depth: 1 :class: singlecol +.. BEGIN-COMPASS-ONLY + .. important:: Inserting documents is not permitted in :guilabel:`MongoDB Compass Readonly Edition`. +.. END-COMPASS-ONLY + |compass-short| provides two ways to insert documents into your collections: JSON Mode and a Field-by-Field Editor. -JSON Mode (*New in Compass 1.20*) +JSON Mode Allows you to write or paste JSON documents in the editor. Use this mode to insert multiple documents at once as an array. @@ -136,8 +140,12 @@ To insert documents into your collection: 4. Click :guilabel:`Insert`. +.. BEGIN-COMPASS-ONLY + Limitation ---------- The :guilabel:`Insert Document` button is not available if you are connected to a :atlas:`Data Lake `. + +.. END-COMPASS-ONLY diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 6e9b7ae08..e311d9d33 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -30,7 +30,7 @@ About this Task - Previews of the documents affected by bulk update operations are only visible if your database is configured to support transactions. - For details, see :ref:`transactions`. + For details, see :manual:`Transactions `. .. BEGIN-COMPASS-ONLY diff --git a/source/documents/modify.txt b/source/documents/modify.txt index 97959741f..c8a00bede 100644 --- a/source/documents/modify.txt +++ b/source/documents/modify.txt @@ -18,6 +18,7 @@ You can edit existing documents in your collection. .. include:: /includes/fact-modify-findOneAndReplace.rst +.. BEGIN-COMPASS-ONLY Limitations ----------- @@ -25,6 +26,8 @@ Limitations - Modifying documents is not permitted in :guilabel:`MongoDB Compass Readonly Edition`. +.. END-COMPASS-ONLY + Procedure --------- @@ -117,10 +120,6 @@ documents in List, JSON, or Table view: .. tab:: JSON View :tabid: json - .. note:: - - JSON View is available starting in Compass 1.20. - To modify a document, hover over the document and click the pencil icon: @@ -214,10 +213,12 @@ You can use the bulk update operations workflow to update multiple documents in Compass. For details, see :ref:`compass-bulk-update`. .. BEGIN-COMPASS-ONLY + .. note:: You can also use the :manual:`db.collection.updateMany() ` method in the :ref:`embedded MongoDB Shell ` to update multiple documents in a single operation. + .. END-COMPASS-ONLY diff --git a/source/documents/view.txt b/source/documents/view.txt index 330bc3854..2675f8a5b 100644 --- a/source/documents/view.txt +++ b/source/documents/view.txt @@ -22,7 +22,7 @@ List View of a list. In this view you can easily expand embedded objects and arrays. -JSON View (*New in Compass 1.20*) +JSON View Documents are shown as properly-formatted JSON objects. In this view |compass-short| uses extended JSON to display the data types of fields where appropriate. @@ -46,10 +46,6 @@ following examples: .. tab:: JSON View :tabid: json - - .. note:: - - JSON View is available starting in Compass 1.20. .. figure:: /images/compass/documents-json.png :figwidth: 700px @@ -159,7 +155,7 @@ Copy Documents to Clipboard :figwidth: 696px :alt: Copy Document from Table View - +.. BEGIN-COMPASS-ONLY Encrypted Fields ---------------- @@ -195,3 +191,5 @@ Encrypted Fields :alt: Encrypted field in table view .. include:: /includes/fact-qe-description.rst + +.. END-COMPASS-ONLY From edc9f80ef01ff6913c1b498f5cc9f62893d66ff7 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 14:44:26 -0500 Subject: [PATCH 06/10] query directory --- source/export-query-to-language.txt | 4 +--- source/query/filter.txt | 6 +++++- source/query/limit.txt | 12 ++++++------ source/query/project.txt | 12 ++++++------ source/query/skip.txt | 12 ++++++------ source/query/sort.txt | 16 ++++++++++------ 6 files changed, 34 insertions(+), 28 deletions(-) diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt index eeecff38c..62557147b 100644 --- a/source/export-query-to-language.txt +++ b/source/export-query-to-language.txt @@ -6,8 +6,6 @@ Export Query to Specific Language .. default-domain:: mongodb -*New in version 1.15.0* - You can export queries created in the :ref:`query bar ` to one of the supported languages; Java, Node, C#, Python 3, Ruby, Go, Rust, and PHP. This feature allows you to reformat @@ -34,7 +32,7 @@ Procedure :alt: Query bar language select The :guilabel:`My Query` pane on the left displays your query in - :binary:`~mongo` shell syntax. + :binary:`~mongosh` syntax. The pane to the right displays your query in the language selected. diff --git a/source/query/filter.txt b/source/query/filter.txt index c550578a9..11bd7dd15 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -26,6 +26,8 @@ documents which match the specified criteria. To learn more about querying documents, see :manual:`Query Documents ` in the MongoDB manual. +.. BEGIN-COMPASS-ONLY + Compatibility ------------- @@ -36,6 +38,8 @@ Compatibility .. include:: /includes/fact-atlas-compatible.rst .. include:: /includes/fact-atlas-link.rst +.. END-COMPASS-ONLY + Set Query Filter ---------------- @@ -419,7 +423,7 @@ Supported Data Types in the Query Bar ------------------------------------- The Compass :guilabel:`Filter` supports using the -:binary:`~bin.mongo` shell mode representation of the MongoDB +:binary:`~bin.mongosh` representation of the MongoDB Extended JSON :manual:`BSON data types `. .. example:: diff --git a/source/query/limit.txt b/source/query/limit.txt index 0d6465dfa..67f978431 100644 --- a/source/query/limit.txt +++ b/source/query/limit.txt @@ -31,12 +31,6 @@ Clear the Query .. include:: /includes/clear-query.rst -To Learn More -------------- - -See the ``limit`` entry in the -:manual:`MongoDB Manual `. - How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- @@ -65,3 +59,9 @@ in a |sql| ``SELECT`` statement. .. code-block:: javascript $limit : 10 + +Learn More +---------- + +See the ``limit`` entry in the +:manual:`MongoDB Manual `. diff --git a/source/query/project.txt b/source/query/project.txt index ac465757d..17efbdabe 100644 --- a/source/query/project.txt +++ b/source/query/project.txt @@ -50,12 +50,6 @@ To set a projection: .. include:: /includes/extracts/query-bar-results.rst -To Learn More -------------- - -To learn how project works, see the ``project`` entry in the -:ref:`MongoDB Manual `. - How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- @@ -83,3 +77,9 @@ in a |sql| ``SELECT`` statement. .. code-block:: javascript { headline : 1, author : 1 } + +Learn More +---------- + +To learn how project works, see the ``project`` entry in the +:ref:`MongoDB Manual `. diff --git a/source/query/skip.txt b/source/query/skip.txt index bad0ceabc..840ee25c4 100644 --- a/source/query/skip.txt +++ b/source/query/skip.txt @@ -35,12 +35,6 @@ Clear the Query .. include:: /includes/clear-query.rst -To Learn More -------------- - -See the ``skip`` entry in the -:manual:`MongoDB Manual `. - How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- @@ -70,3 +64,9 @@ in a |sql| ``SELECT`` statement. .. code-block:: javascript $skip : 435 + +Learn More +---------- + +See the ``skip`` entry in the +:manual:`MongoDB Manual `. diff --git a/source/query/sort.txt b/source/query/sort.txt index c9ff91791..75cc29e15 100644 --- a/source/query/sort.txt +++ b/source/query/sort.txt @@ -16,6 +16,8 @@ Sort the Returned Documents If the query bar displays the :guilabel:`Sort` option, you can specify the sort order of the returned documents. +.. BEGIN-COMPASS-ONLY + Compatibility ------------- @@ -26,6 +28,8 @@ Compatibility .. include:: /includes/fact-atlas-compatible.rst .. include:: /includes/fact-atlas-link.rst +.. END-COMPASS-ONLY + Set the Sort Order ------------------ @@ -60,12 +64,6 @@ Clear the Query .. include:: /includes/clear-query.rst -To Learn More -------------- - -See the ``sort`` entry in the -:manual:`MongoDB Manual `. - How Does the Compass Query Compare to MongoDB and SQL Queries? -------------------------------------------------------------- @@ -95,3 +93,9 @@ in a |sql| ``SELECT`` statement. .. code-block:: javascript $sort : { headline : 1 } + +Learn More +---------- + +See the ``sort`` entry in the +:manual:`MongoDB Manual `. From 6a4b2f84cba1639e8b80088970bb4440bde92994 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 17:00:40 -0500 Subject: [PATCH 07/10] aggregation --- .../agg-pipeline-builder/export-pipeline-results.txt | 4 ---- source/agg-pipeline-builder/maxtime-ms-pipeline.txt | 3 +++ source/create-agg-pipeline.txt | 12 +++++------- source/includes/steps-create-index.yaml | 2 +- source/indexes.txt | 6 ++---- source/schema.txt | 2 ++ source/validation.txt | 5 +++-- 7 files changed, 16 insertions(+), 18 deletions(-) diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt index cd6c8e573..0ec4cc4ab 100644 --- a/source/agg-pipeline-builder/export-pipeline-results.txt +++ b/source/agg-pipeline-builder/export-pipeline-results.txt @@ -59,10 +59,6 @@ Steps Learn More ---------- -.. BEGIN-COMPASS-ONLY - - :ref:`export-data-collection` -.. END-COMPASS-ONLY - - :ref:`compass-export-pipeline` diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt index abcea1c4b..c86aad377 100644 --- a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt +++ b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt @@ -61,6 +61,7 @@ Steps Learn More ---------- +.. BEGIN-COMPASS-ONLY - :ref:`cli-options` @@ -68,4 +69,6 @@ Learn More - :ref:`compass-interface-settings` +.. END-COMPASS-ONLY + - :ref:`compass-query-bar-max-time-ms` diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt index 644a5e4aa..c7127c5ec 100644 --- a/source/create-agg-pipeline.txt +++ b/source/create-agg-pipeline.txt @@ -48,14 +48,12 @@ collection. .. note:: Atlas Search Stages - When you connect |compass-short| to a MongoDB deployment hosted on + When you connect to a MongoDB deployment hosted on `Atlas `_, - additional Atlas-only stages - :atlas:`$search ` and - :atlas:`$searchMeta ` - are available in the Aggregation Pipeline Builder. Use these stages - to perform - :atlas:`full-text search` + Atlas-only stages :atlas:`$search ` + and :atlas:`$searchMeta ` + become available in the Aggregation Pipeline Builder. Use these stages + to perform :atlas:`full-text search` on Atlas collections. Steps diff --git a/source/includes/steps-create-index.yaml b/source/includes/steps-create-index.yaml index 1971605c4..bbc1e5ed2 100644 --- a/source/includes/steps-create-index.yaml +++ b/source/includes/steps-create-index.yaml @@ -91,7 +91,7 @@ content: | - :manual:`Partial Indexes ` - * - Wildcard projection (*New in MongoDB 4.2*) + * - Wildcard projection - Support unknown or arbitrary fields which match the specified projection in the index. To use a wildcard projection, set diff --git a/source/indexes.txt b/source/indexes.txt index 8442254f1..6926bb8a8 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -104,8 +104,6 @@ information, see :ref:`compass-create-vector-search`. Create a Wildcard Index ~~~~~~~~~~~~~~~~~~~~~~~ -.. versionadded:: v4.2 - You can create :manual:`wildcard indexes ` to support queries against unknown or arbitrary fields. To create a wildcard index in |compass-short|, manually type the wildcard index @@ -170,6 +168,8 @@ Drop an Index .. include:: /includes/steps/drop-index.rst +.. BEGIN-COMPASS-ONLY + Limitations ----------- @@ -189,8 +189,6 @@ Limitations :ref:`Atlas CLI `, or the :ref:`Atlas Administration API `. -.. BEGIN-COMPASS-ONLY - .. toctree:: :titlesonly: diff --git a/source/schema.txt b/source/schema.txt index dbd1ec3ca..f60df8ebd 100644 --- a/source/schema.txt +++ b/source/schema.txt @@ -371,7 +371,9 @@ To increase the value of :guilabel:`MAX TIME MS`: Once you have increased the value of :guilabel:`MAX TIME MS`, retry your schema analysis by clicking :guilabel:`Analyze`. +.. BEGIN-COMPASS-ONLY .. toctree:: :titlesonly: Export +.. END-COMPASS-ONLY diff --git a/source/validation.txt b/source/validation.txt index 2ee302ce6..f3c36bee0 100644 --- a/source/validation.txt +++ b/source/validation.txt @@ -32,8 +32,6 @@ specific shape or only allowing a specified range of values in fields. Validation Rules ---------------- -*Updated in version 1.35.1* - The validation editor supports :manual:`JSON Schema validation `, and validation with query expressions using :manual:`query operators `. @@ -195,6 +193,9 @@ Limitations The :guilabel:`Validation` tab is not available if you are connected to :atlas:`Atlas Data Federation `. +.. BEGIN-COMPASS-ONLY + In :guilabel:`MongoDB Compass Readonly Edition`, you can only view validation rules. Creating and editing validation rules is not permitted. +.. END-COMPASS-ONLY From e7d499de99ce155b7e3381458414da3e6fb41573 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 17:08:44 -0500 Subject: [PATCH 08/10] * --- source/collections/clustered-collection.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt index 0990ed08c..c9736703a 100644 --- a/source/collections/clustered-collection.txt +++ b/source/collections/clustered-collection.txt @@ -69,6 +69,6 @@ Next Steps - :ref:`Manage Documents ` -- :ref:`Query Your Data ` +- :ref:`Query Your Data` - :ref:`Analyze Your Data Scheme ` From fd4aa4e4f77d5a3c56ec83352b82327209265244 Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 17:15:27 -0500 Subject: [PATCH 09/10] * --- source/documents/modify-multiple.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index e311d9d33..6e9b7ae08 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -30,7 +30,7 @@ About this Task - Previews of the documents affected by bulk update operations are only visible if your database is configured to support transactions. - For details, see :manual:`Transactions `. + For details, see :ref:`transactions`. .. BEGIN-COMPASS-ONLY From b09eeb499ce2c4a17c5517e1582e9334cf07318c Mon Sep 17 00:00:00 2001 From: Alison Huh Date: Wed, 20 Nov 2024 17:17:54 -0500 Subject: [PATCH 10/10] * --- source/documents/modify-multiple.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 6e9b7ae08..bc0ca781c 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -99,7 +99,7 @@ Steps The documents under the :guilabel:`Preview` header show how the :guilabel:`Update` syntax affects documents in your collection. -.. BEGIN-COMPASS-ONLY + .. BEGIN-COMPASS-ONLY .. step:: (Optional) Name and save your :guilabel:`Update` @@ -114,7 +114,7 @@ Steps #. Enter a name for the update syntax. #. Click the green :guilabel:`Save` button. -.. END-COMPASS-ONLY + .. END-COMPASS-ONLY .. step:: Update your documents