Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nested Documentation for 2.7 Related Features #262

Merged
merged 5 commits into from
May 9, 2023

Conversation

forestmvey
Copy link

Description

Added documentation for architectural changes from PR-1490. The added features covers the nested function used in the SELECT clause of an SQL statement. Future work has placeholders in documentation and can be added to with proposals as development continues.

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

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.

@forestmvey forestmvey requested a review from a team May 2, 2023 21:48
@codecov
Copy link

codecov bot commented May 2, 2023

Codecov Report

Merging #262 (b8732df) into integ-nested-select-doc (4bbd12a) will not change coverage.
The diff coverage is n/a.

@@                    Coverage Diff                     @@
##             integ-nested-select-doc     #262   +/-   ##
==========================================================
  Coverage                      97.16%   97.16%           
  Complexity                      4120     4120           
==========================================================
  Files                            371      371           
  Lines                          10373    10373           
  Branches                         704      704           
==========================================================
  Hits                           10079    10079           
  Misses                           287      287           
  Partials                           7        7           
Flag Coverage Δ
sql-engine 97.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link

@GumpacG GumpacG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Not sure if it's appropriate in these docs but maybe add a simple example of mapping, data, and expected result of a simple query for devs in the future who don't have knowledge of nested in OpenSearch. May be appropriate in the use case section.

@forestmvey
Copy link
Author

Looks great! Not sure if it's appropriate in these docs but maybe add a simple example of mapping, data, and expected result of a simple query for devs in the future who don't have knowledge of nested in OpenSearch. May be appropriate in the use case section.

Good idea!

@Yury-Fridlyand
Copy link

  1. List new docs in index.md
  2. Add links to demo you did for nested

@forestmvey
Copy link
Author

  1. List new docs in index.md
  2. Add links to demo you did for nested

Thanks, I have added the files I added to index.md. There is already my demo video embedded in sql-nested-function-select-clause.md

Copy link

@acarbonetto acarbonetto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Please address comments.

docs/dev/sql-nested-function.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-select-clause.md Outdated Show resolved Hide resolved
forestmvey added 5 commits May 9, 2023 13:45
…ific documentation.

Signed-off-by: forestmvey <forestv@bitquilltech.com>
… comments and adding table of contents.

Signed-off-by: forestmvey <forestv@bitquilltech.com>
…tion for examples, and used a better example to describe response flattening and cross join.

Signed-off-by: forestmvey <forestv@bitquilltech.com>
…uery examples, minor clarifications on descriptions.

Signed-off-by: forestmvey <forestv@bitquilltech.com>
Signed-off-by: forestmvey <forestv@bitquilltech.com>
@forestmvey forestmvey force-pushed the dev-nested-select-doc branch from 3a010df to b8732df Compare May 9, 2023 20:46
@forestmvey forestmvey merged commit f0a2a24 into integ-nested-select-doc May 9, 2023
@forestmvey forestmvey deleted the dev-nested-select-doc branch May 9, 2023 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants