Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/agg-pipeline-builder/export-pipeline-to-language.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
<query-bar-project>`, :ref:`sort <query-bar-sort>`, :ref:`maxtimems
<query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`,
:ref:`skip <query-bar-skip>` and :ref:`limit <query-bar-limit>` options.
<compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`, :ref:`maxtimems
<compass-query-bar-max-time-ms>`, :ref:`collation <compass-query-bar-collation>`,
:ref:`skip <compass-query-bar-skip>` and :ref:`limit <compass-query-bar-limit>` options.

.. step:: Click :icon-fa4:`files-o`

Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/maxtime-ms-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ Learn More

- :ref:`compass-interface-settings`

- :ref:`query-bar-max-time-ms`
- :ref:`compass-query-bar-max-time-ms`
4 changes: 2 additions & 2 deletions source/agg-pipeline-builder/open-saved-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ Steps
after you connect to your cluster.

To learn more, see
:ref:`viewing saved aggregations <saved-query-view>` for details.
:ref:`viewing saved aggregations <compass-saved-query-view>` for details.

Learn More
----------

- :ref:`compass-save-agg-pipeline`

- :ref:`saved-query-view`
- :ref:`compass-saved-query-view`
4 changes: 2 additions & 2 deletions source/agg-pipeline-builder/save-agg-pipeline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
<view-details>` from your pipeline results.
<compass-view-details>` from your pipeline results.

Steps
-----
Expand All @@ -29,4 +29,4 @@ Learn More

- :ref:`compass-create-a-view`

- :ref:`saved-queries-agg`
- :ref:`compass-saved-queries-agg`
4 changes: 2 additions & 2 deletions source/collections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ view:

- :ref:`compass-agg-builder`

- :ref:`Schema Analysis <schema-tab>`
- :ref:`Schema Analysis <compass-schema-tab>`

- :ref:`explain-plans`

- :ref:`compass-indexes`

- :ref:`validation`
- :ref:`compass-validation`

.. note:: Data Lake Limitations

Expand Down
2 changes: 1 addition & 1 deletion source/collections/clustered-collection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Next Steps

- :ref:`Query Your Data<compass-query-bar>`

- :ref:`Analyze Your Data Scheme <schema-tab>`
- :ref:`Analyze Your Data Scheme <compass-schema-tab>`
6 changes: 3 additions & 3 deletions source/connect/required-access.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ privileges:
- :authrole:`readWrite`

* - :guilabel:`Schema`
- :ref:`Query/View a Schema <schema-tab>`
- :ref:`Query/View a Schema <compass-schema-tab>`
- :authaction:`find`
- :authrole:`read`

Expand Down Expand Up @@ -87,12 +87,12 @@ privileges:
- :authrole:`read`

* - :guilabel:`Validation`
- :ref:`View rules <validation>`
- :ref:`View rules <compass-validation>`
- :authaction:`listCollections`
- :authrole:`read`

* - :guilabel:`Validation`
- :ref:`Update rules <update-validation>`
- :ref:`Update rules <compass-update-validation>`
- :authaction:`collMod`
- :authrole:`dbAdmin`

Expand Down
2 changes: 1 addition & 1 deletion source/documents.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <query-bar>`, you can specify a query to
From the :ref:`query bar <compass-query-bar>`, you can specify a query to
filter the displayed documents. Click :guilabel:`Options` to
specify query options.

Expand Down
4 changes: 2 additions & 2 deletions source/documents/modify-multiple.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <saved-favorite-query-view>` for
to your :ref:`favorite queries <compass-saved-favorite-query-view>` for
that collection and allows you to load and copy the query after
you close the modal.

Expand Down Expand Up @@ -169,4 +169,4 @@ Learn More
----------

- :ref:`compass-bulk-delete`
- :ref:`saved-favorite-query-view`
- :ref:`compass-saved-favorite-query-view`
4 changes: 2 additions & 2 deletions source/editions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ suit your needs.
- |checkmark|
- |checkmark|

* - :ref:`Schema Analysis <schema-tab>`
* - :ref:`Schema Analysis <compass-schema-tab>`
- |checkmark|
- |checkmark|
- |checkmark|
Expand All @@ -55,7 +55,7 @@ suit your needs.
- |checkmark|
- |checkmark|

