From 9a19c87c80bbc93756c7a589f7912929f650a693 Mon Sep 17 00:00:00 2001 From: Alison Huh <112565127+ajhuh-mdb@users.noreply.github.com> Date: Mon, 4 Nov 2024 15:11:45 -0500 Subject: [PATCH] Merge compass-atlas-unification feature branch (#693) * DOCSP-44714-compass-ref-prefix-replacements (#688) * DOCSP-44714-compass-ref-prefix-replacements * * * build errors * typo * DOCSP-44850-compass-prefix-updates (#692) --- .../aggregation-pipeline-builder-settings.txt | 8 ++-- .../count-pipeline-results.txt | 4 +- source/agg-pipeline-builder/create-a-view.txt | 2 +- .../export-pipeline-results.txt | 2 +- .../export-pipeline-to-language.txt | 6 +-- .../maxtime-ms-pipeline.txt | 4 +- .../open-saved-pipeline.txt | 12 ++--- .../pipeline-custom-collation.txt | 2 +- .../save-agg-pipeline.txt | 10 ++--- .../view-pipeline-explain-plan.txt | 2 +- source/collections.txt | 16 +++---- source/collections/capped-collection.txt | 2 +- source/collections/clustered-collection.txt | 4 +- source/collections/collation-collection.txt | 2 +- source/collections/encrypted-collection.txt | 2 +- source/collections/time-series-collection.txt | 2 +- source/connect/connections.txt | 2 +- source/connect/required-access.txt | 14 +++--- source/create-agg-pipeline.txt | 4 +- source/databases.txt | 16 +++---- source/documents.txt | 14 +++--- source/documents/clone.txt | 4 +- source/documents/insert.txt | 2 +- source/documents/modify-multiple.txt | 4 +- source/documents/view.txt | 6 +-- source/editions.txt | 8 ++-- source/export-query-to-language.txt | 8 ++-- source/faq.txt | 2 +- source/import-export.txt | 14 +++--- source/includes/extracts-query-bar.yaml | 2 +- source/includes/fact-collections-screen.rst | 2 +- ...ct-natural-language-querying-maxTimems.rst | 2 +- source/includes/fact-release-notes-1.11.rst | 2 +- source/includes/steps-create-collection.yaml | 10 ++--- source/includes/steps-create-index.yaml | 2 +- source/includes/steps-delete-database.yaml | 2 +- source/includes/steps-drop-index.yaml | 2 +- source/includes/steps-export-filter.yaml | 8 ++-- source/includes/steps-export.yaml | 4 +- source/includes/steps-import.yaml | 4 +- source/index.txt | 8 ++-- source/indexes.txt | 8 ++-- source/indexes/create-search-index.txt | 2 +- source/indexes/create-vector-search-index.txt | 2 +- source/instance.txt | 2 +- source/manage-data.txt | 12 ++--- .../ai-and-data-usage-information.txt | 2 +- .../enable-natural-language-querying.txt | 4 +- .../prompt-natural-language-aggregation.txt | 10 ++--- .../prompt-natural-language-query.txt | 10 ++--- .../query-with-natural-language.txt | 8 ++-- source/query/atlas-search.txt | 2 +- source/query/collation.txt | 2 +- source/query/filter.txt | 3 +- source/query/limit.txt | 2 +- source/query/maxtimems.txt | 2 +- source/query/project.txt | 2 +- source/query/queries.txt | 14 +++--- source/query/recent.txt | 8 ++-- source/query/skip.txt | 2 +- source/query/sort.txt | 2 +- source/release-notes.txt | 44 +++++++++---------- source/sampling.txt | 2 +- source/schema.txt | 16 +++---- source/schema/export.txt | 4 +- source/settings/config-file.txt | 2 +- .../restrict-outgoing-connections.txt | 2 +- source/settings/settings-reference.txt | 4 +- source/validation.txt | 4 +- source/views.txt | 14 +++--- 70 files changed, 208 insertions(+), 209 deletions(-) diff --git a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt index e5e780037..8cf80526c 100644 --- a/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt +++ b/source/agg-pipeline-builder/aggregation-pipeline-builder-settings.txt @@ -1,4 +1,4 @@ -.. _pipeline-builder-settings: +.. _compass-pipeline-builder-settings: ===================================== Aggregation Pipeline Builder Settings @@ -49,8 +49,8 @@ the upper right of the pipeline builder to open the :guilabel:`Settings` panel. Learn More ---------- -- :ref:`create-agg-pipeline` +- :ref:`compass-create-agg-pipeline` -- :ref:`pipeline-custom-collation` +- :ref:`compass-pipeline-custom-collation` -- :ref:`set-maxtime-ms-agg` +- :ref:`compass-set-maxtime-ms-agg` diff --git a/source/agg-pipeline-builder/count-pipeline-results.txt b/source/agg-pipeline-builder/count-pipeline-results.txt index 946bd9c92..4a19b5384 100644 --- a/source/agg-pipeline-builder/count-pipeline-results.txt +++ b/source/agg-pipeline-builder/count-pipeline-results.txt @@ -1,4 +1,4 @@ -.. _count-pipeline-results: +.. _compass-count-pipeline-results: ================================ Count Pipeline Results Documents @@ -26,7 +26,7 @@ Before You Begin ---------------- To count result documents, you must first :ref:`create and run -` your aggregation pipeline. You can't count result +` your aggregation pipeline. You can't count result documents while editing your pipeline. Steps diff --git a/source/agg-pipeline-builder/create-a-view.txt b/source/agg-pipeline-builder/create-a-view.txt index 06cf1335e..c1ad87ad9 100644 --- a/source/agg-pipeline-builder/create-a-view.txt +++ b/source/agg-pipeline-builder/create-a-view.txt @@ -1,4 +1,4 @@ -.. _create-a-view: +.. _compass-create-a-view: =================================== Create a View from Pipeline Results diff --git a/source/agg-pipeline-builder/export-pipeline-results.txt b/source/agg-pipeline-builder/export-pipeline-results.txt index cc36d5cf0..0ec4cc4ab 100644 --- a/source/agg-pipeline-builder/export-pipeline-results.txt +++ b/source/agg-pipeline-builder/export-pipeline-results.txt @@ -1,4 +1,4 @@ -.. _export-agg-builder-results: +.. _compass-export-agg-builder-results: =================================== Export Aggregation Pipeline Results diff --git a/source/agg-pipeline-builder/export-pipeline-to-language.txt b/source/agg-pipeline-builder/export-pipeline-to-language.txt index e59ca7cec..5b5ef3bb9 100644 --- a/source/agg-pipeline-builder/export-pipeline-to-language.txt +++ b/source/agg-pipeline-builder/export-pipeline-to-language.txt @@ -60,9 +60,9 @@ Steps Click the :guilabel:`Include Driver Syntax` checkbox to include application code for the selected programming language. If you include driver syntax, the copyable code reflects :ref:`project - `, :ref:`sort `, :ref:`maxtimems - `, :ref:`collation `, - :ref:`skip ` and :ref:`limit ` options. + `, :ref:`sort `, :ref:`maxtimems + `, :ref:`collation `, + :ref:`skip ` and :ref:`limit ` options. .. step:: Click :icon-fa4:`files-o` diff --git a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt index 3c660db8d..cf59c4e91 100644 --- a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt +++ b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt @@ -1,4 +1,4 @@ -.. _set-maxtime-ms-agg: +.. _compass-set-maxtime-ms-agg: ======================================= Set Max Time MS for Aggregation Queries @@ -64,4 +64,4 @@ Learn More - :ref:`compass-interface-settings` -- :ref:`query-bar-max-time-ms` +- :ref:`compass-query-bar-max-time-ms` diff --git a/source/agg-pipeline-builder/open-saved-pipeline.txt b/source/agg-pipeline-builder/open-saved-pipeline.txt index 02f40cf2b..ce4fd3932 100644 --- a/source/agg-pipeline-builder/open-saved-pipeline.txt +++ b/source/agg-pipeline-builder/open-saved-pipeline.txt @@ -1,4 +1,4 @@ -.. _open-saved-pipeline: +.. _compass-open-saved-pipeline: ===================== Open a Saved Pipeline @@ -20,9 +20,9 @@ Before You Begin If you don't already have a saved pipeline, you must first: -- :ref:`Create an aggregation pipeline `. +- :ref:`Create an aggregation pipeline `. -- :ref:`Save your aggregation pipeline `. +- :ref:`Save your aggregation pipeline `. Steps ----- @@ -57,11 +57,11 @@ Steps after you connect to your cluster. To learn more, see - :ref:`viewing saved aggregations ` for details. + :ref:`viewing saved aggregations ` for details. Learn More ---------- -- :ref:`save-agg-pipeline` +- :ref:`compass-save-agg-pipeline` -- :ref:`saved-query-view` +- :ref:`compass-saved-query-view` diff --git a/source/agg-pipeline-builder/pipeline-custom-collation.txt b/source/agg-pipeline-builder/pipeline-custom-collation.txt index a04da81d8..3de390826 100644 --- a/source/agg-pipeline-builder/pipeline-custom-collation.txt +++ b/source/agg-pipeline-builder/pipeline-custom-collation.txt @@ -1,4 +1,4 @@ -.. _pipeline-custom-collation: +.. _compass-pipeline-custom-collation: ========================================== Specify Custom Collation For Your Pipeline diff --git a/source/agg-pipeline-builder/save-agg-pipeline.txt b/source/agg-pipeline-builder/save-agg-pipeline.txt index cd9981bca..04cacf115 100644 --- a/source/agg-pipeline-builder/save-agg-pipeline.txt +++ b/source/agg-pipeline-builder/save-agg-pipeline.txt @@ -1,4 +1,4 @@ -.. _save-agg-pipeline: +.. _compass-save-agg-pipeline: =============== Save a Pipeline @@ -15,7 +15,7 @@ Save a Pipeline You can save your aggregation pipelines to find and use them again later. If you load a saved pipeline, you can make edits to the pipeline stages without changing the original saved pipeline. You can also create a :ref:`view -` from your pipeline results. +` from your pipeline results. Steps ----- @@ -25,8 +25,8 @@ Steps Learn More ---------- -- :ref:`open-saved-pipeline` +- :ref:`compass-open-saved-pipeline` -- :ref:`create-a-view` +- :ref:`compass-create-a-view` -- :ref:`saved-queries-agg` +- :ref:`compass-saved-queries-agg` diff --git a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt index 1d9e3d962..ca38502d3 100644 --- a/source/agg-pipeline-builder/view-pipeline-explain-plan.txt +++ b/source/agg-pipeline-builder/view-pipeline-explain-plan.txt @@ -1,4 +1,4 @@ -.. _view-pipeline-explain-plans: +.. _compass-view-pipeline-explain-plans: ================================= View Explain Plans for a Pipeline diff --git a/source/collections.txt b/source/collections.txt index 447c51530..efc858da5 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -1,4 +1,4 @@ -.. _collection-tab: +.. _compass-collection-tab: ============================= Manage Collections in Compass @@ -23,7 +23,7 @@ A collection is a grouping of MongoDB :ref:`documents `. Documents within a collection can have different fields. A collection is the equivalent of a table in a relational database system. A collection exists within a -single :ref:`database ` +single :ref:`database `. Collections Screen ------------------ @@ -61,7 +61,7 @@ information for each collection in the selected database: collection. Hover over a :guilabel:`Collation` banner to view the properties for that collection. -.. _create-collection: +.. _compass-create-collection: Create a Collection ------------------- @@ -70,7 +70,7 @@ You can create new collections in an existing database. .. include:: /includes/steps/create-collection.rst -.. _drop-collection: +.. _compass-drop-collection: Drop a Collection ----------------- @@ -89,7 +89,7 @@ collection details, either: - Click a collection in the left navigation. -- Open the collection in a :ref:`new tab `. +- Open the collection in a :ref:`new tab `. After you select a collection, |compass-short| shows you that collection's :ref:`Documents tab `. |compass-short| provides @@ -102,13 +102,13 @@ view: - :ref:`compass-agg-builder` -- :ref:`Schema Analysis ` +- :ref:`Schema Analysis ` - :ref:`explain-plans` - :ref:`compass-indexes` -- :ref:`validation` +- :ref:`compass-validation` .. note:: Data Lake Limitations @@ -125,7 +125,7 @@ view: - Set Validation Rules for Your Schema -.. _tabbed-view: +.. _compass-tabbed-view: Tabbed View ~~~~~~~~~~~ diff --git a/source/collections/capped-collection.txt b/source/collections/capped-collection.txt index 5473d04b4..1fddda6bc 100644 --- a/source/collections/capped-collection.txt +++ b/source/collections/capped-collection.txt @@ -1,4 +1,4 @@ -.. _capped-collection: +.. _compass-capped-collection: ========================== Create a Capped Collection diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt index ea09aaf4a..c9736703a 100644 --- a/source/collections/clustered-collection.txt +++ b/source/collections/clustered-collection.txt @@ -1,4 +1,4 @@ -.. _clustered-collection: +.. _compass-clustered-collection: ============================= Create a Clustered Collection @@ -71,4 +71,4 @@ Next Steps - :ref:`Query Your Data` -- :ref:`Analyze Your Data Scheme ` +- :ref:`Analyze Your Data Scheme ` diff --git a/source/collections/collation-collection.txt b/source/collections/collation-collection.txt index b052be1cc..4c381601d 100644 --- a/source/collections/collation-collection.txt +++ b/source/collections/collation-collection.txt @@ -1,4 +1,4 @@ -.. _collation-collection: +.. _compass-collation-collection: ================================== Create a Collection with Collation diff --git a/source/collections/encrypted-collection.txt b/source/collections/encrypted-collection.txt index fc4dd2f75..ee0953d02 100644 --- a/source/collections/encrypted-collection.txt +++ b/source/collections/encrypted-collection.txt @@ -1,4 +1,4 @@ -.. _encrypted-collection: +.. _compass-encrypted-collection: ============================================= Create a Collection with Queryable Encryption diff --git a/source/collections/time-series-collection.txt b/source/collections/time-series-collection.txt index b552c04aa..8984d1a4a 100644 --- a/source/collections/time-series-collection.txt +++ b/source/collections/time-series-collection.txt @@ -1,4 +1,4 @@ -.. _time-series-collection: +.. _compass-time-series-collection: =============================== Create a Time Series Collection diff --git a/source/connect/connections.txt b/source/connect/connections.txt index e1d094ed1..31aec6049 100644 --- a/source/connect/connections.txt +++ b/source/connect/connections.txt @@ -60,7 +60,7 @@ to interact with to open the :guilabel:`Databases` tab. When you open a database, MongoDB opens a new tab and labels it with the name of the MongoDB instance that contains that database. For more information about the :guilabel:`Databases` tab and instructions on viewing a database, -see :ref:`Databases `. +see :ref:`Databases `. Connection Options ------------------ diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index 0aee95c40..23b30735b 100644 --- a/source/connect/required-access.txt +++ b/source/connect/required-access.txt @@ -33,27 +33,27 @@ privileges: - :authrole:`clusterMonitor` * - :guilabel:`Database` - - :ref:`create-database` + - :ref:`compass-create-database` - :authaction:`createCollection` - :authrole:`readWrite` * - :guilabel:`Database` - - :ref:`drop-database` + - :ref:`compass-drop-database` - :authaction:`dropDatabase` - :authrole:`dbAdmin` * - :guilabel:`Collection` - - :ref:`create-collection` + - :ref:`compass-create-collection` - :authaction:`createCollection` - :authrole:`readWrite` * - :guilabel:`Collection` - - :ref:`drop-collection` + - :ref:`compass-drop-collection` - :authaction:`dropCollection` - :authrole:`readWrite` * - :guilabel:`Schema` - - :ref:`Query/View a Schema ` + - :ref:`Query/View a Schema ` - :authaction:`find` - :authrole:`read` @@ -87,12 +87,12 @@ privileges: - :authrole:`read` * - :guilabel:`Validation` - - :ref:`View rules ` + - :ref:`View rules ` - :authaction:`listCollections` - :authrole:`read` * - :guilabel:`Validation` - - :ref:`Update rules ` + - :ref:`Update rules ` - :authaction:`collMod` - :authrole:`dbAdmin` diff --git a/source/create-agg-pipeline.txt b/source/create-agg-pipeline.txt index 4fa909812..5a09320e8 100644 --- a/source/create-agg-pipeline.txt +++ b/source/create-agg-pipeline.txt @@ -1,5 +1,5 @@ .. _compass-agg-builder: -.. _create-agg-pipeline: +.. _compass-create-agg-pipeline: ============================== Create an Aggregation Pipeline @@ -369,7 +369,7 @@ Learn More - :manual:`Aggregation Pipeline Stages ` -- :ref:`pipeline-builder-settings` +- :ref:`compass-pipeline-builder-settings` - :ref:`compass-export-pipeline` diff --git a/source/databases.txt b/source/databases.txt index ebf1b047c..319252a0c 100644 --- a/source/databases.txt +++ b/source/databases.txt @@ -1,4 +1,4 @@ -.. _database-tab: +.. _compass-database-tab: =========================== Manage Databases in Compass @@ -12,7 +12,7 @@ Manage Databases in Compass :depth: 1 :class: singlecol -A database is a container for :ref:`collections `. +A database is a container for :ref:`collections `. Each database gets its own set of files on the host file system. A single MongoDB server typically has multiple databases. @@ -28,20 +28,20 @@ deployment name in the :guilabel:`Connections Sidebar`. :alt: Databases View From this view, you can click a database name in the sidebar to view its -:ref:`collections `. Alternatively, you can view -database collections by clicking the desired database in the left-hand navigation. +collections. Alternatively, you can view database collections by clicking the +desired database in the left-hand navigation. -You can also :ref:`create ` or -:ref:`drop databases ` from this view. +You can also :ref:`create ` or +:ref:`drop databases ` from this view. -.. _create-database: +.. _compass-create-database: Create a Database ----------------- .. include:: /includes/steps/create-database.rst -.. _drop-database: +.. _compass-drop-database: Drop a Database --------------- diff --git a/source/documents.txt b/source/documents.txt index ad47463ee..bf18a6acf 100644 --- a/source/documents.txt +++ b/source/documents.txt @@ -7,15 +7,15 @@ Manage Documents in Compass .. default-domain:: mongodb Documents are individual records in a MongoDB :ref:`collection -` and are the basic unit of data in MongoDB. +` and are the basic unit of data in MongoDB. -.. _documents-tab: +.. _compass-documents-tab: From the :guilabel:`Documents` tab, you can -:ref:`view `, :ref:`insert `, +:ref:`view `, :ref:`insert `, :ref:`modify `, :ref:`modify multiple `, -:ref:`clone `, +:ref:`clone `, :ref:`delete `, and :ref:`delete multiple ` documents in your selected collection or view. @@ -25,17 +25,17 @@ documents in your selected collection or view. For query result sets larger than 20 documents, Compass shows paginated results. By default, pages display 20 documents at a time. -From the :ref:`query bar `, you can specify a query to +From the :ref:`query bar `, you can specify a query to filter the displayed documents. Click :guilabel:`Options` to specify query options. .. seealso:: - :ref:`compass-view-documents` - - :ref:`insert-documents` + - :ref:`compass-insert-documents` - :ref:`compass-modify-documents` - :ref:`compass-bulk-update` - - :ref:`clone-documents` + - :ref:`compass-clone-documents` - :ref:`compass-delete-documents` - :ref:`compass-bulk-delete` diff --git a/source/documents/clone.txt b/source/documents/clone.txt index 0e7ee52be..571466626 100644 --- a/source/documents/clone.txt +++ b/source/documents/clone.txt @@ -1,4 +1,4 @@ -.. _clone-documents: +.. _compass-clone-documents: =============== Clone Documents @@ -63,4 +63,4 @@ When you click the :guilabel:`Clone` button, |compass-short| opens the document insertion dialog with the same schema and values as the cloned document. You can edit any of these fields and values before you insert the new document. To learn more about inserting documents, see -:ref:`insert-documents`. +:ref:`compass-insert-documents`. diff --git a/source/documents/insert.txt b/source/documents/insert.txt index 43d70eed8..e96b09fc3 100644 --- a/source/documents/insert.txt +++ b/source/documents/insert.txt @@ -1,4 +1,4 @@ -.. _insert-documents: +.. _compass-insert-documents: ================ Insert Documents diff --git a/source/documents/modify-multiple.txt b/source/documents/modify-multiple.txt index 1d8cc9cc8..1f180b578 100644 --- a/source/documents/modify-multiple.txt +++ b/source/documents/modify-multiple.txt @@ -99,7 +99,7 @@ Steps You can name and save the update query in the :guilabel:`Update Documents` modal. Saving your query adds it - to your :ref:`favorite queries ` for + to your :ref:`favorite queries ` for that collection and allows you to load and copy the query after you close the modal. @@ -169,4 +169,4 @@ Learn More ---------- - :ref:`compass-bulk-delete` -- :ref:`saved-favorite-query-view` +- :ref:`compass-saved-favorite-query-view` diff --git a/source/documents/view.txt b/source/documents/view.txt index f6b004bd0..330bc3854 100644 --- a/source/documents/view.txt +++ b/source/documents/view.txt @@ -1,7 +1,7 @@ .. _compass-view-documents: -.. _docs-list-table-view: -.. _documents-table-view: -.. _documents-list-view: +.. _compass-docs-list-table-view: +.. _compass-documents-table-view: +.. _compass-documents-list-view: ============== View Documents diff --git a/source/editions.txt b/source/editions.txt index 09ee74615..ceec65b96 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -17,8 +17,8 @@ suit your needs. - Compass Isolated * - Interact with :ref:`documents `, - :ref:`collections `, and - :ref:`databases ` with full CRUD functionality + :ref:`collections `, and + :ref:`databases ` with full CRUD functionality - |checkmark| - - |checkmark| @@ -45,7 +45,7 @@ suit your needs. - |checkmark| - |checkmark| - * - :ref:`Schema Analysis ` + * - :ref:`Schema Analysis ` - |checkmark| - |checkmark| - |checkmark| @@ -55,7 +55,7 @@ suit your needs. - |checkmark| - |checkmark| - * - Create, delete and edit :ref:`document validation ` + * - Create, delete and edit :ref:`document validation ` rules - |checkmark| - diff --git a/source/export-query-to-language.txt b/source/export-query-to-language.txt index b5c5bb2db..eeecff38c 100644 --- a/source/export-query-to-language.txt +++ b/source/export-query-to-language.txt @@ -44,10 +44,10 @@ Procedure #. *(Optional)*: Check the :guilabel:`Include Driver Syntax` option to include application code for the language selected. If you include driver syntax, the copyable code reflects - :ref:`project `, :ref:`sort `, - :ref:`maxtimems `, - :ref:`collation `, :ref:`skip ` - and :ref:`limit ` options. + :ref:`project `, :ref:`sort `, + :ref:`maxtimems `, + :ref:`collation `, :ref:`skip ` + and :ref:`limit ` options. #. Click :icon-fa5:`copy` at the top-right of the formatted query to copy the query for the selected language to your clipboard. diff --git a/source/faq.txt b/source/faq.txt index cba30096a..2be7ef8b8 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -82,7 +82,7 @@ Slow Sampling All queries that Compass sends to your MongoDB instance have a timeout flag set which automatically aborts a request if it takes longer than the specified timeout. This timeout is currently set to 10 seconds. If -:ref:`sampling ` on the database takes longer, Compass will +:ref:`sampling ` on the database takes longer, Compass will notify you about the timeout and give you the options of (a) retrying with a longer timeout (60 seconds) or (b) running a different query. diff --git a/source/import-export.txt b/source/import-export.txt index 635f3f9ea..eed164e84 100644 --- a/source/import-export.txt +++ b/source/import-export.txt @@ -25,10 +25,10 @@ Import and Export Data :keywords: atlas You can use |compass| to import and export data to and from -:ref:`collections `. |compass-short| supports import and +:ref:`collections `. |compass-short| supports import and export for both **JSON** and **CSV** files. To import or export data to or from a collection, navigate to the detailed collection view by either -selecting the collection from the :ref:`Databases ` tab or +selecting the collection from the :ref:`Databases ` tab or clicking the collection in the left-side navigation. .. note:: @@ -143,7 +143,7 @@ Export Data from a Collection |compass| can export data from a collection as either a **JSON** or **CSV** file. If you specify a -:ref:`filter ` or :ref:`aggregation pipeline +:ref:`filter ` or :ref:`aggregation pipeline ` for your collection, |compass-short| only exports documents which match the specified query or pipeline results. @@ -156,7 +156,7 @@ Behavior - You can use a query filter to export only the documents that match the filter. -- You can use the :ref:`Project ` field in the query bar to +- You can use the :ref:`Project ` field in the query bar to specify the fields to return or export. Procedure @@ -190,7 +190,7 @@ Procedure .. procedure:: :style: normal - .. step:: Connect to the deployment containing the :ref:`collection ` you wish to export data from. + .. step:: Connect to the deployment containing the collection you wish to export data from. To learn how to connect to a deployment, see :ref:`connect-run-compass`. @@ -198,13 +198,13 @@ Procedure .. step:: Navigate to your target collection. You can either select the collection from the - :ref:`Collections ` tab or click the collection + :guilabel:`Collections` tab or click the collection in the left-hand pane. .. step:: Create an aggregation pipeline and run for results. To learn how to create an aggregation pipeline, see :ref:`Create an - Aggregation Pipeline `. + Aggregation Pipeline `. .. step:: Click :guilabel:`Export`. diff --git a/source/includes/extracts-query-bar.yaml b/source/includes/extracts-query-bar.yaml index 39cecb89d..323844a0e 100644 --- a/source/includes/extracts-query-bar.yaml +++ b/source/includes/extracts-query-bar.yaml @@ -4,7 +4,7 @@ content: | subset of the results. Otherwise, Compass shows the entire result set. - For details on sampling, see :ref:`Sampling `. + For details on sampling, see :ref:`Sampling `. --- ref: query-bar-type-schema content: | diff --git a/source/includes/fact-collections-screen.rst b/source/includes/fact-collections-screen.rst index 7ffdf401e..4951f0cb8 100644 --- a/source/includes/fact-collections-screen.rst +++ b/source/includes/fact-collections-screen.rst @@ -5,7 +5,7 @@ list item includes the name and other general information for the collection or view. To access the :guilabel:`Collections` screen for a database, from the -:ref:`Databases screen ` either: +:ref:`Databases screen ` either: - Click a :guilabel:`Database Name` in the main :guilabel:`Databases` view, or diff --git a/source/includes/fact-natural-language-querying-maxTimems.rst b/source/includes/fact-natural-language-querying-maxTimems.rst index 19365a724..829b618f2 100644 --- a/source/includes/fact-natural-language-querying-maxTimems.rst +++ b/source/includes/fact-natural-language-querying-maxTimems.rst @@ -2,4 +2,4 @@ It can be difficult to predict the complexity of the query or pipeline returned by the Compass AI. You may need to adjust the :guilabel:`MAX TIME MS` query bar option to either allow longer query processing time or prevent long-running queries. For details, see -:ref:`query-bar-max-time-ms`. \ No newline at end of file +:ref:`compass-query-bar-max-time-ms`. \ No newline at end of file diff --git a/source/includes/fact-release-notes-1.11.rst b/source/includes/fact-release-notes-1.11.rst index 545052b0d..e08791407 100644 --- a/source/includes/fact-release-notes-1.11.rst +++ b/source/includes/fact-release-notes-1.11.rst @@ -4,5 +4,5 @@ - Added support for :ref:`disconnecting ` from the active MongoDB instance without restarting |compass|. -- Added :ref:`Table View ` for documents as a +- Added :ref:`Table View ` for documents as a method of viewing the contents of a collection in tabular format. \ No newline at end of file diff --git a/source/includes/steps-create-collection.yaml b/source/includes/steps-create-collection.yaml index c8ea9044e..6a0144507 100644 --- a/source/includes/steps-create-collection.yaml +++ b/source/includes/steps-create-collection.yaml @@ -15,15 +15,15 @@ content: | |compass-short| also provides you with :guilabel:`Additional preferences`. You can select from the following: - - :ref:`Create a Capped Collection ` + - :ref:`Create a Capped Collection ` - - :ref:`Create a Clustered Collection ` + - :ref:`Create a Clustered Collection ` - - :ref:`Create a Collection with Collation ` + - :ref:`Create a Collection with Collation ` - - :ref:`Create a Collection with Encrypted Fields ` + - :ref:`Create a Collection with Encrypted Fields ` - - :ref:`Create a Time Series Collection ` + - :ref:`Create a Time Series Collection ` --- title: Click :guilabel:`Create Collection` to create the collection. level: 4 diff --git a/source/includes/steps-create-index.yaml b/source/includes/steps-create-index.yaml index eb2c1795b..1971605c4 100644 --- a/source/includes/steps-create-index.yaml +++ b/source/includes/steps-create-index.yaml @@ -3,7 +3,7 @@ level: 4 ref: create-collection stepnum: 1 content: | - From the :ref:`Indexes ` tab, click the :guilabel:`Create + From the :ref:`Indexes ` tab, click the :guilabel:`Create Index` button. --- title: Add fields to the index diff --git a/source/includes/steps-delete-database.yaml b/source/includes/steps-delete-database.yaml index 03d59fb71..acbdb3100 100644 --- a/source/includes/steps-delete-database.yaml +++ b/source/includes/steps-delete-database.yaml @@ -2,7 +2,7 @@ title: Click the trash can icon for the database. level: 4 ref: drop-database content: | - From the :ref:`Databases ` tab, to delete a + From the :ref:`Databases ` tab, to delete a database, click on the trash can icon for that database. A confirmation dialog appears. diff --git a/source/includes/steps-drop-index.yaml b/source/includes/steps-drop-index.yaml index 186ee943c..df49e4c1a 100644 --- a/source/includes/steps-drop-index.yaml +++ b/source/includes/steps-drop-index.yaml @@ -2,7 +2,7 @@ title: Click the trash can icon for the index to drop. level: 4 ref: drop-index content: | - From the :ref:`Indexes ` tab, to delete an index, + From the :ref:`Indexes ` tab, to delete an index, click on the trash can icon for that index. A confirmation dialog appears. diff --git a/source/includes/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml index beac09615..7f2d4d4fd 100644 --- a/source/includes/steps-export-filter.yaml +++ b/source/includes/steps-export-filter.yaml @@ -1,5 +1,5 @@ title: Connect to the deployment containing the - :ref:`collection ` you wish to export data from. + :ref:`collection ` you wish to export data from. level: 4 ref: connect-deployment content: | @@ -11,14 +11,14 @@ level: 4 ref: select-collection content: | You can either select the collection from the - :ref:`Collections ` tab or click the collection in the + :ref:`Collections ` tab or click the collection in the left-hand pane. --- title: Specify a filter in the :guilabel:`query bar`. level: 4 ref: export-specify-filter content: | - Specify a :ref:`filter ` in the + Specify a :ref:`filter ` in the :ref:`query bar ` to export only the documents which match the filter. --- @@ -49,7 +49,7 @@ content: | fields. Fields which only appear in a small percentage of documents may not be automatically detected. - For details on sampling, see :ref:`Sampling `. + For details on sampling, see :ref:`Sampling `. --- title: Select the appropriate file type. diff --git a/source/includes/steps-export.yaml b/source/includes/steps-export.yaml index 2ad451a3e..df05b4cc7 100644 --- a/source/includes/steps-export.yaml +++ b/source/includes/steps-export.yaml @@ -1,5 +1,5 @@ title: Connect to the deployment containing the - :ref:`collection ` you wish to export data from. + :ref:`collection ` you wish to export data from. level: 4 ref: connect-deployment content: | @@ -11,7 +11,7 @@ level: 4 ref: select-collection content: | You can either select the collection from the - :ref:`Collections ` tab or click the collection in the + :ref:`Collections ` tab or click the collection in the left-hand pane. --- title: Click the :guilabel:`Export Data` dropdown and select :guilabel:`Export the full collection`. diff --git a/source/includes/steps-import.yaml b/source/includes/steps-import.yaml index 955b0a712..926b44486 100644 --- a/source/includes/steps-import.yaml +++ b/source/includes/steps-import.yaml @@ -1,5 +1,5 @@ title: Connect to the deployment containing the - :ref:`collection ` you wish to import data into. + :ref:`collection ` you wish to import data into. level: 4 ref: connect-deployment content: | @@ -11,7 +11,7 @@ level: 4 ref: select-collection content: | You can either select the collection from the - :ref:`Collections ` tab or click the collection in the + :ref:`Collections ` tab or click the collection in the left-hand pane. --- title: Click the :guilabel:`Add Data` dropdown and select diff --git a/source/index.txt b/source/index.txt index da0ac5437..5ec1c825a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -63,7 +63,7 @@ Explore some of the tasks Compass can help you accomplish, such as importing and Paste documents into the JSON view, or manually insert documents using a field-by-field editor. - :ref:`To learn more, see Insert Documents` + :ref:`To learn more, see Insert Documents` .. step:: Query your data @@ -73,8 +73,8 @@ Explore some of the tasks Compass can help you accomplish, such as importing and To learn more, see: - - :ref:`Query Your Data` - - :ref:`Query with Natural Language` + - :ref:`Query Your Data` + - :ref:`Query with Natural Language` .. image:: /images/tabs/query-your-data.png :alt: MongoDB Compass collection query image @@ -88,7 +88,7 @@ Explore some of the tasks Compass can help you accomplish, such as importing and Insert documents into your collections in two ways, JSON Mode and a Field-by-Field Editor. - :ref:`To learn more, see Insert Documents` + :ref:`To learn more, see Insert Documents` .. step:: Create aggregation pipelines diff --git a/source/indexes.txt b/source/indexes.txt index 3f4c67be6..3edeb8ea9 100644 --- a/source/indexes.txt +++ b/source/indexes.txt @@ -19,7 +19,7 @@ ordered by the value of the field. To improve query performance, build indexes on fields that appear often in queries and for all operations that -:ref:`sort by a field `. +:ref:`sort by a field `. - Queries on an indexed field can use the index to limit the number of documents that must be scanned to find matching documents. @@ -37,7 +37,7 @@ To learn more about indexes, see :manual:`Indexes `. of considerations for indexes, see :ref:`Operational Considerations for Indexes `. -.. _indexes-tab: +.. _compass-indexes-tab: Indexes Tab ----------- @@ -73,7 +73,7 @@ For each index, Compass displays the following information: - Any special properties (such as uniqueness, partial) of the index. -.. _create-index: +.. _compass-create-index: Create an Index --------------- @@ -157,7 +157,7 @@ index. :guilabel:`Properties` column. -.. _drop-index: +.. _compass-drop-index: Drop an Index ------------- diff --git a/source/indexes/create-search-index.txt b/source/indexes/create-search-index.txt index ca490080c..227e4f270 100644 --- a/source/indexes/create-search-index.txt +++ b/source/indexes/create-search-index.txt @@ -42,7 +42,7 @@ Create an Index .. step:: Open the index creation dialog - From the :ref:`Indexes ` tab, click the + From the :ref:`Indexes ` tab, click the :guilabel:`Create` button, then click :guilabel:`Search Index`. .. step:: Specify a name for the index diff --git a/source/indexes/create-vector-search-index.txt b/source/indexes/create-vector-search-index.txt index 113c33ece..2dfa60dff 100644 --- a/source/indexes/create-vector-search-index.txt +++ b/source/indexes/create-vector-search-index.txt @@ -42,7 +42,7 @@ Steps .. step:: Open the index creation dialog - From the :ref:`Indexes ` tab, click the + From the :ref:`Indexes ` tab, click the :guilabel:`Create` button and then click :guilabel:`Search Index`. .. step:: Specify a name for the index diff --git a/source/instance.txt b/source/instance.txt index 53444b5c4..f57b0b57e 100644 --- a/source/instance.txt +++ b/source/instance.txt @@ -26,7 +26,7 @@ The Compass Home screen includes the following sections: - :ref:`Connections Sidebar ` -- Your :ref:`saved queries and aggregation pipelines `. +- Your :ref:`saved queries and aggregation pipelines `. Once connected to a MongoDB instance, you can reach the Compass Home screen by clicking a cluster name in the :guilabel:`Connections diff --git a/source/manage-data.txt b/source/manage-data.txt index 5cb0a9d3b..f281111fa 100644 --- a/source/manage-data.txt +++ b/source/manage-data.txt @@ -6,10 +6,10 @@ Interact with Your Data .. include:: /includes/atlas-sample-data-note.rst -:ref:`database-tab` +:ref:`compass-database-tab` Learn how to create and manage databases in your deployment. -:ref:`collection-tab` +:ref:`compass-collection-tab` Learn how to manage collections in your databases. :ref:`compass-views` @@ -20,25 +20,25 @@ Interact with Your Data :ref:`compass-documents` Learn how to manage documents in your collections. -:ref:`query-bar-filter` +:ref:`compass-query-bar-filter` Learn how to query your data to return data that matches a specified criteria. :ref:`compass-indexes` Learn how to create indexes to improve query performance. -:ref:`schema-tab` +:ref:`compass-schema-tab` Learn how to analyze your data schema and shape of the fields in a particular collection. :ref:`compass-performance` Learn how to view and analyze deployment performance. -:ref:`validation` +:ref:`compass-validation` Learn how to ensure that all documents in a collection follow a defined set of rules. -:ref:`sampling` +:ref:`compass-sampling` Learn how |compass-short| samples documents to provide insights about a collection. 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 4add39750..83ba9f1b4 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 @@ -46,7 +46,7 @@ Disable Natural Language Querying - Natural language querying in Compass is available if you have enabled the :ref:`Generative AI setting - ` and logged into Atlas. + ` and logged into Atlas. - If you no longer want to use the feature, uncheck :guilabel:`Enable AI Features` in the :guilabel:`Artificial Intelligence` settings. 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 e326ea91a..d64468eea 100644 --- a/source/query-with-natural-language/enable-natural-language-querying.txt +++ b/source/query-with-natural-language/enable-natural-language-querying.txt @@ -1,4 +1,4 @@ -.. _enable-natural-language-querying: +.. _compass-enable-natural-language-querying: ================================ Enable Natural Language Querying @@ -99,4 +99,4 @@ Steps Next Steps ---------- -:ref:`prompt-natural-language-query` +:ref:`compass-prompt-natural-language-query` diff --git a/source/query-with-natural-language/prompt-natural-language-aggregation.txt b/source/query-with-natural-language/prompt-natural-language-aggregation.txt index c04ed4ad1..c4b57da25 100644 --- a/source/query-with-natural-language/prompt-natural-language-aggregation.txt +++ b/source/query-with-natural-language/prompt-natural-language-aggregation.txt @@ -1,4 +1,4 @@ -.. _prompt-natural-language-agg: +.. _compass-prompt-natural-language-agg: ===================================== Prompt a Natural Language Aggregation @@ -24,7 +24,7 @@ About this Task .. include:: /includes/fact-natural-language-query.rst - You can also provide natural language prompts on the - :ref:`documents tab `. + :ref:`documents tab `. - This page uses the :ref:`sample_mflix.movies ` collection from the Atlas sample dataset. @@ -34,7 +34,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass`. Steps ----- @@ -161,9 +161,9 @@ when using natural language prompts for aggregation. Next Steps ---------- -:ref:`prompt-natural-language-query` +:ref:`compass-prompt-natural-language-query` Learn More ---------- -:ref:`query-natural-language` \ No newline at end of file +:ref:`compass-query-natural-language` \ No newline at end of file diff --git a/source/query-with-natural-language/prompt-natural-language-query.txt b/source/query-with-natural-language/prompt-natural-language-query.txt index 5b17bedeb..1631034b6 100644 --- a/source/query-with-natural-language/prompt-natural-language-query.txt +++ b/source/query-with-natural-language/prompt-natural-language-query.txt @@ -1,4 +1,4 @@ -.. _prompt-natural-language-query: +.. _compass-prompt-natural-language-query: =============================== Prompt a Natural Language Query @@ -29,7 +29,7 @@ About this Task a pop-up displays indicating your prompt requires aggregation stages. - You can also provide natural language prompts on the - :ref:`aggregations tab `. + :ref:`aggregations tab `. - This page uses the :ref:`sample_mflix.movies ` collection from the Atlas sample dataset. @@ -39,7 +39,7 @@ About this Task Before you Begin ---------------- -You must :ref:`enable natural language querying in Compass`. +You must :ref:`enable natural language querying in Compass`. Steps ----- @@ -110,9 +110,9 @@ when using natural language prompts. Next Steps ---------- -:ref:`prompt-natural-language-agg` +:ref:`compass-prompt-natural-language-agg` Learn More ---------- -:ref:`query-natural-language` \ No newline at end of file +:ref:`compass-query-natural-language` \ No newline at end of file diff --git a/source/query-with-natural-language/query-with-natural-language.txt b/source/query-with-natural-language/query-with-natural-language.txt index da62e1cf4..5a3a7d6f8 100644 --- a/source/query-with-natural-language/query-with-natural-language.txt +++ b/source/query-with-natural-language/query-with-natural-language.txt @@ -1,4 +1,4 @@ -.. _query-natural-language: +.. _compass-query-natural-language: =========================== Query with Natural Language @@ -43,9 +43,9 @@ Behavior Get Started ----------- -- :ref:`enable-natural-language-querying` -- :ref:`prompt-natural-language-query` -- :ref:`prompt-natural-language-agg` +- :ref:`compass-enable-natural-language-querying` +- :ref:`compass-prompt-natural-language-query` +- :ref:`compass-prompt-natural-language-agg` Details ------- diff --git a/source/query/atlas-search.txt b/source/query/atlas-search.txt index 905765a5f..5cc81d8c5 100644 --- a/source/query/atlas-search.txt +++ b/source/query/atlas-search.txt @@ -1,4 +1,4 @@ -.. _run-atlas-search-query: +.. _compass-run-atlas-search-query: ======================== Run Atlas Search Queries diff --git a/source/query/collation.txt b/source/query/collation.txt index 2f8ed1b90..e3587ca87 100644 --- a/source/query/collation.txt +++ b/source/query/collation.txt @@ -1,4 +1,4 @@ -.. _query-bar-collation: +.. _compass-query-bar-collation: ================================================= Set Language Specific Rules for String Comparison diff --git a/source/query/filter.txt b/source/query/filter.txt index e1ffd130b..4fbbeb439 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -1,5 +1,4 @@ -.. _query-bar-filter: -.. _query-bar: +.. _compass-query-bar-filter: .. _compass-query-bar: =============== diff --git a/source/query/limit.txt b/source/query/limit.txt index 5a35722f6..0d6465dfa 100644 --- a/source/query/limit.txt +++ b/source/query/limit.txt @@ -1,4 +1,4 @@ -.. _query-bar-limit: +.. _compass-query-bar-limit: ====================================== Limit the Number of Returned Documents diff --git a/source/query/maxtimems.txt b/source/query/maxtimems.txt index 659b52736..208dba88f 100644 --- a/source/query/maxtimems.txt +++ b/source/query/maxtimems.txt @@ -1,4 +1,4 @@ -.. _query-bar-max-time-ms: +.. _compass-query-bar-max-time-ms: ======================================== Adjust Maximum Time for Query Operations diff --git a/source/query/project.txt b/source/query/project.txt index f3e455310..ac465757d 100644 --- a/source/query/project.txt +++ b/source/query/project.txt @@ -1,4 +1,4 @@ -.. _query-bar-project: +.. _compass-query-bar-project: ============================= Set Which Fields Are Returned diff --git a/source/query/queries.txt b/source/query/queries.txt index 4eb317755..f7b505d49 100644 --- a/source/query/queries.txt +++ b/source/query/queries.txt @@ -1,4 +1,4 @@ -.. _saved-queries-agg: +.. _compass-saved-queries-agg: ======================================= Managing Saved Queries and Aggregations @@ -31,13 +31,13 @@ Saving an Aggregation Pipeline You can save a pipeline so that you can find it later. If you load a saved pipeline, you can change it without changing the original saved copy. You can also create a :ref:`view -` from your pipeline results. +` from your pipeline results. To save your pipeline: .. include:: /includes/fact-save-pipeline.rst -.. _favorite-queries: +.. _compass-favorite-queries: Saving a Favorite Query ----------------------- @@ -50,7 +50,7 @@ To add a query to your favorites: .. include:: /includes/fact-favorite-query.rst -.. _view-favorite-queries: +.. _compass-view-favorite-queries: Viewing Saved Queries --------------------- @@ -59,7 +59,7 @@ Starting in |compass| 1.31, you can view your saved queries and aggregation pipelines on the :guilabel:`My Queries` tab once connected to your cluster. -.. _saved-query-view: +.. _compass-saved-query-view: Using the :guilabel:`My Queries` Tab ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -70,7 +70,7 @@ When you click a saved or favorite query tile, Compass opens the When you click a saved or favorite pipeline tile, Compass opens the :guilabel:`Aggregations` tab with the pipeline loaded. -.. _saved-favorite-query-view: +.. _compass-saved-favorite-query-view: Using the :guilabel:`Favorites` Tab ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -85,7 +85,7 @@ Viewing Query History --------------------- For details on how to view query history see -:ref:`viewing recent query history `. +:ref:`viewing recent query history `. .. toctree:: :titlesonly: diff --git a/source/query/recent.txt b/source/query/recent.txt index a1416a50c..c14541c15 100644 --- a/source/query/recent.txt +++ b/source/query/recent.txt @@ -1,5 +1,5 @@ -.. _recent-queries: -.. _past-query-view: +.. _compass-recent-queries: +.. _compass-past-query-view: =================== View Recent Queries @@ -32,7 +32,7 @@ You can also hover over a query and perform the following actions: - Action * - :icon-fa5:`star` - - Save the query as a :ref:`favorite `. Specify + - Save the query as a :ref:`favorite `. Specify a name for the query and click :guilabel:`Save`. * - :icon-fa5:`copy` @@ -64,4 +64,4 @@ include those fields. .. seealso:: To learn how to write queries to filter your data, see - :ref:`query-bar`. + :ref:`compass-query-bar`. diff --git a/source/query/skip.txt b/source/query/skip.txt index e3995b0fc..bad0ceabc 100644 --- a/source/query/skip.txt +++ b/source/query/skip.txt @@ -1,4 +1,4 @@ -.. _query-bar-skip: +.. _compass-query-bar-skip: ========================== Skip a Number of Documents diff --git a/source/query/sort.txt b/source/query/sort.txt index 3984475d3..c9ff91791 100644 --- a/source/query/sort.txt +++ b/source/query/sort.txt @@ -1,4 +1,4 @@ -.. _query-bar-sort: +.. _compass-query-bar-sort: =========================== Sort the Returned Documents diff --git a/source/release-notes.txt b/source/release-notes.txt index 262a2088c..9d9c54099 100644 --- a/source/release-notes.txt +++ b/source/release-notes.txt @@ -166,7 +166,7 @@ Bug Fixes: Bug Fixes: - Prevents application from hanging when selecting ranges too quickly on the - :ref:`Schema ` tab (:issue:`COMPASS-8048`). + :ref:`Schema ` tab (:issue:`COMPASS-8048`). - Updates Electron to `version 29.4.2 `__, which includes various security fixes. @@ -490,7 +490,7 @@ New Features: - For more details, see :ref:`` and :ref:``. - Improved AI feedback experience. For more information on - Generative AI natural language queries in Compass, see :ref:`query-natural-language`. + Generative AI natural language queries in Compass, see :ref:`compass-query-natural-language`. (:issue:`COMPASS-7211`, :issue:`COMPASS-7251`). - Removed ``useNewUrlParser`` and ``useUnifiedTopology`` from export to language options (:issue:`COMPASS-4897`). @@ -1521,7 +1521,7 @@ New Features: - Allows functions in the query bar and aggregations. -- When navigating to the :ref:`Databases ` view, +- When navigating to the :ref:`Databases ` view, |compass-short| now clears a previously selected collection from the left navigation. @@ -1554,7 +1554,7 @@ New Features: - Data is now refreshed when :guilabel:`Find` is clicked in the query bar. -- Improvements to :ref:`schema analysis ` to prevent +- Improvements to :ref:`schema analysis ` to prevent timeouts with large datasets. Bug Fixes: @@ -1699,7 +1699,7 @@ Bug Fixes: now insert multiple documents at once. - Added support for querying UUIDs via the - :ref:`Documents ` query bar or in the + :ref:`Documents ` query bar or in the :ref:`Aggregation Pipeline Builder `. - Added support for the following aggregation pipeline operators: @@ -1730,7 +1730,7 @@ Bug Fixes: - Added support for: - - :ref:`Views `. You can create + - :ref:`Views `. You can create views based on results from an :ref:`aggregation pipeline `. @@ -1739,7 +1739,7 @@ Bug Fixes: - Killing long-running operations from the :ref:`Performance Tab `. - - :ref:`Adjusting the maximum timeout ` for + - :ref:`Adjusting the maximum timeout ` for queries executed in the Query Bar. - New settings available in the @@ -1771,7 +1771,7 @@ Bug Fixes: - Added support for Ubuntu 18.10 and other recent Linux distributions. -- New :ref:`Schema Validation ` experience. +- New :ref:`Schema Validation ` experience. - Added support for :manual:`JSON schema validation `. @@ -1819,9 +1819,9 @@ Bug Fixes: - Added :manual:`collation ` support to the following features: - - :ref:`create-collection` - - :ref:`create-database` - - :ref:`create-index` + - :ref:`compass-create-collection` + - :ref:`compass-create-database` + - :ref:`compass-create-index` - :ref:`compass-query-bar` - :ref:`compass-agg-builder` @@ -1935,11 +1935,11 @@ Bug Fixes: - x509 Authentication - - :ref:`Schema Analysis ` + - :ref:`Schema Analysis ` - :ref:`Real Time Server Stats ` - - :ref:`Document Validation ` + - :ref:`Document Validation ` |compass| 1.9 ------------- @@ -1951,9 +1951,9 @@ Bug Fixes: - Query History Compass automatically stores up to 20 most recent queries for each collection. From the past queries view for a collection, you can - view the :ref:`recent ` queries as well as the - queries saved as :ref:`favorites ` . For more - information, see :ref:`past-query-view`. + view the :ref:`recent ` queries as well as the + queries saved as :ref:`favorites ` . For more + information, see :ref:`compass-past-query-view`. - Deployment Awareness When a user connects to a :ref:`MongoDB instance `, @@ -2014,15 +2014,15 @@ Bug Fixes: *Released Nov 29, 2016* -- Added ability to :ref:`create ` and :ref:`drop - ` databases. +- Added ability to :ref:`create ` and :ref:`drop + ` databases. -- Added ability to :ref:`create ` and :ref:`drop - ` collections. +- Added ability to :ref:`create ` and :ref:`drop + ` collections. -- Added ability to :ref:`create indexes `. +- Added ability to :ref:`create indexes `. -- Added support for :ref:`document validation `. +- Added support for :ref:`document validation `. - Improved security when connecting to Atlas. During Connection setup, |compass| supports the use of System Certificate Authority for diff --git a/source/sampling.txt b/source/sampling.txt index f05e6ee36..a609fb7fa 100644 --- a/source/sampling.txt +++ b/source/sampling.txt @@ -1,4 +1,4 @@ -.. _sampling: +.. _compass-sampling: ======== Sampling diff --git a/source/schema.txt b/source/schema.txt index d2f8a572c..dbd1ec3ca 100644 --- a/source/schema.txt +++ b/source/schema.txt @@ -1,4 +1,4 @@ -.. _schema-tab: +.. _compass-schema-tab: ======================== Analyze Your Data Schema @@ -16,7 +16,7 @@ The :guilabel:`Schema` tab provides an overview of the data type and shape of the fields in a particular collection. Databases and collections are visible in the left-side navigation. -The overview is based on :ref:`sampling ` +The overview is based on :ref:`sampling ` the documents in the collection. The schema overview may include additional data about the contents of the fields, such as the minimum and maximum values of dates and integers, the frequency of @@ -80,7 +80,7 @@ particular fields to display and the number of results to return. .. tip:: - In the :guilabel:`Schema` tab, you can also use the :ref:`build-query` to + In the :guilabel:`Schema` tab, you can also use the :ref:`compass-build-query` to enter a query into the query bar. Field Descriptions @@ -218,7 +218,7 @@ GeoJSON and ``[longitude,latitude]`` Arrays Fields that contain GeoJSON data or ``[longitude,latitude]`` arrays are displayed with interactive maps. For more information on interacting -with location data in |compass-short|, see :ref:`analyze-location-data`. +with location data in |compass-short|, see :ref:`compass-analyze-location-data`. .. figure:: /images/compass/geo-visualization.png :figwidth: 816px @@ -244,7 +244,7 @@ data: :figwidth: 576px :alt: Example that shows numeric data for number type -.. _build-query: +.. _compass-build-query: Query Builder ------------- @@ -266,7 +266,7 @@ building a complex query with the query bar. .. include:: /includes/steps/create-query-via-builder.rst -.. _analyze-location-data: +.. _compass-analyze-location-data: Analyze Location Data --------------------- @@ -344,9 +344,9 @@ To delete a location filter from the map: #. Click :guilabel:`Save`. -.. |query-build-ref| replace:: :ref:`build-query` +.. |query-build-ref| replace:: :ref:`compass-build-query` -.. |query-build-type| replace:: :ref:`build-query` +.. |query-build-type| replace:: :ref:`compass-build-query` Troubleshooting --------------- diff --git a/source/schema/export.txt b/source/schema/export.txt index ba9a1d438..1275a517f 100644 --- a/source/schema/export.txt +++ b/source/schema/export.txt @@ -22,7 +22,7 @@ If you have not already done so, analyze your schema: .. note:: When |compass-short| analyzes your schema, it samples a random subset of documents from your collection. To learn more about - sampling, see :ref:`Sampling `. + sampling, see :ref:`Sampling `. Once your schema has been analyzed, export your schema: @@ -41,7 +41,7 @@ Schema Object Properties Schema objects have ``count`` and ``fields`` properties: - ``count`` is an integer that represents the number of documents - :ref:`sampled ` from the collection to generate the schema. + :ref:`sampled ` from the collection to generate the schema. - ``fields`` is an array of metadata objects that correspond to each field in the documents analyzed during sampling. Each element in the diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index e89c419a0..303a99fbd 100644 --- a/source/settings/config-file.txt +++ b/source/settings/config-file.txt @@ -65,7 +65,7 @@ Settings * - autoUpdates - Allow |compass-short| to periodically check for new updates. - * - :ref:`enableGenAIFeatures ` + * - :ref:`enableGenAIFeatures ` - Allow |compass-short| to use generative AI for natural language querying. This feature requires an Atlas login and a deployed Atlas cluster. diff --git a/source/settings/restrict-outgoing-connections.txt b/source/settings/restrict-outgoing-connections.txt index fe6a2a973..003573273 100644 --- a/source/settings/restrict-outgoing-connections.txt +++ b/source/settings/restrict-outgoing-connections.txt @@ -21,7 +21,7 @@ outgoing connections in the same way :ref:`Compass Isolated Edition .. warning:: When you block outgoing network connections, |compass-short| can't use - third-party mapping services in :ref:`schema visualizations `. + third-party mapping services in :ref:`schema visualizations `. Procedure --------- diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index c25615336..3df79d886 100644 --- a/source/settings/settings-reference.txt +++ b/source/settings/settings-reference.txt @@ -181,14 +181,14 @@ You can configure the following settings on the |compass| interface: * - Enable AI Features - Artificial Intelligence - - Enables :ref:`natural language querying ` and allows + - Enables :ref:`natural language querying ` and allows the use of AI features in Compass which make requests to 3rd party services. * - Enable sending sample field values - Artificial Intelligence - Enables sharing of sample field values with the MongoDB AI provider. This setting can improve responses from - :ref:`natural language querying ` + :ref:`natural language querying ` prompts. Learn More diff --git a/source/validation.txt b/source/validation.txt index c13c2400d..2ee302ce6 100644 --- a/source/validation.txt +++ b/source/validation.txt @@ -1,4 +1,4 @@ -.. _validation: +.. _compass-validation: ==================================== Set Validation Rules for Your Schema @@ -27,7 +27,7 @@ specific shape or only allowing a specified range of values in fields. :figwidth: 720px :alt: Validation view -.. _update-validation: +.. _compass-update-validation: Validation Rules ---------------- diff --git a/source/views.txt b/source/views.txt index fd579a83a..e1e4be278 100644 --- a/source/views.txt +++ b/source/views.txt @@ -1,4 +1,4 @@ -.. _view-details: +.. _compass-view-details: .. _compass-views: ======================= @@ -21,7 +21,7 @@ Views can also help keep your data secure by only giving users access to a predefined result set, as opposed to having access to the underlying collection. -.. _collections-screen-views: +.. _compass-collections-screen-views: Collections Screen ------------------ @@ -56,7 +56,7 @@ To create a view from your pipeline results: 1. Create an aggregation pipeline in the pipeline builder. For detailed instructions on using the pipeline builder, see - :ref:`create-agg-pipeline`. + :ref:`compass-create-agg-pipeline`. #. Click the arrow next to the :guilabel:`Save` button at the top of the pipeline builder. @@ -76,7 +76,7 @@ Open a View To open a view, either: - Click the desired view from the - :ref:`Collections screen `, or + :ref:`Collections screen `, or - Click the desired view in the left-hand navigation. @@ -87,8 +87,8 @@ information and functionality for the view: - :ref:`Document management ` - :ref:`Aggregation Pipeline Builder ` - :ref:`Indexes ` -- :ref:`Data schema ` -- :ref:`Validation rules ` +- :ref:`Data schema ` +- :ref:`Validation rules ` Duplicate a View ---------------- @@ -132,7 +132,7 @@ To modify the source of a view: #. Modify the pipeline as desired. For detailed instructions on using the pipeline builder, see - :ref:`create-agg-pipeline`. + :ref:`compass-create-agg-pipeline`. #. Click :guilabel:`Update View` at the top of the pipeline builder.