Skip to content

Commit dbf5516

Browse files
kanchana-mongodbkanchana-mongodb
authored
DOCSP-5746 doc update for data lake related limitations (#174)
* "DOCSP-5746 update for Data Lake limitations (#170)"
1 parent 9a2f027 commit dbf5516

File tree

9 files changed

+89
-27
lines changed

9 files changed

+89
-27
lines changed

‎source/collections.txt

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Collections and Views
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/extracts/readonly-not-permitted-collections.rst
16-
1715
.. _collections-screen:
1816

1917
Collections Screen
@@ -77,6 +75,14 @@ a unique icon:
7775

7876
For more information on views, see :ref:`view-details`.
7977

78+
Limitations
79+
-----------
80+
81+
- .. include:: /includes/extracts/readonly-not-permitted-collections.rst
82+
83+
- The :guilabel:`Create Collection` button is not available if you are
84+
connected to a :atlas:`Data Lake </data-lake>`.
85+
8086
.. _create-collection:
8187

8288
Create a Collection
@@ -117,12 +123,30 @@ collection's :doc:`Documents tab </documents>`. |compass-short| provides the fol
117123
collection information and functionality in the detailed view:
118124

119125
- :doc:`/documents`
126+
120127
- :doc:`Import and Export Data </import-export/>` to / from the collection
128+
129+
Importing data is not available if you are connected to
130+
a :atlas:`Data Lake </data-lake>`
131+
121132
- :ref:`compass-agg-builder`
122-
- :doc:`Schema Analysis </schema>` *Not Available in Compass Community Edition*
123-
- :doc:`/query-plan`
124-
- :doc:`/indexes`
125-
- :doc:`/validation` *Not Available in Compass Community Edition*
133+
134+
- :doc:`Schema Analysis </schema>`
135+
136+
Not Available in Compass Community Edition
137+
138+
- :doc:`/query-plan`
139+
140+
Not Available if you are connected to a :atlas:`Data Lake </data-lake>`
141+
142+
- :doc:`/indexes`
143+
144+
Not Available if you are connected to a :atlas:`Data Lake </data-lake>`
145+
146+
- :doc:`/validation`
147+
148+
Not Available in Compass Community Edition or if
149+
you are connected to a :atlas:`Data Lake </data-lake>`
126150

127151
.. _tabbed-view:
128152

‎source/databases.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Databases
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/extracts/readonly-not-permitted-databases.rst
16-
1715
Databases Tab
1816
-------------
1917

@@ -32,6 +30,14 @@ database collections by clicking the desired database in the left-hand navigatio
3230
You can also :ref:`create <create-database>` or
3331
:ref:`drop databases <drop-database>` from this view.
3432

33+
Limitations
34+
-----------
35+
36+
- .. include:: /includes/extracts/readonly-not-permitted-databases.rst
37+
38+
- Creating databases is not permitted if you are connected to a
39+
:atlas:`Data Lake </data-lake>`.
40+
3541
.. _create-database:
3642

3743
Create a Database

‎source/documents/insert.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ field name and value.
5252
"phone": "555-555-1212"
5353
}
5454

55+
Limitation
56+
----------
57+
58+
The :guilabel:`Insert Document` button is not available if you are connected
59+
to a :atlas:`Data Lake </data-lake>`.
60+
5561
Add New Fields
5662
--------------
5763

‎source/import-export.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Import and Export Data
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/extracts/readonly-not-permitted-import.rst
16-
1715
*New in version 1.13.0*
1816

1917
|compass| provides the ability to import and export data to and
@@ -30,6 +28,14 @@ Import Data into a Collection
3028
|compass| can import data into a collection from either a **JSON** or
3129
**CSV** file.
3230

31+
Limitations
32+
-----------
33+
34+
- .. include:: /includes/extracts/readonly-not-permitted-import.rst
35+
36+
- Importing data is not available if you are connected to a
37+
:atlas:`Data Lake </data-lake>`.
38+
3339
Format Your Data
3440
~~~~~~~~~~~~~~~~
3541

