diff --git a/source/agg-pipeline-builder/export-pipeline-to-language.txt b/source/agg-pipeline-builder/export-pipeline-to-language.txt index cda02da3c..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 ba8e5ea0c..cf59c4e91 100644 --- a/source/agg-pipeline-builder/maxtime-ms-pipeline.txt +++ b/source/agg-pipeline-builder/maxtime-ms-pipeline.txt @@ -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 54c02fdb2..ce4fd3932 100644 --- a/source/agg-pipeline-builder/open-saved-pipeline.txt +++ b/source/agg-pipeline-builder/open-saved-pipeline.txt @@ -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:`compass-save-agg-pipeline` -- :ref:`saved-query-view` +- :ref:`compass-saved-query-view` diff --git a/source/agg-pipeline-builder/save-agg-pipeline.txt b/source/agg-pipeline-builder/save-agg-pipeline.txt index c66bb72e0..04cacf115 100644 --- a/source/agg-pipeline-builder/save-agg-pipeline.txt +++ b/source/agg-pipeline-builder/save-agg-pipeline.txt @@ -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 ----- @@ -29,4 +29,4 @@ Learn More - :ref:`compass-create-a-view` -- :ref:`saved-queries-agg` +- :ref:`compass-saved-queries-agg` diff --git a/source/collections.txt b/source/collections.txt index 9870fd7de..7997f6890 100644 --- a/source/collections.txt +++ b/source/collections.txt @@ -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 diff --git a/source/collections/clustered-collection.txt b/source/collections/clustered-collection.txt index 37552bdd2..c9736703a 100644 --- a/source/collections/clustered-collection.txt +++ b/source/collections/clustered-collection.txt @@ -71,4 +71,4 @@ Next Steps - :ref:`Query Your Data` -- :ref:`Analyze Your Data Scheme ` +- :ref:`Analyze Your Data Scheme ` diff --git a/source/connect/required-access.txt b/source/connect/required-access.txt index 135ca68e0..23b30735b 100644 --- a/source/connect/required-access.txt +++ b/source/connect/required-access.txt @@ -53,7 +53,7 @@ privileges: - :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/documents.txt b/source/documents.txt index 3b908ec11..29b3b567e 100644 --- a/source/documents.txt +++ b/source/documents.txt @@ -25,7 +25,7 @@ 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. 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/editions.txt b/source/editions.txt index 3259cd240..ceec65b96 100644 --- a/source/editions.txt +++ b/source/editions.txt @@ -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 c515109d1..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 c54cf85fe..eed164e84 100644 --- a/source/import-export.txt +++ b/source/import-export.txt @@ -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 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-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/steps-export-filter.yaml b/source/includes/steps-export-filter.yaml index 1a8b98f62..7f2d4d4fd 100644 --- a/source/includes/steps-export-filter.yaml +++ b/source/includes/steps-export-filter.yaml @@ -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/indexes.txt b/source/indexes.txt index 8a0bc4289..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. 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 13dbe4306..f281111fa 100644 --- a/source/manage-data.txt +++ b/source/manage-data.txt @@ -27,18 +27,18 @@ Interact with Your Data :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/filter.txt b/source/query/filter.txt index 413ffb6f0..4fbbeb439 100644 --- a/source/query/filter.txt +++ b/source/query/filter.txt @@ -1,5 +1,4 @@ .. _compass-query-bar-filter: -.. _query-bar: .. _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 8c39d69a0..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. @@ -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: @@ -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 `. @@ -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 `, @@ -2022,7 +2022,7 @@ Bug Fixes: - 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/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/validation.txt b/source/validation.txt index 1206b230e..5a0821870 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 c34ae6147..f816dbec3 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 ------------------ @@ -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 ----------------