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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _pipeline-builder-settings:
.. _compass-pipeline-builder-settings:

=====================================
Aggregation Pipeline Builder Settings
Expand Down Expand Up @@ -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`
4 changes: 2 additions & 2 deletions source/agg-pipeline-builder/count-pipeline-results.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _count-pipeline-results:
.. _compass-count-pipeline-results:

================================
Count Pipeline Results Documents
Expand Down Expand Up @@ -26,7 +26,7 @@ Before You Begin
----------------

To count result documents, you must first :ref:`create and run
<create-agg-pipeline>` your aggregation pipeline. You can't count result
<compass-create-agg-pipeline>` your aggregation pipeline. You can't count result
documents while editing your pipeline.

Steps
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/create-a-view.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _create-a-view:
.. _compass-create-a-view:

===================================
Create a View from Pipeline Results
Expand Down
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/export-pipeline-results.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _export-agg-builder-results:
.. _compass-export-agg-builder-results:

===================================
Export Aggregation Pipeline Results
Expand Down
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 <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
4 changes: 2 additions & 2 deletions source/agg-pipeline-builder/maxtime-ms-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _set-maxtime-ms-agg:
.. _compass-set-maxtime-ms-agg:

=======================================
Set Max Time MS for Aggregation Queries
Expand Down 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`
12 changes: 6 additions & 6 deletions source/agg-pipeline-builder/open-saved-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _open-saved-pipeline:
.. _compass-open-saved-pipeline:

=====================
Open a Saved Pipeline
Expand All @@ -20,9 +20,9 @@ Before You Begin

If you don't already have a saved pipeline, you must first:

- :ref:`Create an aggregation pipeline <create-agg-pipeline>`.
- :ref:`Create an aggregation pipeline <compass-create-agg-pipeline>`.

- :ref:`Save your aggregation pipeline <save-agg-pipeline>`.
- :ref:`Save your aggregation pipeline <compass-save-agg-pipeline>`.

Steps
-----
Expand Down 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:`save-agg-pipeline`
- :ref:`compass-save-agg-pipeline`

- :ref:`saved-query-view`
- :ref:`compass-saved-query-view`
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/pipeline-custom-collation.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _pipeline-custom-collation:
.. _compass-pipeline-custom-collation:

==========================================
Specify Custom Collation For Your Pipeline
Expand Down
10 changes: 5 additions & 5 deletions source/agg-pipeline-builder/save-agg-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _save-agg-pipeline:
.. _compass-save-agg-pipeline:

===============
Save a Pipeline
Expand All @@ -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 @@ -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`
2 changes: 1 addition & 1 deletion source/agg-pipeline-builder/view-pipeline-explain-plan.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _view-pipeline-explain-plans:
.. _compass-view-pipeline-explain-plans:

=================================
View Explain Plans for a Pipeline
Expand Down
16 changes: 8 additions & 8 deletions source/collections.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _collection-tab:
.. _compass-collection-tab:

=============================
Manage Collections in Compass
Expand All @@ -23,7 +23,7 @@ A collection is a grouping of MongoDB
:ref:`documents <compass-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 <database-tab>`
single :ref:`database <compass-database-tab>`.

Collections Screen
------------------
Expand Down Expand Up @@ -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
-------------------
Expand All @@ -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
-----------------
Expand All @@ -89,7 +89,7 @@ collection details, either:

- Click a collection in the left navigation.

- Open the collection in a :ref:`new tab <tabbed-view>`.
- Open the collection in a :ref:`new tab <compass-tabbed-view>`.

After you select a collection, |compass-short| shows you that
collection's :ref:`Documents tab <compass-documents>`. |compass-short| provides
Expand All @@ -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 All @@ -125,7 +125,7 @@ view:

- Set Validation Rules for Your Schema

.. _tabbed-view:
.. _compass-tabbed-view:

Tabbed View
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion source/collections/capped-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _capped-collection:
.. _compass-capped-collection:

==========================
Create a Capped Collection
Expand Down
4 changes: 2 additions & 2 deletions source/collections/clustered-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _clustered-collection:
.. _compass-clustered-collection:

=============================
Create a Clustered Collection
Expand Down 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>`
2 changes: 1 addition & 1 deletion source/collections/collation-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _collation-collection:
.. _compass-collation-collection:

==================================
Create a Collection with Collation
Expand Down
2 changes: 1 addition & 1 deletion source/collections/encrypted-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _encrypted-collection:
.. _compass-encrypted-collection:

=============================================
Create a Collection with Queryable Encryption
Expand Down
2 changes: 1 addition & 1 deletion source/collections/time-series-collection.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _time-series-collection:
.. _compass-time-series-collection:

===============================
Create a Time Series Collection
Expand Down
2 changes: 1 addition & 1 deletion source/connect/connections.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <database-tab>`.
see :ref:`Databases <compass-database-tab>`.

Connection Options
------------------
Expand Down
14 changes: 7 additions & 7 deletions source/connect/required-access.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
4 changes: 2 additions & 2 deletions source/create-agg-pipeline.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. _compass-agg-builder:
.. _create-agg-pipeline:
.. _compass-create-agg-pipeline:

==============================
Create an Aggregation Pipeline
Expand Down Expand Up @@ -369,7 +369,7 @@ Learn More

- :manual:`Aggregation Pipeline Stages </reference/operator/aggregation-pipeline/>`

- :ref:`pipeline-builder-settings`
- :ref:`compass-pipeline-builder-settings`

- :ref:`compass-export-pipeline`

Expand Down
16 changes: 8 additions & 8 deletions source/databases.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _database-tab:
.. _compass-database-tab:

===========================
Manage Databases in Compass
Expand All @@ -12,7 +12,7 @@ Manage Databases in Compass
:depth: 1
:class: singlecol

A database is a container for :ref:`collections <collection-tab>`.
A database is a container for :ref:`collections <compass-collection-tab>`.
Each database gets its own set of files on the host file system.
A single MongoDB server typically has multiple databases.

Expand All @@ -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 <collection-tab>`. 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 <create-database>` or
:ref:`drop databases <drop-database>` from this view.
You can also :ref:`create <compass-create-database>` or
:ref:`drop databases <compass-drop-database>` 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
---------------
Expand Down
Loading
Loading