Skip to content

Commit a5d1105

Browse files
authored
DOCSP-45921-export-query-prep (#703)
* DOCSP-45921-export-query-prep * * * update images * * * AB feedback
1 parent 3788770 commit a5d1105

File tree

7 files changed

+70
-40
lines changed

7 files changed

+70
-40
lines changed

source/collections.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Tabbed View
143143
You can open multiple Collection Detail screens in separate tabs. To
144144
open a new tab to view collection details:
145145

146-
.. include:: /includes/steps/open-new-tab.rst
146+
.. include:: /includes/shared/steps/open-new-tab.rst
147147

148148
.. BEGIN-COMPASS-ONLY
149149

source/export-query-to-language.txt

Lines changed: 48 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -14,47 +14,56 @@ and use |compass| queries in your application.
1414
Procedure
1515
---------
1616

17-
1. After constructing a query in the
18-
:ref:`query bar <compass-query-bar>`, click :icon-mms:`ellipsis` to
19-
the right of the :guilabel:`Reset` button.
20-
21-
#. Click the :guilabel:`Export to Language` button ``</>``:
22-
23-
.. figure:: /images/querybar/export-query-to-language-menu-option.png
24-
:figwidth: 696px
25-
:alt: Query bar export dropdown menu
26-
27-
#. In the :guilabel:`Export Query To:` dropdown, select your desired
28-
language:
29-
30-
.. figure:: /images/querybar/export-query-to-language-select.png
31-
:figwidth: 600px
32-
:alt: Query bar language select
33-
34-
The :guilabel:`My Query` pane on the left displays your query in
35-
:binary:`~mongosh` syntax.
36-
37-
The pane to the right displays your query in the language selected.
38-
39-
#. *(Optional)*: Check the :guilabel:`Include Import Statements` option
40-
to include the required import statements for the language selected.
41-
42-
#. *(Optional)*: Check the :guilabel:`Include Driver Syntax` option
43-
to include application code for the language selected. If you
44-
include driver syntax, the copyable code reflects
45-
:ref:`project <compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`,
46-
:ref:`maxtimems <compass-query-bar-max-time-ms>`,
47-
:ref:`collation <compass-query-bar-collation>`, :ref:`skip <compass-query-bar-skip>`
48-
and :ref:`limit <compass-query-bar-limit>` options.
49-
50-
#. Click :icon-fa5:`copy` at the top-right of the formatted
51-
query to copy the query for the selected language to your clipboard.
52-
You can now easily integrate and execute your created query in
53-
your application.
17+
.. procedure::
18+
:style: normal
19+
20+
.. step:: Click the Export to Language button
21+
22+
In the query bar, click the ``</>`` icon to open the query export card.
23+
24+
.. figure:: /images/querybar/export-query-to-language-menu-option.png
25+
:figwidth: 696px
26+
:alt: Query bar export dropdown menu
27+
28+
.. step:: Select your export language
29+
30+
On the right side of the card, click the drop-down menu under
31+
:guilabel:`Exported Query` and select your desired programming language.
32+
33+
The :guilabel:`My Query` pane on the left of the export card displays your
34+
pipeline in :binary:`~mongosh` syntax. The :guilabel:`Exported Query` pane
35+
to the right displays your pipeline in the selected programming language.
36+
37+
.. figure:: /images/querybar/export-query-to-language-select.png
38+
:figwidth: 600px
39+
:alt: Query bar language select
40+
41+
.. step:: *(Optional)* Include import statements
42+
43+
Click the :guilabel:`Include Import Statements` checkbox to include the
44+
required import statements for the selected programming language.
45+
46+
.. step:: *(Optional)* Include driver syntax
47+
48+
Click the :guilabel:`Include Driver Syntax` checkbox to include
49+
application code for the selected programming language. If you include
50+
driver syntax, the copyable code reflects :ref:`project
51+
<compass-query-bar-project>`, :ref:`sort <compass-query-bar-sort>`,
52+
:ref:`maxtimems <compass-query-bar-max-time-ms>`, :ref:`collation
53+
<compass-query-bar-collation>`, :ref:`skip <compass-query-bar-skip>`, and
54+
:ref:`limit <compass-query-bar-limit>` options.
55+
56+
.. step:: Click :icon-fa5:`copy`
57+
58+
Click the :icon-fa5:`copy` icon at the top-right corner of the formatted
59+
query to copy the query for the selected language to your clipboard. You
60+
can now integrate and execute your created query in your application.
5461

5562
.. figure:: /images/querybar/export-query-python-driver-syntax-copied.png
5663
:figwidth: 600px
5764
:alt: Copy button clicked in Export Query to Language modal
5865

59-
#. Click :guilabel:`Close` to return to the
60-
:ref:`Documents Tab <compass-documents>`.
66+
Learn More
67+
----------
68+
69+
- :ref:`compass-export-agg-builder-results`
Loading
Loading
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
title: Click the caret icon next to the database that contains the
2+
collection you want to view.
3+
level: 4
4+
ref: click-caret
5+
---
6+
title: "Hover over the desired collection."
7+
level: 4
8+
ref: hover-collection
9+
---
10+
title: Click the appearing ellipses (...) button.
11+
level: 4
12+
ref: click-ellipses
13+
---
14+
title: Click :guilabel:`Open in New Tab`.
15+
level: 4
16+
ref: open-new-tab
17+
...

source/query-plan.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,12 @@ information on the execution of your query such as:
4141

4242
- The number of examined index keys
4343

44+
.. BEGIN-COMPASS-ONLY
4445
.. note::
4546

4647
The :guilabel:`Explain Plan` is not available if you are connected
4748
to :atlas:`Data Lake </data-lake>`.
49+
.. END-COMPASS-ONLY
4850

4951
Steps
5052
-----

source/schema.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,9 @@ with location data in |compass-short|, see :ref:`compass-analyze-location-data`.
224224
:figwidth: 816px
225225
:alt: Example of GeoJSON data types
226226

227+
.. BEGIN-COMPASS-ONLY
227228
.. include:: /includes/fact-isolated-ver-third-party-mapping.rst
229+
.. END-COMPASS-ONLY
228230

229231
View Charts of Mixed Types
230232
~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)