Skip to content

Commit 451b9d1

Browse files
authored
DOCSP-45459 Mark Compass-Exclusive Content (#696)
* DOCSP-45459 Mark Compass-Exclusive Content * fix yaml syntax * * * * * databases - documents * query directory * aggregation * * * * * *
1 parent ceeada2 commit 451b9d1

29 files changed

+154
-65
lines changed

source/agg-pipeline-builder/maxtime-ms-pipeline.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,16 @@ frequently time out. Alternatively, consider lowering the
2525
:guilabel:`Max Time MS` value to quickly identify inefficient or
2626
resource-intensive pipeline operations.
2727

28+
.. BEGIN-COMPASS-ONLY
29+
2830
If you already specified a ``maxTimeMS`` value in the :ref:`Compass Settings
2931
panel <compass-interface-settings>`, the :ref:`command line <cli-options>`, or
3032
a :ref:`configuration file <config-file-options>`, the :guilabel:`Max Time MS`
3133
that you specify for your pipeline must be lower than the limit you previously
3234
specified.
3335

36+
.. END-COMPASS-ONLY
37+
3438
If your aggregation operation goes over the time limit, |compass-short| raises
3539
a timeout error.
3640

@@ -57,11 +61,14 @@ Steps
5761

5862
Learn More
5963
----------
64+
.. BEGIN-COMPASS-ONLY
6065

6166
- :ref:`cli-options`
6267

6368
- :ref:`config-file-options`
6469

6570
- :ref:`compass-interface-settings`
6671

72+
.. END-COMPASS-ONLY
73+
6774
- :ref:`compass-query-bar-max-time-ms`

source/agg-pipeline-builder/view-pipeline-explain-plan.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ Learn More
7272

7373
- :manual:`Analyze Query Performance </tutorial/analyze-query-plan/>`
7474

75-
- :ref:`explain-plans`
75+
- :ref:`compass-explain-plans`

source/collections.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,18 +100,24 @@ view:
100100

101101
- :ref:`compass-documents`
102102

103+
.. BEGIN-COMPASS-ONLY
104+
103105
- :ref:`compass-import-export` to and from the collection
104106

107+
.. END-COMPASS-ONLY
108+
105109
- :ref:`compass-agg-builder`
106110

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

109-
- :ref:`explain-plans`
113+
- :ref:`compass-explain-plans`
110114

111115
- :ref:`compass-indexes`
112116

113117
- :ref:`compass-validation`
114118

119+
.. BEGIN-COMPASS-ONLY
120+
115121
.. note:: Data Lake Limitations
116122

117123
The following functionality is not available if you are connected to
@@ -127,6 +133,8 @@ view:
127133

128134
- Set Validation Rules for Your Schema
129135

136+
.. END-COMPASS-ONLY
137+
130138
.. _compass-tabbed-view:
131139

132140
Tabbed View
@@ -137,6 +145,8 @@ open a new tab to view collection details:
137145

138146
.. include:: /includes/steps/open-new-tab.rst
139147

148+
.. BEGIN-COMPASS-ONLY
149+
140150
Limitations
141151
-----------
142152

@@ -145,6 +155,8 @@ Limitations
145155
- The :guilabel:`Create Collection` button is not available if you are
146156
connected to a :atlas:`Data Lake </data-lake>`.
147157

158+
.. END-COMPASS-ONLY
159+
148160
.. |home| unicode:: U+2302
149161

150162
.. toctree::

source/connect/required-access.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ privileges:
8282
- :authrole:`readWrite`
8383

8484
* - :guilabel:`Explain Plan`
85-
- :ref:`Query/View a query plan <explain-plans>`
85+
- :ref:`Query/View a query plan <compass-explain-plans>`
8686
- :authaction:`find`
8787
- :authrole:`read`
8888

source/create-agg-pipeline.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,12 @@ collection.
4848

4949
.. note:: Atlas Search Stages
5050

51-
When you connect |compass-short| to a MongoDB deployment hosted on
51+
When you connect to a MongoDB deployment hosted on
5252
`Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_compass>`_,
53-
additional Atlas-only stages
54-
:atlas:`$search </reference/atlas-search/query-syntax/#-search>` and
55-
:atlas:`$searchMeta </reference/atlas-search/query-syntax/#-searchmeta>`
56-
are available in the Aggregation Pipeline Builder. Use these stages
57-
to perform
58-
:atlas:`full-text search</atlas-search/atlas-search-overview>`
53+
Atlas-only stages :atlas:`$search </reference/atlas-search/query-syntax/#-search>`
54+
and :atlas:`$searchMeta </reference/atlas-search/query-syntax/#-searchmeta>`
55+
become available in the Aggregation Pipeline Builder. Use these stages
56+
to perform :atlas:`full-text search</atlas-search/atlas-search-overview>`
5957
on Atlas collections.
6058

6159
Steps

source/databases.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,14 @@ Drop a Database
5151

5252
.. include:: /includes/steps/delete-database.rst
5353

54+
.. BEGIN-COMPASS-ONLY
55+
5456
Limitations
5557
-----------
5658

5759
- .. include:: /includes/extracts/readonly-not-permitted-databases.rst
5860

5961
- Creating databases is not permitted if you are connected to a
6062
:atlas:`Data Lake </data-lake>`.
63+
64+
.. END-COMPASS-ONLY

source/documents.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,15 @@ From the :guilabel:`Documents` tab, you can
2121
:ref:`delete multiple <compass-bulk-delete>`
2222
documents in your selected collection or view.
2323

24+
.. BEGIN-COMPASS-ONLY
25+
2426
.. note::
2527

2628
For query result sets larger than 20 documents, Compass shows
2729
paginated results. By default, pages display 20 documents at a time.
2830

31+
.. END-COMPASS-ONLY
32+
2933
From the :ref:`query bar <compass-query-bar>`, you can specify a query to
3034
filter the displayed documents. Click :guilabel:`Options` to
3135
specify query options.

source/documents/clone.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ Clone Documents
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. BEGIN-COMPASS-ONLY
16+
1517
.. important::
1618

1719
Cloning documents is not permitted in
1820
:guilabel:`MongoDB Compass Readonly Edition`.
1921

22+
.. END-COMPASS-ONLY
23+
2024
You can insert new documents by cloning the schema and values of
2125
an existing document in a collection.
2226

@@ -38,10 +42,6 @@ documents in List, JSON, or Table view:
3842
.. tab:: JSON View
3943
:tabid: json
4044

41-
.. note::
42-
43-
JSON View is available starting in Compass 1.20.
44-
4545
To clone a document, hover over the desired document
4646
and click the :guilabel:`Clone` button.
4747

source/documents/delete-multiple.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,17 @@ Validate documents in the :guilabel:`Preview` of the
2626
:guilabel:`Delete Documents` modal before confirming the
2727
delete operation.
2828

29+
.. BEGIN-COMPASS-ONLY
30+
2931
Before you Begin
3032
----------------
3133

3234
The :guilabel:`Delete Documents` modal is available starting
3335
in Compass version ``1.42.0``. For instructions on updating or installing
3436
the latest Compass version, see :ref:`download-install`.
3537

38+
.. END-COMPASS-ONLY
39+
3640
Steps
3741
-----
3842

source/documents/delete.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ Delete Single Document
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. BEGIN-COMPASS-ONLY
16+
1517
.. important::
1618

1719
Deleting documents is not permitted in
1820
:guilabel:`MongoDB Compass Readonly Edition`.
1921

22+
.. END-COMPASS-ONLY
23+
2024
Select the appropriate tab based on whether you are viewing your
2125
documents in List, JSON, or Table view:
2226

@@ -39,10 +43,6 @@ documents in List, JSON, or Table view:
3943
.. tab:: JSON View
4044
:tabid: json
4145

42-
.. note::
43-
44-
JSON View is available starting in Compass 1.20.
45-
4646
To delete a document, hover over the document and click the
4747
:icon-fa5:`trash-alt` icon.
4848

@@ -76,9 +76,11 @@ Delete Multiple Documents
7676
You can use the bulk delete operations workflow to delete multiple
7777
documents in Compass. For details, see :ref:`compass-bulk-delete`.
7878

79+
.. BEGIN-COMPASS-ONLY
7980
.. note::
8081

8182
You can also use the :manual:`db.collection.deleteMany()
8283
</reference/method/db.collection.deleteMany/>` method in the
8384
:ref:`embedded MongoDB Shell <embedded-mongodb-shell>` to delete
8485
multiple documents in a single operation.
86+
.. END-COMPASS-ONLY

0 commit comments

Comments
 (0)