Skip to content

Commit 798ecff

Browse files
committed
*
1 parent 07f3faa commit 798ecff

File tree

1 file changed

+48
-39
lines changed

1 file changed

+48
-39
lines changed

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`

0 commit comments

Comments
 (0)