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.

Sign up for GitHub

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

Jump to bottom

Documentation Proposal for Nested Function in WHERE Clause #1640

Merged
merged 3 commits into from
May 30, 2023
Merged

Documentation Proposal for Nested Function in WHERE Clause #1640

merged 3 commits into from
May 30, 2023

Conversation

forestmvey
Copy link
Collaborator

Description

Add documentation for nested function use in WHERE clause of an SQL statement. Document covers two syntax options brought forward from legacy engine. Work on implementation is WIP but should align with this added documentation.

Syntax Options:

  • nested(path, condition)
  • nested(field, field | path) OPERATOR LITERAL

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.

@codecov
Copy link

codecov bot commented May 18, 2023 •
edited
Loading

Codecov Report

Merging #1640 (967da5b) into main (9824b1c) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #1640   +/-   ##
=========================================
  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.

dai-chen
dai-chen previously approved these changes May 23, 2023
View reviewed changes
@forestmvey forestmvey force-pushed the integ-nested-where-clause-doc branch from afd664e to d26adf2 Compare May 24, 2023 18:25
@forestmvey forestmvey requested a review from GumpacG as a code owner May 24, 2023 18:25
GumpacG
GumpacG previously approved these changes May 24, 2023
View reviewed changes
acarbonetto
acarbonetto approved these changes May 24, 2023
View reviewed changes
Copy link
Collaborator

@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.

Consider removing section 2.1 - unless you want to continue to provide context on how filter push down works (or just refer to another architecture diagram).

docs/dev/sql-nested-function-where-clause.md Outdated Show resolved Hide resolved
docs/dev/sql-nested-function-where-clause.md Outdated Show resolved Hide resolved
acarbonetto
acarbonetto previously approved these changes May 24, 2023
View reviewed changes
Copy link
Collaborator

@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.

Consider removing section 2.1 - unless you want to continue to provide context on how filter push down works (or just refer to another architecture diagram).

@forestmvey forestmvey mentioned this pull request May 25, 2023
Merged
6 tasks
@forestmvey forestmvey dismissed stale reviews from acarbonetto and GumpacG via 9a43b63 May 25, 2023 15:34
GumpacG
GumpacG previously approved these changes May 25, 2023
View reviewed changes
@forestmvey forestmvey mentioned this pull request May 25, 2023
Merged
6 tasks
@acarbonetto acarbonetto mentioned this pull request May 29, 2023
Open
@forestmvey forestmvey force-pushed the integ-nested-where-clause-doc branch from 9a43b63 to 4fa0440 Compare May 30, 2023 16:52
acarbonetto
acarbonetto previously approved these changes May 30, 2023
View reviewed changes
@acarbonetto acarbonetto merged commit 93c7a5f into opensearch-project:main May 30, 2023
@acarbonetto acarbonetto deleted the integ-nested-where-clause-doc branch May 30, 2023 17:56
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request May 30, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2023
@forestmvey @github-actions
Documentation Proposal for Nested Function in WHERE Clause (#1640)
35b81d6 
* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <[email protected]>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <[email protected]>

* Adding link for flattening details and filling in section with normalization strategy.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
(cherry picked from commit 93c7a5f)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request May 30, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2023
@forestmvey @github-actions
Documentation Proposal for Nested Function in WHERE Clause (#1640)
2313857 
* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <[email protected]>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <[email protected]>

* Adding link for flattening details and filling in section with normalization strategy.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
(cherry picked from commit 93c7a5f)
forestmvey added a commit that referenced this pull request May 30, 2023
@forestmvey
Documentation Proposal for Function in WHERE Clause (#1640)
4a50fbc 
Signed-off-by: forestmvey <[email protected]>
forestmvey added a commit that referenced this pull request May 30, 2023
@forestmvey
Documentation Proposal for Function in WHERE Clause (#1640)
d1d810b 
Signed-off-by: forestmvey <[email protected]>
acarbonetto pushed a commit that referenced this pull request May 30, 2023
@opensearch-trigger-bot @forestmvey
Documentation Proposal for Function in WHERE Clause (#1640) (#1670)
a9c8edd 
Signed-off-by: forestmvey <[email protected]>
Co-authored-by: forestmvey <[email protected]>
Yury-Fridlyand pushed a commit that referenced this pull request May 30, 2023
@opensearch-trigger-bot @forestmvey
Documentation Proposal for Function in WHERE Clause (#1640) (#1671)
817a4a8 
Signed-off-by: forestmvey <[email protected]>
Co-authored-by: forestmvey <[email protected]>
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
@forestmvey @MitchellGale
Documentation Proposal for Nested Function in WHERE Clause (opensea…
372c328 
…rch-project#1640)

* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <[email protected]>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <[email protected]>

* Adding link for flattening details and filling in section with normalization strategy.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
@forestmvey @MitchellGale
Documentation Proposal for Nested Function in WHERE Clause (opensea…
0895e98 
…rch-project#1640)

* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <[email protected]>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <[email protected]>

* Adding link for flattening details and filling in section with normalization strategy.

Signed-off-by: forestmvey <[email protected]>

---------

Signed-off-by: forestmvey <[email protected]>
Signed-off-by: Mitchell Gale <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GumpacG GumpacG GumpacG approved these changes

@Yury-Fridlyand Yury-Fridlyand Yury-Fridlyand approved these changes

@acarbonetto acarbonetto acarbonetto approved these changes

@MitchellGale MitchellGale MitchellGale approved these changes

@matthewryanwells matthewryanwells matthewryanwells approved these changes

@dai-chen dai-chen dai-chen left review comments

@pjfitzgibbons pjfitzgibbons Awaiting requested review from pjfitzgibbons

@ps48 ps48 Awaiting requested review from ps48 ps48 is a code owner

@kavithacm kavithacm Awaiting requested review from kavithacm kavithacm is a code owner

@derek-ho derek-ho Awaiting requested review from derek-ho derek-ho is a code owner

@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 is a code owner

@YANG-DB YANG-DB Awaiting requested review from YANG-DB YANG-DB is a code owner

@rupal-bq rupal-bq Awaiting requested review from rupal-bq rupal-bq is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@vamsi-amazon vamsi-amazon Awaiting requested review from vamsi-amazon vamsi-amazon is a code owner

@Swiddis Swiddis Awaiting requested review from Swiddis Swiddis is a code owner

@penghuo penghuo Awaiting requested review from penghuo penghuo is a code owner

@seankao-az seankao-az Awaiting requested review from seankao-az seankao-az is a code owner

@MaxKsyunz MaxKsyunz Awaiting requested review from MaxKsyunz MaxKsyunz is a code owner

@anirudha anirudha Awaiting requested review from anirudha anirudha is a code owner

Assignees
No one assigned
Labels
backport 2.x backport 2.8 v2.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@forestmvey @GumpacG @dai-chen @Yury-Fridlyand @acarbonetto @MitchellGale @matthewryanwells