Skip to content

Commit 3966545

Browse files
mmaville-mdbmmaville-mdb
authored
Merging Bulk Conversion Feature Branch (#171)
* DOCSP-43736-Bulk-Conversions-Task-Page (#168) * DOCSP-43736-Bulk-Conversions-Task-Page * Kicking off builds after changing Netlify settings (emprty commit) * Removing SQL learn more pointers, keeping it to relevant operations that apply to bulk actions. * Reordering links to match ToC. * Edits to address editorial feedback. * Internal formatting fix. * Expanding on selection step to line up with concurrent multiselection download work in separate PR. * Editorial and removing sentence that pertains mostly to inputting queries. * Adding new bulk conversion status include that modifies language to be more relevant and adds Pending status. * Adding ref to Filter topic. * Removing step for adding queries, as this is duplicated from individual query conversion. * Rewriting last steps to remove duplication and point to more relevant bulk conversion info. * Adding context to next step. * Editorial from internal feedback. * External feedback and some additional clarifications in the intro paragraph. * Editorial for Vale checks. Updating unrelated status file with similar editorial. * DOCSP-43748-Manage-Queries-Stub-Page-and-Tasks (#169) * DOCSP-43809: v1.10.0 Release Notes (#170) * DOCSP-43809-1-10-Release-notes * Editrial sweep for items in RN. * Editorial from Vale check. * General fixes and editorial from internal feedback. * Adding note for automatic deletion of migration indexes. * Minor editorial. * Updating release date. * Updating OpenSpec with generated output from application repo. * Revert "Updating OpenSpec with generated output from application repo." This reverts commit fc7cab3e0a2ceaf357ad1e65bf1599cd87e02eb7. * DOCSP-43748-Manage-Queries-Stub-Page-and-Tasks * Moving manage-queries.txt to correct directory. * Adding download task ref and content for single entry download. * Adding initial content for downloading multiple selections. * Adding description for Managing Queries page. * Modifying formatting for better visual feel. * Removing numbering from single-item steps. * Edits to address editorial feedback. * Modifying page title to match topic type. * Minor editorial from internal feedback round. * Speficying filters are by status and mentioning the name field conventions. * Moving management includes to separate tasks under Query Management page. * Renaming Manage Queries to Query Management. * Minor editorial. * Fixing new refs. * Simplifying Query Management page. * Adding Query Management to Snooty ToC Landing Pages. * Building out headings from conceptual template. * Editorial and building out task template headings. * Editorial and building out task template headings. * Update download-queries.txt * Update bulk-conversion.txt
1 parent c1e74ee commit 3966545

File tree

9 files changed

+303
-9
lines changed

9 files changed

+303
-9
lines changed

‎snooty.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ toc_landing_pages = [
3939
"jobs/prerequisites",
4040
"api-docs",
4141
"deployment-considerations",
42-
"code-generation/query-converter-test-queries"
42+
"code-generation/query-converter-test-queries",
43+
"code-generation/query-converter/query-management"
4344
]
4445

4546
[constants]

‎source/code-generation/query-converter.txt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,8 @@ your SQL code.
2525
Convert Stored Procedures </code-generation/query-converter/convert-stored-procedures>
2626
Convert Triggers </code-generation/query-converter/convert-triggers>
2727
Convert Views </code-generation/query-converter/convert-views>
28+
Bulk Conversion </code-generation/query-converter/bulk-conversion>
29+
Query Management </code-generation/query-converter/query-management>
2830
Refresh Database Objects </code-generation/query-converter/refresh-database-objects>
29-
Test Queries </code-generation/query-converter-test-queries>
31+
Test Queries </code-generation/query-converter-test-queries>
32+

‎source/code-generation/query-converter/bulk-conversion.txt‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
.. _rm-bulk-conversion:
2+
3+
===============
4+
Bulk Conversion
5+
===============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Bulk query conversion allows you to convert many
14+
queries from a single UI action, avoiding the need to convert
15+
each query individually. You can select and convert one
16+
or more queries, stored procedures, triggers, and views in bulk
17+
by enabling the multi-select toggle.
18+
19+
Bulk conversions create a job that queues and executes each query
20+
conversion in batches. You can view the status of an in-progress
21+
bulk conversion or for individual queries in the
22+
:guilabel:`Query Converter` pane.
23+
24+
About this Task
25+
---------------
26+
27+
.. include:: /includes/fact-query-converter-generic.rst
28+
29+
- .. include:: /includes/fact-query-converter-disclaimer.rst
30+
31+
- .. include:: /includes/fact-view-query-conversion-bulk-status.rst
32+
33+
Steps
34+
-----
35+
36+
.. procedure::
37+
:style: normal
38+
39+
.. step:: Navigate to the query converter pane
40+
41+
From the :guilabel:`Code Generation` tab, click the
42+
:guilabel:`Query Converter` pane.
43+
44+
.. step:: Enable multi-selection
45+
46+
Click the :guilabel:`Enable multi-selection` toggle to show the query
47+
selection pane.
48+
49+
.. step:: Select your conversions
50+
51+
- To include or exclude a query from your bulk conversion job,
52+
click the :icon-fa5:`check-square` icon next to the field name.
53+
54+
- To include or exclude entire categories from your download,
55+
click :icon-fa5:`check-square` next to the category name.
56+
57+
- To include or exclude queries by their current status, use
58+
the :ref:`Filter<rm-filter-queries>` to select a status.
59+
60+
.. step:: Convert queries
61+
62+
Click the :guilabel:`Convert` button. Selected queries are
63+
queued for conversion and execute in batches. Total progress
64+
of the conversion displays at the bottom-left of the page.
65+
66+
- Individual query conversion status are displayed next to
67+
the query name.
68+
69+
- The converted MongoDB syntax code can be viewed in the
70+
:guilabel:`Converted MongoDB Query` pane.
71+
72+
- .. include:: /includes/fact-query-converter-failure-errors.rst
73+
74+
.. tip::
75+
76+
To stop a bulk conversion, click the red :guilabel:`Terminate`
77+
button in the lower-left corner of the screen and click the
78+
red :guilabel:`Terminate` button on the pop-up modal. Once a
79+
bulk job cancels, the bulk conversion status updates to
80+
``Bulk convert job terminated``.
81+
82+
.. step:: (Optional) Provide feedback on the converted queries
83+
84+
Provide feedback on converted queries to help improve future query conversions.
85+
To provide feedback, click the :icon-fa5:`thumbs-up` or :icon-fa5:`thumbs-down`
86+
icon on the bottom right corner of the converted query panel. Then, you can
87+
provide feedback details and click :guilabel:`Submit`.
88+
89+
Next Steps
90+
----------
91+
92+
After the queries have been converted, review them for
93+
correctness before incorporating them into production code. You
94+
can use the :ref:`Test Queries<rm-query-converter-test-bench>`
95+
feature to help with validation.
96+
97+
Learn More
98+
----------
99+
100+
- :ref:`rm-convert-queries`
101+
- :ref:`rm-convert-stored-procedures`
102+
- :ref:`rm-convert-triggers`
103+
- :ref:`rm-convert-views`

‎source/code-generation/query-converter/query-management.txt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _rm-manage-queries:
2+
3+
================
4+
Query Management
5+
================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Relational Migrator provides various options for managing your
14+
queries in Query Converter.
15+
16+
Use Cases
17+
---------
18+
19+
- Filter queries by name or status.
20+
- Download converted queries individually or in bulk.
21+
22+
23+
Get Started
24+
-----------
25+
26+
- :ref:`rm-filter-queries`
27+
- :ref:`rm-download-queries`
28+
29+
.. toctree::
30+
:hidden:
31+
:titlesonly:
32+
33+
Filter </code-generation/query-converter/query-management/filter-queries>
34+
Download </code-generation/query-converter/query-management/download-queries>

‎source/code-generation/query-converter/query-management/download-queries.txt‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.. _rm-download-queries:
2+
3+
================
4+
Download Queries
5+
================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Download converted queries indivudually or in bulk to reduce effort
14+
and avoid copying each result by hand.
15+
16+
About this Task
17+
---------------
18+
19+
- Individual queries are saved in a ``txt`` file.
20+
- Multiple queries are saved in a ``zip`` archive.
21+
22+
Steps
23+
-----
24+
25+
Individual Query
26+
~~~~~~~~~~~~~~~~
27+
28+
.. procedure::
29+
:style: normal
30+
31+
.. step:: Select your query
32+
33+
a. From the :guilabel:`Code Generation` tab, click the
34+
:guilabel:`Query Converter` pane.
35+
36+
.. note::
37+
38+
If you are not already logged into your Atlas account or have
39+
an expired session, you must log in to proceed.
40+
41+
#. On the left-hand :guilabel:`Queries` pane, select a query, view,
42+
or stored procedure.
43+
44+
#. If your query has not been converted, select a
45+
:guilabel:`Target Language` and click :guilabel:`Convert`
46+
:icon-lg:`Sparkle`.
47+
48+
.. step:: Download the converted query
49+
50+
Click :icon-fa5:`download` to download the selected
51+
query conversion.
52+
53+
Multiple Queries
54+
~~~~~~~~~~~~~~~~
55+
56+
.. procedure::
57+
:style: normal
58+
59+
.. step:: Enable multi-selection
60+
61+
a. From the :guilabel:`Code Generation` tab, click the
62+
:guilabel:`Query Converter` pane.
63+
64+
.. note::
65+
66+
If you are not already logged into your Atlas account or have
67+
an expired session, you must log in to proceed.
68+
69+
#. On the left-hand :guilabel:`Queries` pane, click the
70+
:guilabel:`Enable multi-selection` toggle to show the query
71+
selection pane.
72+
73+
.. step:: Select your queries
74+
75+
- To include or exclude a query from your download,
76+
click :icon-fa5:`check-square` next to the field name.
77+
78+
- To include or exclude entire categories from your download,
79+
click :icon-fa5:`check-square` next to the category name.
80+
81+
82+
.. step:: Download selected query conversions
83+
84+
Click :icon-fa5:`download` to download the selected
85+
query conversions.
86+
87+
Learn More
88+
----------
89+
- Test Queries </code-generation/query-converter-test-queries>

‎source/code-generation/query-converter/query-management/filter-queries.txt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. _rm-filter-queries:
2+
3+
==============
4+
Filter Queries
5+
==============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Filter queries by text string or status to reduce amount of entries
14+
displayed in the :guilabel:`query converter` pane.
15+
16+
Steps
17+
-----
18+
19+
.. procedure::
20+
:style: normal
21+
22+
.. step:: Navigate to the query converter pane
23+
24+
From the :guilabel:`Code Generation` tab, click the
25+
:guilabel:`Query Converter` pane.
26+
27+
.. step:: Enter or select a filter
28+
29+
Enter a text string to match against the query name in the
30+
:guilabel:`Filter` text box or click :icon-fa5:`ellipsis-v`
31+
to filter queries by their conversion status.
32+
33+
Manually input queries default to the full query syntax for
34+
the name field unless renamed at a later point.
35+
36+
Next Steps
37+
----------
38+
- Convert Queries </code-generation/query-converter/convert-queries>
39+
- Convert Stored Procedures </code-generation/query-converter/convert-stored-procedures>
40+
- Convert Triggers </code-generation/query-converter/convert-triggers>
41+
- Convert Views </code-generation/query-converter/convert-views>
42+
- Bulk Conversion </code-generation/query-converter/bulk-conversion

‎source/includes/fact-query-converter-generic.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
- The query converter uses :abbr:`AI (Artificial Intelligence)`
2-
technology which may not be able to convert long or complex queries,
3-
triggers, or stored procedures. Some queries may not be converted
4-
correctly while others may not be converted at all.
1+
- The query converter uses AI technology which may not be able to
2+
convert long or complex queries, triggers, or stored procedures.
3+
Some queries may not be converted correctly while others may not
4+
be converted at all.
55

66
- The query converter uses the relational schema, the MongoDB schema,
77
and the mapping rules in your current project to determine how the
@@ -12,4 +12,4 @@
1212
- Converted queries, triggers, views, and stored procedures are saved in
1313
your project and persist through project import and exports.
1414

15-
- SQL queries are limited to 10,000 text characters.
15+
- SQL queries are limited to 40,000 text characters.

‎source/includes/fact-view-query-conversion-bulk-status.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
You can view the status of your conversions in the left-hand
2+
:guilabel:`Query Converter` pane. Each conversion has an icon
3+
indicating the status of the conversion. If an object does not have
4+
an icon next to it, it was not queued for bulk conversion:
5+
6+
.. list-table::
7+
:header-rows: 1
8+
9+
* - Icon
10+
- Description
11+
12+
* - Static circle
13+
- The conversion is pending.
14+
15+
* - Spinner
16+
- The conversion is now being executed.
17+
18+
* - Green check mark
19+
- The conversion was successful.
20+
21+
* - Red exclamation mark
22+
- The conversion failed on last attempt.

‎source/includes/fact-view-query-conversion-history.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ an icon next to it, a conversion has not been attempted yet:
1010
- Description
1111

1212
* - Spinner
13-
- The conversion is currently being executed.
13+
- The conversion is now being executed.
1414

1515
* - Green check mark
1616
- The conversion was successful.
1717

1818
* - Red exclamation mark
19-
- The conversion failed on last attempt.
19+
- The conversion failed on last attempt.

0 commit comments

Comments
 (0)