Skip to content

Commit 08e02ed

Browse files
committed
DOCSP-45459 Mark Compass-Exclusive Content
1 parent ceeada2 commit 08e02ed

14 files changed

+70
-4
lines changed

source/agg-pipeline-builder/export-pipeline-results.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ Steps
5959
Learn More
6060
----------
6161

62+
.. BEGIN-COMPASS-ONLY
63+
6264
- :ref:`export-data-collection`
6365

66+
.. END-COMPASS-ONLY
67+
6468
- :ref:`compass-export-pipeline`

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

Lines changed: 4 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

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: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,17 @@ 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

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 & 0 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

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

83+
.. BEGIN-COMPASS-ONLY
7984
.. note::
8085

8186
You can also use the :manual:`db.collection.deleteMany()
8287
</reference/method/db.collection.deleteMany/>` method in the
8388
:ref:`embedded MongoDB Shell <embedded-mongodb-shell>` to delete
8489
multiple documents in a single operation.
90+
.. END-COMPASS-ONLY

source/documents/modify-multiple.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ About this Task
3232
only visible if your database is configured to support transactions.
3333
For details, see :ref:`transactions`.
3434

35+
.. BEGIN-COMPASS-ONLY
36+
3537
Before you Begin
3638
----------------
3739

3840
The :guilabel:`Update Documents` modal is available starting
3941
in Compass version ``1.42.0``. For instructions on updating or installing
4042
the latest Compass version, see :ref:`download-install`.
4143

44+
.. END-COMPASS-ONLY
45+
4246
Steps
4347
-----
4448

@@ -95,6 +99,8 @@ Steps
9599
The documents under the :guilabel:`Preview` header show how the
96100
:guilabel:`Update` syntax affects documents in your collection.
97101

102+
.. BEGIN-COMPASS-ONLY
103+
98104
.. step:: (Optional) Name and save your :guilabel:`Update`
99105

100106
You can name and save the update query in the
@@ -108,6 +114,8 @@ Steps
108114
#. Enter a name for the update syntax.
109115
#. Click the green :guilabel:`Save` button.
110116

117+
.. END-COMPASS-ONLY
118+
111119
.. step:: Update your documents
112120

113121
Click :guilabel:`Update Documents`.
@@ -169,4 +177,9 @@ Learn More
169177
----------
170178

171179
- :ref:`compass-bulk-delete`
180+
181+
.. BEGIN-COMPASS-ONLY
182+
172183
- :ref:`compass-saved-favorite-query-view`
184+
185+
.. END-COMPASS-ONLY

source/documents/modify.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,11 @@ Modify Multiple Documents
213213
You can use the bulk update operations workflow to update multiple
214214
documents in Compass. For details, see :ref:`compass-bulk-update`.
215215

216+
.. BEGIN-COMPASS-ONLY
216217
.. note::
217218

218219
You can also use the :manual:`db.collection.updateMany()
219220
</reference/method/db.collection.updateMany/>` method in the
220221
:ref:`embedded MongoDB Shell <embedded-mongodb-shell>` to update
221222
multiple documents in a single operation.
223+
.. END-COMPASS-ONLY

source/includes/steps-create-collection.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ content: |
2020
- :ref:`Create a Clustered Collection <compass-clustered-collection>`
2121
2222
- :ref:`Create a Collection with Collation <compass-collation-collection>`
23+
24+
.. BEGIN-COMPASS-ONLY
2325
2426
- :ref:`Create a Collection with Encrypted Fields <compass-encrypted-collection>`
2527
28+
.. END-COMPASS-ONLY
29+
2630
- :ref:`Create a Time Series Collection <compass-time-series-collection>`
2731
---
2832
title: Click :guilabel:`Create Collection` to create the collection.

source/indexes.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ Create an Index
8181

8282
.. include:: /includes/steps/create-index.rst
8383

84+
.. BEGIN-COMPASS-ONLY
85+
8486
Create an Atlas Search Index
8587
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8688

@@ -95,6 +97,8 @@ Atlas Vector Search indexes enable you to index vector data *and* other data
9597
types, which facilitates semantic searches on the indexed fields. For more
9698
information, see :ref:`compass-create-vector-search`.
9799

100+
.. END-COMPASS-ONLY
101+
98102
.. _compass-wildcard-index:
99103

100104
Create a Wildcard Index
@@ -185,8 +189,12 @@ Limitations
185189
:ref:`Atlas CLI <atlas-cli>`, or the
186190
:ref:`Atlas Administration API <atlas-admin-api>`.
187191

192+
.. BEGIN-COMPASS-ONLY
193+
188194
.. toctree::
189195
:titlesonly:
190196

191197
Atlas Search Index </indexes/create-search-index>
192198
Atlas Vector Search Index </indexes/create-vector-search-index>
199+
200+
.. END-COMPASS-ONLY

0 commit comments

Comments
 (0)