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
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 3 commits into from
+186 −2

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 a.gender FROM accounts a JOIN accounts b ON a.account_number = b.account_number GROUP BY a.gender"
  }'


{
  "error": {
    "reason": "Invalid SQL query",
    "details": "JOIN queries do not support aggregations on the joined result. For more information, see https://docs.opensearch.org/latest/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
add tests
5149d8e 
Signed-off-by: Jialiang Liang <[email protected]>
@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.

legacy/src/main/java/org/opensearch/sql/legacy/parser/SqlParser.java
throws SqlParseException {
String errorMessage =
"JOIN queries do not support aggregations on the joined result. For more information, see"
+ " https://docs.opensearch.org/latest/search-plugins/sql/limitation/#join-does-not-support-aggregations-on-the-joined-result";
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion: Can we fetch the cluster version and use it instead of latest?

If we ever fix this constraint, this error message will be invalid on all the older versions that output it

legacy/src/main/java/org/opensearch/sql/legacy/parser/SqlParser.java
updateJoinLimit(query.getLimit(), joinSelect);

// todo: throw error feature not supported: no group bys on joins ?
validateJoinWithoutAggregations(query);
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion (if-minor): Should we move a lot of this logic to the construction of the JoinSelect?

Seems weird to construct the object and then use its setters to fill in everything, instead of just passing in the subquery block and letting it figure itself out. This also would guarantee that this validation is applied everywhere that JoinSelect is constructed.

legacy/src/test/java/org/opensearch/sql/legacy/unittest/parser/SqlParserTest.java
/** JOIN Aggregation Validation Tests */
private void expectJoinAggregationException() {
thrown.expect(SqlParseException.class);
thrown.expectMessage("JOIN queries do not support aggregations on the joined result.");
Copy link
Collaborator

@Swiddis Swiddis Sep 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

todo: This is a hard-coded copy of the validation's private error message

We should just make it public & reference it like we do with most of the other strings. I've had a few cases now of trying to clarify error messages and getting several pointless test failures for it

legacy/src/test/java/org/opensearch/sql/legacy/unittest/parser/SqlParserTest.java

@Test
public void joinWithGroupByShouldThrowException() throws SqlParseException {
expectJoinAggregationException();
Copy link
Collaborator

Choose a reason for hiding this comment

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

praise: Nice idea to make the exception expectation a shared function

I probably would have done a bunch of thrown.expect && thrown.expectMessage(ERROR_MSG) copies, this is nicer

legacy/src/test/java/org/opensearch/sql/legacy/unittest/parser/SqlParserTest.java
}

@Test
public void joinWithSumFunctionShouldThrowException() throws SqlParseException {
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion: Since we're just leaning on Select.AGGREGATE_FUNCTIONS, we could reduce all these aggregation cases to a single table-driven test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Swiddis Swiddis Swiddis left review comments

@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

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

At least 2 approving reviews are required to merge this pull request.

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

Successfully merging this pull request may close these issues.

[Enhancement] Better error handling for JOIN query limitation
2 participants
@RyanL1997 @Swiddis