Skip to content

[Enhancement] Add error handling for known limitation of sql JOIN #4344

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
Merged
merged 15 commits into from
Oct 1, 2025
Merged

[Enhancement] Add error handling for known limitation of sql JOIN #4344

merged 15 commits into from
Oct 1, 2025

Conversation

RyanL1997
Copy link
Collaborator

@RyanL1997 RyanL1997 commented Sep 22, 2025 •
edited
Loading

Signed-off-by: Jialiang Liang [email protected]

Description

Better error handling for known limitation of sql JOIN

example:

❯   curl -X POST "localhost:9200/_plugins/_sql" -H 'Content-Type: application/json' -d'
  {
    "query": "SELECT SUM(a.balance) FROM accounts a JOIN accounts b ON a.account_number = b.account_number"
  }'

{
  "error": {
    "reason": "Invalid SQL query",
    "details": "JOIN queries do not support aggregations on the joined result. For more information, see https://docs.opensearch.org/3.2/search-plugins/sql/limitation/#join-does-not-support-aggregations-on-the-joined-result",
    "type": "SqlParseException"
  },
  "status": 400
}%

Related Issues

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • New functionality has javadoc added.
  • New functionality has a user manual doc added.
  • New PPL command checklist all confirmed.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff or -s.
  • Public documentation issue/PR created.

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.

@RyanL1997 RyanL1997 added enhancement New feature or request SQL labels Sep 22, 2025
@RyanL1997 RyanL1997 changed the title [Enhancement] Better error handling for known limitation of sql JOIN [Enhancement] Add error handling for known limitation of sql JOIN Sep 22, 2025
@RyanL1997 RyanL1997 marked this pull request as ready for review September 22, 2025 15:23
Swiddis
Swiddis reviewed Sep 23, 2025
View reviewed changes
Copy link
Collaborator

@Swiddis Swiddis left a comment

Choose a reason for hiding this comment

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

A few suggestions -- I think this could be designed better if changing JoinSelect doesn't cause cascading breakage, otherwise this approach is fine.

Swiddis
Swiddis previously approved these changes Sep 25, 2025
View reviewed changes
Swiddis
Swiddis previously approved these changes Sep 25, 2025
View reviewed changes
dai-chen
dai-chen reviewed Sep 25, 2025
View reviewed changes
@Swiddis Swiddis added the v3.3.0 label Sep 29, 2025
dai-chen
dai-chen reviewed Sep 30, 2025
View reviewed changes
Copy link
Collaborator

@dai-chen dai-chen left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Did you remove your test accidentally? I don't see any UT or IT now.

@RyanL1997
Copy link
Collaborator Author

RyanL1997 commented Sep 30, 2025 •
edited
Loading

Added the new tests in AntlrSqlParseTreeVisitorTest.java cc @dai-chen

dai-chen
dai-chen reviewed Sep 30, 2025
View reviewed changes
legacy/src/main/java/org/opensearch/sql/legacy/antlr/visitor/AntlrSqlParseTreeVisitor.java Outdated
Comment on lines 295 to 305
if (ctx.tableSource().size() > 1) {
return true;
}

for (int i = 0; i < ctx.tableSource().size(); i++) {
Boolean hasJoinInTableSource = visit(ctx.tableSource(i));
if (hasJoinInTableSource != null && hasJoinInTableSource) {
return true;
}
}
return false;
Copy link
Collaborator

Choose a reason for hiding this comment

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

what's this trying to check?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

transferring some offline communication with @dai-chen here: we should limit the scope of this for only check the explicit join only - so removed this section.

@RyanL1997
[Enhancement] Better error handling for known limitation of sql JOIN
427f11b 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
spotless fix
c4f7d6f 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
add tests
130c775 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
simeon - dynamic versioning for doc link
71f07ac 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
spotless fix
a6e4765 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
simeon - extract error msg into utils
18c2a59 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
simeon - table driven tests
0593ddd 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
simeon - join select constructor
cc2808e 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
chen - antlr check instead
237297d 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
chen - fix test and explictly allow nested field
79cc77c 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
remove some comments
bb39f25 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
chen - simplify the detection logic of join
c335106 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
clean up debugging
1829fad 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
chen - add back testing
47e9bd2 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997
chen remove the check for implicit join
1634610 
Signed-off-by: Jialiang Liang <[email protected]>
@RyanL1997 RyanL1997 force-pushed the join-limitation-error-handling branch from 9240c00 to 1634610 Compare September 30, 2025 23:30
@RyanL1997 RyanL1997 mentioned this pull request Oct 1, 2025
Merged
8 tasks
@RyanL1997
Copy link
Collaborator Author

#4378 is failing at the same

@Swiddis
Copy link
Collaborator

Swiddis commented Oct 1, 2025

Failures exist in main and are only with recently added tests, think this is ok to merge

@Swiddis Swiddis merged commit 649ce41 into opensearch-project:main Oct 1, 2025
48 of 52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Swiddis Swiddis Swiddis approved these changes

@dai-chen dai-chen dai-chen approved these changes

@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

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

@vamsimanohar vamsimanohar Awaiting requested review from vamsimanohar vamsimanohar 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

@Yury-Fridlyand Yury-Fridlyand Awaiting requested review from Yury-Fridlyand Yury-Fridlyand is a code owner

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

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

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

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

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

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

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

@qianheng-aws qianheng-aws Awaiting requested review from qianheng-aws qianheng-aws is a code owner

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

Assignees
No one assigned
Labels
enhancement New feature or request SQL v3.3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Enhancement] Better error handling for JOIN query limitation
3 participants
@RyanL1997 @Swiddis @dai-chen