* - Create, delete and edit :ref:`document validation <validation>`
* - Create, delete and edit :ref:`document validation <compass-validation>`
rules
- |checkmark|
-
Expand Down
8 changes: 4 additions & 4 deletions source/export-query-to-language.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <query-bar-project>`, :ref:`sort <query-bar-sort>`,
:ref:`maxtimems <query-bar-max-time-ms>`,
:ref:`collation <compass-query-bar-collation>`, :ref:`skip <query-bar-skip>`
and :ref:`limit <query-bar-limit>` options.
:ref:`project <compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`,
:ref:`maxtimems <compass-query-bar-max-time-ms>`,
:ref:`collation <compass-query-bar-collation>`, :ref:`skip <compass-query-bar-skip>`
and :ref:`limit <compass-query-bar-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.
Expand Down
2 changes: 1 addition & 1 deletion source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <sampling>` on the database takes longer, Compass will
:ref:`sampling <compass-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.

Expand Down
2 changes: 1 addition & 1 deletion source/import-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <query-bar-project>` field in the query bar to
- You can use the :ref:`Project <compass-query-bar-project>` field in the query bar to
specify the fields to return or export.

Procedure
Expand Down
2 changes: 1 addition & 1 deletion source/includes/extracts-query-bar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ content: |
subset of the results. Otherwise, Compass shows the entire result
set.

For details on sampling, see :ref:`Sampling <sampling>`.
For details on sampling, see :ref:`Sampling <compass-sampling>`.
---
ref: query-bar-type-schema
content: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
:ref:`compass-query-bar-max-time-ms`.
2 changes: 1 addition & 1 deletion source/includes/steps-export-filter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <sampling>`.
For details on sampling, see :ref:`Sampling <compass-sampling>`.

---
title: Select the appropriate file type.
Expand Down
2 changes: 1 addition & 1 deletion source/indexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <query-bar-sort>`.
:ref:`sort by a field <compass-query-bar-sort>`.

- Queries on an indexed field can use the index to limit the number of
documents that must be scanned to find matching documents.
Expand Down
2 changes: 1 addition & 1 deletion source/instance.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The Compass Home screen includes the following sections:

- :ref:`Connections Sidebar <connections-sidebar>`

- Your :ref:`saved queries and aggregation pipelines <view-favorite-queries>`.
- Your :ref:`saved queries and aggregation pipelines <compass-view-favorite-queries>`.

Once connected to a MongoDB instance, you can reach the Compass
Home screen by clicking a cluster name in the :guilabel:`Connections
Expand Down
6 changes: 3 additions & 3 deletions source/manage-data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 0 additions & 1 deletion source/query/filter.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.. _compass-query-bar-filter:
.. _query-bar:
.. _compass-query-bar:

===============
Expand Down
2 changes: 1 addition & 1 deletion source/query/limit.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _query-bar-limit:
.. _compass-query-bar-limit:

======================================
Limit the Number of Returned Documents
Expand Down
2 changes: 1 addition & 1 deletion source/query/maxtimems.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _query-bar-max-time-ms:
.. _compass-query-bar-max-time-ms:

========================================
Adjust Maximum Time for Query Operations
Expand Down
2 changes: 1 addition & 1 deletion source/query/project.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _query-bar-project:
.. _compass-query-bar-project:

=============================
Set Which Fields Are Returned
Expand Down
14 changes: 7 additions & 7 deletions source/query/queries.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _saved-queries-agg:
.. _compass-saved-queries-agg:

=======================================
Managing Saved Queries and Aggregations
Expand Down Expand Up @@ -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
<view-details>` from your pipeline results.
<compass-view-details>` from your pipeline results.

To save your pipeline:

.. include:: /includes/fact-save-pipeline.rst

.. _favorite-queries:
.. _compass-favorite-queries:

Saving a Favorite Query
-----------------------
Expand All @@ -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
---------------------
Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -85,7 +85,7 @@ Viewing Query History
---------------------

For details on how to view query history see
:ref:`viewing recent query history <recent-queries>`.
:ref:`viewing recent query history <compass-recent-queries>`.

.. toctree::
:titlesonly:
Expand Down
8 changes: 4 additions & 4 deletions source/query/recent.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. _recent-queries:
.. _past-query-view:
.. _compass-recent-queries:
.. _compass-past-query-view:

===================
View Recent Queries
Expand Down Expand Up @@ -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 <favorite-queries>`. Specify
- Save the query as a :ref:`favorite <compass-favorite-queries>`. Specify
a name for the query and click :guilabel:`Save`.

* - :icon-fa5:`copy`
Expand Down Expand Up @@ -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`.
2 changes: 1 addition & 1 deletion source/query/skip.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _query-bar-skip:
.. _compass-query-bar-skip:

==========================
Skip a Number of Documents
Expand Down
2 changes: 1 addition & 1 deletion source/query/sort.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _query-bar-sort:
.. _compass-query-bar-sort:

===========================
Sort the Returned Documents
Expand Down
Loading
Loading