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

Documentation Proposal for Nested Function in WHERE Clause #1640

Merged

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

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

GumpacG
GumpacG previously approved these changes May 25, 2023
Signed-off-by: forestmvey <forestv@bitquilltech.com>
Signed-off-by: forestmvey <forestv@bitquilltech.com>
acarbonetto
acarbonetto previously approved these changes May 30, 2023
…ization strategy.

Signed-off-by: forestmvey <forestv@bitquilltech.com>
@forestmvey forestmvey dismissed stale reviews from acarbonetto, Yury-Fridlyand, and GumpacG via 967da5b May 30, 2023 17:16
@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 bot pushed a commit that referenced this pull request May 30, 2023
* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

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

Signed-off-by: forestmvey <forestv@bitquilltech.com>

---------

Signed-off-by: forestmvey <forestv@bitquilltech.com>
(cherry picked from commit 93c7a5f)
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2023
* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

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

Signed-off-by: forestmvey <forestv@bitquilltech.com>

---------

Signed-off-by: forestmvey <forestv@bitquilltech.com>
(cherry picked from commit 93c7a5f)
forestmvey added a commit that referenced this pull request May 30, 2023
Signed-off-by: forestmvey <forestv@bitquilltech.com>
forestmvey added a commit that referenced this pull request May 30, 2023
Signed-off-by: forestmvey <forestv@bitquilltech.com>
acarbonetto pushed a commit that referenced this pull request May 30, 2023
Signed-off-by: forestmvey <forestv@bitquilltech.com>
Co-authored-by: forestmvey <forestv@bitquilltech.com>
Yury-Fridlyand pushed a commit that referenced this pull request May 30, 2023
Signed-off-by: forestmvey <forestv@bitquilltech.com>
Co-authored-by: forestmvey <forestv@bitquilltech.com>
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
…rch-project#1640)

* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

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

Signed-off-by: forestmvey <forestv@bitquilltech.com>

---------

Signed-off-by: forestmvey <forestv@bitquilltech.com>
MitchellGale pushed a commit to Bit-Quill/opensearch-project-sql that referenced this pull request Jun 12, 2023
…rch-project#1640)

* Adding documentation for nested function use in WHERE clause.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

* Revising sections based on PR feedback.

Signed-off-by: forestmvey <forestv@bitquilltech.com>

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

Signed-off-by: forestmvey <forestv@bitquilltech.com>

---------

Signed-off-by: forestmvey <forestv@bitquilltech.com>
Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants