Skip to content

Commit 6c39ba1

Browse files
View documents in JSON mode
1 parent b0b57fb commit 6c39ba1

File tree

7 files changed

+71
-42
lines changed

7 files changed

+71
-42
lines changed

source/documents.txt

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,18 @@ Documents Tab
66

77
.. default-domain:: mongodb
88

9-
.. contents:: On this page
10-
:local:
11-
:backlinks: none
12-
:depth: 1
13-
:class: singlecol
14-
15-
.. include:: /includes/extracts/readonly-not-permitted-documents.rst
16-
179
.. _documents-tab:
1810

19-
Documents Tab
20-
-------------
21-
2211
From the :guilabel:`Documents` tab, you can
2312
:ref:`view <compass-view-documents>`, :ref:`insert <insert-documents>`,
2413
:ref:`modify <compass-modify-documents>`,
2514
:ref:`clone <clone-documents>`, and
2615
:ref:`delete <compass-delete-documents>` documents in your selected
2716
collection or view.
2817

29-
Query Bar
30-
---------
18+
.. figure:: /images/compass/documents-view.png
19+
:figwidth: 680px
20+
:alt: Documents View
3121

3222
.. note::
3323

@@ -37,11 +27,6 @@ From the :doc:`query bar </query-bar>`, you can specify a query to
3727
filter the displayed documents. Click :guilabel:`Options` to
3828
specify query options.
3929

40-
.. figure:: /images/compass/query-bar-documents-view.png
41-
:figwidth: 696px
42-
43-
.. include:: /includes/extracts/query-bar-type-documents.rst
44-
4530
.. seealso::
4631

4732
- :doc:`query-bar`

source/documents/modify.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ Modify Documents
66

77
.. default-domain:: mongodb
88

9+
.. important::
10+
11+
Modifying documents is not permitted in
12+
:guilabel:`MongoDB Compass Readonly Edition`.
13+
914
You can edit existing documents in your collection. When you edit
1015
a document, |compass-short| performs a
1116
:manual:`findAndModify </reference/method/db.collection.findAndModify/>`
@@ -106,8 +111,15 @@ documents in List, JSON, or Table view:
106111
the JSON document.
107112

108113
By default, embedded objects and arrays are hidden. To expand
109-
these values, click the field arrow.
114+
embedded objects and array elements, hover over the target
115+
document and click the top arrow on the left side of the document.
116+
117+
To expand individual objects and arrays, click the arrow to
118+
the left of the desired field.
110119

120+
.. figure:: /images/compass/expand-doc-json-view.png
121+
:figwidth: 696px
122+
:alt: Expand embedded objects JSON
111123

112124
.. tab:: Table View
113125
:tabid: table-view

source/documents/view.txt

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,51 @@ View Documents
1515
:depth: 1
1616
:class: singlecol
1717

18-
Use the Documents tab to view the documents inside of a collection.
19-
Two different views are available to access documents: List View and
20-
Table View.
18+
The Documents tab provides three ways to access documents:
2119

22-
List View is the default document view. To switch to Table View, click
23-
the :guilabel:`Table` button to the right of the :guilabel:`List`
24-
button to access the document Table View.
20+
List View
21+
The default document view. Documents are shown as individual members
22+
of a list. In this view you can easily expand embedded objects
23+
and arrays.
2524

26-
.. figure:: /images/compass/table-btn.png
27-
:figwidth: 696px
25+
JSON View
26+
Documents are shown as properly-formatted JSON objects. In this view
27+
|compass-short| uses extended JSON to display the data types of
28+
fields where appropriate.
2829

29-
|
30+
Table View
31+
Shows documents as rows of a table, with document fields
32+
shown in the table columns. With this view, you can more easily
33+
see which documents contain specific field values.
34+
35+
Use the :guilabel:`View` buttons to select which view you would like
36+
to use:
3037

31-
Select the appropriate tab based on whether you are viewing your
32-
documents in List or Table view:
38+
.. figure:: /images/compass/documents-view-select.png
39+
:figwidth: 700px
40+
:alt: View Selection Highlight
41+
42+
|
3343

3444
.. tabs::
3545

3646
.. tab:: List View
3747
:tabid: list-view
3848

39-
List View shows documents as individual members in a list
40-
format.
49+
.. figure:: /images/compass/documents-view.png
50+
:figwidth: 700px
51+
:alt: Documents list view
4152

42-
.. figure:: /images/compass/doc-view.png
53+
.. tab:: JSON View
54+
:tabid: json
55+
56+
.. figure:: /images/compass/json-view.png
57+
:figwidth: 700px
58+
:alt: Documents JSON view
4359

4460
.. tab:: Table View
4561
:tabid: table-view
4662

47-
Table view shows documents as rows of a table. The document
48-
fields are shown in the table columns.
49-
5063
.. figure:: /images/compass/doc-table-view.png
5164
:figwidth: 696px
5265

@@ -63,20 +76,34 @@ Expand Embedded Objects and Arrays
6376
.. tab:: List View
6477
:tabid: list-view
6578

66-
To toggle the expansion of embedded objects and array elements in
67-
a document, hover over the target document and click the arrow in
79+
To toggle the expansion of embedded objects and array elements, hover over the target document and click the arrow in
6880
the top-left corner.
6981

7082
.. figure:: /images/compass/expand-doc-list-view.png
7183
:figwidth: 696px
84+
:alt: Expand embedded objects list
85+
86+
.. tab:: JSON View
87+
:tabid: json
88+
89+
To toggle the expansion of embedded objects and array elements,
90+
hover over the target document and click the top arrow on the
91+
left side of the document.
92+
93+
To expand individual objects and arrays, click the arrow to
94+
the left of the desired field.
95+
96+
.. figure:: /images/compass/expand-doc-json-view.png
97+
:figwidth: 696px
98+
:alt: Expand embedded objects JSON
7299

73100
.. tab:: Table View
74101
:tabid: table-view
75102

76-
To view nested object fields and array elements, hover your
77-
cursor over a field with a value type of ``Object`` or ``Array`` and click the
78-
button with outward-pointing arrows which appears on the right side of
79-
the field.
103+
To view nested object fields and array elements, hover your cursor
104+
over a field with a value type of ``Object`` or ``Array`` and
105+
click the button with outward-pointing arrows which appears on the
106+
right side of the field.
80107

81108
|compass-short| opens a new tab in the Table View corresponding
82109
to the nested element.
@@ -110,6 +137,11 @@ Encrypted Fields
110137
:figwidth: 696px
111138
:alt: Encrypted field in list view
112139

140+
.. tab:: JSON View
141+
:tabid: json
142+
143+
.. include:: /includes/fact-fle-description.rst
144+
113145
.. tab:: Table View
114146
:tabid: table-view
115147

89.1 KB
Loading
146 KB
Loading
36.1 KB
Loading
192 KB
Loading

0 commit comments

Comments
 (0)