‎source/includes/extracts-readonly-not-permitted-base.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
ref: _readonly-not-permitted-base
22
content: |
3-
.. note::
43
5-
{{phrase}} is not permitted in
6-
:guilabel:`MongoDB Compass Readonly Edition`.
4+
{{phrase}} is not permitted in :guilabel:`MongoDB Compass Readonly Edition`.
75
...

‎source/indexes.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Indexes Tab
1212
:depth: 1
1313
:class: singlecol
1414

15-
.. include:: /includes/extracts/readonly-not-permitted-indexes.rst
16-
1715
.. _indexes-tab:
1816

1917
Indexes Tab
@@ -49,6 +47,14 @@ For each index, Compass displays the following information:
4947
- Any special properties (such as uniqueness, partial) of the
5048
index.
5149

50+
Limitations
51+
-----------
52+
53+
- .. include:: /includes/extracts/readonly-not-permitted-indexes.rst
54+
55+
- The :guilabel:`Indexes` tab is not available if you are connected
56+
to a :atlas:`Data Lake </data-lake>`.
57+
5258
.. _create-index:
5359

5460
Create an Index

‎source/performance.txt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Performance
1010
:depth: 1
1111
:class: singlecol
1212

13-
*Not Available in Compass Community Edition*
14-
1513
.. _performance-tab:
1614

1715
Performance Tab
@@ -86,6 +84,15 @@ The :guilabel:`Performance` tab displays various stats:
8684
operation or :ref:`kill the operation <kill-long-ops>`, click on
8785
the operation.
8886

87+
Limitations
88+
-----------
89+
90+
The :guilabel:`Performance` tab is not available:
91+
92+
- In Compass Community Edition.
93+
94+
- If you are connected to a :atlas:`Data Lake </data-lake>`.
95+
8996
.. _kill-long-ops:
9097

9198
Kill Slow Operations

‎source/query-plan.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ on the left hand pane, then click :guilabel:`Explain Plan`.
2121
.. figure:: /images/compass/query-plan.png
2222
:figwidth: 815px
2323

24+
Limitation
25+
----------
26+
27+
The :guilabel:`Explain Plan` tab is not available if you are connected
28+
to :atlas:`Data Lake </data-lake>`.
29+
2430
Query Bar
2531
---------
2632

@@ -44,7 +50,6 @@ outputs easier to understand and visualize.
4450
.. figure:: /images/compass/explain-tree.png
4551
:figwidth: 808px
4652

47-
4853
Raw JSON
4954
--------
5055

‎source/validation.txt

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,6 @@ Validation Tab
1717
Validation Tab
1818
--------------
1919

20-
.. note::
21-
22-
In :guilabel:`Compass Community Edition`, the validation tab is not
23-
available.
24-
25-
In :guilabel:`MongoDB Compass Readonly Edition`, you can
26-
only view validation rules. Creating and editing validation rules
27-
is not permitted.
28-
2920
The :guilabel:`Validation` tab allows you to manage
3021
:manual:`schema validation rules </core/document-validation>`
3122
for a collection.
@@ -37,6 +28,19 @@ specific shape or only allowing a specified range of values in fields.
3728
.. figure:: /images/compass/validation-view.png
3829
:figwidth: 720px
3930

31+
Limitations
32+
-----------
33+
34+
The :guilabel:`Validation` tab is not available:
35+
36+
- In :guilabel:`Compass Community Edition`.
37+
38+
- If you are connected to a :atlas:`Data Lake </data-lake>`.
39+
40+
In :guilabel:`MongoDB Compass Readonly Edition`, you can
41+
only view validation rules. Creating and editing validation rules
42+
is not permitted.
43+
4044
.. _update-validation:
4145
.. _create-validation-rules:
4246

0 commit comments

Comments
 (0)