Skip to content

Commit 0aa5c45

Browse files
jwilliams-mongojeff-allen-mongo
authored andcommitted
(DOCSP-10667): As an author, I see helpful errors when my query is in… (#361)
* (DOCSP-10667): As an author, I see helpful errors when my query is invalid * (DOCSP-10667):copy review feedback
1 parent 21e68e0 commit 0aa5c45

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

source/aggregation-pipeline.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,26 @@ Once the data has been processed using the pipeline, the
6363
chart displays the :guilabel:`Sum` of all
6464
``saleAmounts`` categorized by store location.
6565

66+
Address Aggregation Pipeline Errors
67+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
69+
If your aggregation is invalid, |charts-short| displays the
70+
:icon-fa4:`exclamation-triangle` icon in the :guilabel:`Query` bar.
71+
72+
Click the :guilabel:`Query` bar if it is not already displayed to view
73+
error details. |charts-short| displays error details for:
74+
75+
- Client-side errors, such as malformed JSON, and
76+
- Server-side errors, such as invalid :abbr:`MQL (MongoDB Query
77+
Language)` or unsupported pipeline stages.
78+
79+
.. figure:: /images/charts/agg-pipeline-error.png
80+
:figwidth: 720px
81+
:alt: Example Aggregation Pipeline Error
82+
83+
Review the error details, then adjust your aggregation pipeline
84+
accordingly.
85+
6686
Limitations
6787
~~~~~~~~~~~
6888

source/filter-chart-results.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,24 @@ To filter data using the :guilabel:`Query` bar:
464464
a ``saleDate`` equal to or more recent than ``January 1, 2017`` with at
465465
least 5 elements in the ``items`` array.
466466

467+
Address Query Errors
468+
~~~~~~~~~~~~~~~~~~~~~
469+
470+
If your query is invalid, |charts-short| displays the
471+
:icon-fa4:`exclamation-triangle` icon in the :guilabel:`Query` bar.
472+
473+
Click the :guilabel:`Query` bar if it is not already displayed to view
474+
error details. |charts-short| displays error details for:
475+
476+
- Client-side errors, such as malformed JSON, and
477+
- Server-side errors, such as invalid :abbr:`MQL (MongoDB Query
478+
Language)`.
479+
480+
.. figure:: /images/charts/filter-error.png
481+
:figwidth: 720px
482+
:alt: Example Filter Error
483+
484+
Review the error details, then adjust your query accordingly.
467485

468486
Considerations
469487
~~~~~~~~~~~~~~
96.4 KB
Loading

source/images/charts/filter-error.png

84.2 KB
Loading

0 commit comments

Comments
 (0)