Adding Nested Function Documentation #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… for SQL. Signed-off-by: forestmvey <[email protected]>
Yury-Fridlyand
requested review from
GumpacG,
Yury-Fridlyand,
MaxKsyunz,
acarbonetto and
matthewryanwells
Yury-Fridlyand
requested changes
May 18, 2023
There was a problem hiding this comment.
This is documentation for entire plugin, not for V2. Mention that in V2 it is supported in SELECT clause only and reference this paragraph.
But you have to share examples and syntax for V1 too and for WHERE clause too.
Fortunately, this won't change with your implementation in V2.
Please also add entire web page (not MD) as PDF to the PR, so we can see how it looks like.
_search-plugins/sql/sql/functions.md
Outdated
| The `field_expression` parameter is required, and the `path_expression` parameter is optional. Dot notation is used to show nesting level for `field_expression` and `path_expression` parameters. For example `nestedObj.innerFieldName` denotes a field nested one level. If the user does not provide the `path_expression` parameter it will be generated dynamically. For example the field `user.office.cubicle` would dynamically generate the path `user.office`. | ||
|
|
||
| ```sql | ||
| nested(field_expression | field_expression, path_expression) |
There was a problem hiding this comment.
Would it be worth putting the example before the description so you can see the layout of the expression before the explanation?
There was a problem hiding this comment.
Doesn't tend to be the standard way that the examples are presented on the documentation. I'd like to conform with the other pages.
GumpacG
approved these changes
May 23, 2023
acarbonetto
approved these changes
Jun 6, 2023
_search-plugins/sql/sql/functions.md
Outdated
|
|
||
| ## Nested query | ||
|
|
||
| The nested function is used in the `SELECT` clause to unnest nested object type collections. The nested collection is flattened and a cartesian product is returned when querying against two nested objects. |
There was a problem hiding this comment.
This document doesn't mention anything about the WHERE clause. Maybe we can add that too?
matthewryanwells
pushed a commit
that referenced
this pull request
Jun 8, 2023
…t#2374) * for new page how to analyze Jaeger trace data Signed-off-by: alicejw <[email protected]> * remove old image Signed-off-by: alicejw <[email protected]> * for new information and doc writer checklist Signed-off-by: alicejw <[email protected]> * for new information and doc writer checklist Signed-off-by: alicejw <[email protected]> * small rewrite Signed-off-by: alicejw <[email protected]> * new clean images from Dashboards URL directly Signed-off-by: alicejw <[email protected]> * for additional information Signed-off-by: alicejw <[email protected]> * remove blank lines Signed-off-by: alicejw <[email protected]> * for tech review feedback updates Signed-off-by: alicejw <[email protected]> * add requirements section Signed-off-by: alicejw <[email protected]> * for new procedure Signed-off-by: alicejw <[email protected]> * for tech review feedback updates Signed-off-by: alicejw <[email protected]> * continued updates Signed-off-by: alicejw <[email protected]> * for docker compose file instructions Signed-off-by: alicejw <[email protected]> * for docker usage instruction Signed-off-by: alicejw <[email protected]> * for step 2 view dashboards Signed-off-by: alicejw <[email protected]> * for additional link provided in tech review Signed-off-by: alicejw <[email protected]> * for link to index page to introduce the feature Signed-off-by: alicejw <[email protected]> * final checklist Signed-off-by: alicejw <[email protected]> * add warning not to use sample file in prod env Signed-off-by: alicejw <[email protected]> * updated docker file that is safe for prod env, remove warning note for previous file Signed-off-by: alicejw <[email protected]> * for small update to parent page Signed-off-by: alicejw <[email protected]> * for tech review Signed-off-by: alicejw <[email protected]> * typo fix for font Signed-off-by: alicejw <[email protected]> * for doc review #1 feedback updates Signed-off-by: alicejw <[email protected]> * for doc review feedback #2 updates Signed-off-by: alicejw <[email protected]> * for a couple minor changes Signed-off-by: alicejw <[email protected]> * spell out dashboard URI directly to trace analytics for accessibility. With URL obfuscated, this would not get spelled out in the vision-impaired app that scans through.it would simply read the title only Signed-off-by: alicejw <[email protected]> * need to add additional step from eng to generate sample data Signed-off-by: alicejw <[email protected]> * for additional step image of sample app Signed-off-by: alicejw <[email protected]> * rename step numbers Signed-off-by: alicejw <[email protected]> * minor fix heading levels Signed-off-by: alicejw <[email protected]> * updates recommended by the editorial reviewer Signed-off-by: alicejw <[email protected]> * clarify Spans window function Signed-off-by: alicejw <[email protected]> * clarified individual trace details section Signed-off-by: alicejw <[email protected]> Signed-off-by: alicejw <[email protected]>
Signed-off-by: forestmvey <[email protected]>
Signed-off-by: forestmvey <[email protected]>
forestmvey
changed the title
SELECT Clause Documentation
_search-plugins/sql/sql/nested.md
Outdated
|
|
||
| ## Nested In SELECT Clause | ||
|
|
||
| The nested function is used in the `SELECT` clause to unnest nested object type collections. The nested collection is flattened and a cartesian product is returned when querying against two or more nested collections. The nested function is supported in the V2 engine in the `SELECT` and `WHERE` clauses, see [query-processing-engines](https://opensearch.org/docs/latest/search-plugins/sql/limitation/#query-processing-engines) for more details. |
There was a problem hiding this comment.
I feel that phrase
The nested function is supported
is not suitable here. Maybe you need to move it outside of this paragraph, for example to a separate section on the very bottom called 'limitations'.
Signed-off-by: forestmvey <[email protected]>
Yury-Fridlyand
approved these changes
Jun 13, 2023
| The results contain documents that match the nested query: | ||
|
|
||
| | nested(message.info) | | ||
| :----------------------| |
There was a problem hiding this comment.
Is this the correct table format and not:
| nested(message.info) |
| -------------------- |
| letter2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added documentation section in SQL for nested function added to V2 engine in PR-1490 and PR-1657. The added features covers the
nestedfunction used in SQL.PDF
Nested Function - OpenSearch documentation.pdf
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.