Fix asc/desc keyword behavior for sort command #4651

ritvibhatt · 2025-10-23T23:42:46Z

Description

Fixed PPL sort command so that asc/desc keywords specify sort direction for individual fields instead of applying all fields in the sort command. (keywords work on individual fields ex sort field1 asc, field2 desc means field1 is ascending and field2 is descending) while preventing mixing of prefix (+/-) and suffix (asc/desc) syntax, and updated integration tests to match this behavior.

Files Changed

ppl/src/main/antlr/OpenSearchPPLParser.g4: Updated grammar rules for sort command to support individual field ASC/DESC keywords
ppl/src/main/java/org/opensearch/sql/ppl/parser/AstBuilder.java: Updated visitSortCommand() method to handle new ASC/DESC field syntax and prevent mixing of +/-and asc/desc sort syntax
ppl/src/main/java/org/opensearch/sql/ppl/parser/AstExpressionBuilder.java: Modified expression building logic for sort field parsing and ensure consistent sort direction syntax usage across all sort fields
ppl/src/main/java/org/opensearch/sql/ppl/utils/ArgumentFactory.java: Updated getSortArguments() method to process new field-level ASC/DESC syntax

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

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.

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

ykmr1224 · 2025-10-24T20:10:07Z

ppl/src/main/antlr/OpenSearchPPLParser.g4


 sortField
-   : (PLUS | MINUS)? sortFieldExpression
+   : (PLUS | MINUS) sortFieldExpression (ASC | A | DESC | D)  # invalidMixedSortField


Why do we need to define invalid syntax? wouldn't it fail parse without this?

It would fail the parse but added this to have a more clear error for when the two syntaxes are mixed

docs/user/ppl/cmd/sort.rst

ppl/src/main/java/org/opensearch/sql/ppl/parser/AstExpressionBuilder.java

RyanL1997

Hi @ritvibhatt , thanks for the change, and I left some minor comments.

docs/user/ppl/cmd/sort.rst

ppl/src/main/java/org/opensearch/sql/ppl/utils/ArgumentFactory.java

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

(cherry picked from commit 448c42a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

(cherry picked from commit 448c42a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Simeon Widdis <sawiddis@amazon.com> Co-authored-by: Manasvini B S <manasvis@amazon.com> Co-authored-by: opensearch-ci-bot <opensearch-infra@amazon.com> Co-authored-by: Louis Chu <clingzhi@amazon.com> Co-authored-by: Chen Dai <daichen@amazon.com> Co-authored-by: Mebsina <cnoramut@gmail.com> Co-authored-by: Yuanchun Shen <yuanchu@amazon.com> Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: Kai Huang <105710027+ahkcs@users.noreply.github.com> Co-authored-by: Peng Huo <penghuo@gmail.com> Co-authored-by: Alexey Temnikov <alexey.temnikov@improving.com> Co-authored-by: Riley Jerger <214163063+RileyJergerAmazon@users.noreply.github.com> Co-authored-by: Tomoyuki MORITA <moritato@amazon.com> Co-authored-by: Lantao Jin <ltjin@amazon.com> Co-authored-by: Songkan Tang <songkant@amazon.com> Co-authored-by: qianheng <qianheng@amazon.com> Co-authored-by: Simeon Widdis <sawiddis@gmail.com> Co-authored-by: Xinyuan Lu <xinyual@amazon.com> Co-authored-by: Jialiang Liang <jiallian@amazon.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Vinay Krishna Pudyodu <vinkrish.neo@gmail.com> Co-authored-by: expani <anijainc@amazon.com> Co-authored-by: expani1729 <110471048+expani@users.noreply.github.com> Co-authored-by: Vamsi Manohar <reddyvam@amazon.com> Co-authored-by: ritvibhatt <53196324+ritvibhatt@users.noreply.github.com> Co-authored-by: Xinyu Hao <75524174+ishaoxy@users.noreply.github.com> Co-authored-by: Marc Handalian <marc.handalian@gmail.com> Co-authored-by: Marc Handalian <handalm@amazon.com> Fix join type ambiguous issue when specify the join type with sql-like join criteria (opensearch-project#4474) Fix issue 4441 (opensearch-project#4449) Fix missing keywordsCanBeId (opensearch-project#4491) Fix the bug of explicit makeNullLiteral for UDT fields (opensearch-project#4475) Fix mapping after aggregation push down (opensearch-project#4500) Fix percentile bug (opensearch-project#4539) Fix JsonExtractAllFunctionIT failure (opensearch-project#4556) Fix sort push down into agg after project already pushed (opensearch-project#4546) Fix push down failure for min/max on derived field (opensearch-project#4572) Fix compile issue in main (opensearch-project#4608) Fix filter parsing failure on date fields with non-default format (opensearch-project#4616) Fix bin nested fields issue (opensearch-project#4606) Fix: Support Alias Fields in MIN, MAX, FIRST, LAST, and TAKE Aggregations (opensearch-project#4621) fix rename issue (opensearch-project#4670) Fixes for `Multisearch` and `Append` command (opensearch-project#4512) Fix asc/desc keyword behavior for sort command (opensearch-project#4651) Fix] Fix unexpected shift of extraction for `rex` with nested capture groups in named groups (opensearch-project#4641) Fix CVE-2025-48924 (opensearch-project#4665) Fix sub-fields accessing of generated structs (opensearch-project#4683) Fix] Incorrect Field Index Mapping in AVG to SUM/COUNT Conversion (opensearch-project#15)

ritvibhatt added 6 commits October 23, 2025 16:41

update asc/desc behavior for sort

e4f55cf

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

fix both sort directions on same field error

3619cc3

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

fix formatting

eb6536e

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

fix tests

2c8f5ea

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

fix tests

aeb9fea

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

update failing tests

647cc90

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

LantaoJin added the enhancement New feature or request label Oct 24, 2025

ritvibhatt changed the title ~~Update asc/desc keyword behavior for sort command~~ Fix asc/desc keyword behavior for sort command Oct 24, 2025

ritvibhatt marked this pull request as ready for review October 24, 2025 15:52

ritvibhatt requested review from RyanL1997 and yuancu as code owners October 24, 2025 15:52

ykmr1224 reviewed Oct 24, 2025

View reviewed changes

docs/user/ppl/cmd/sort.rst Show resolved Hide resolved

ykmr1224 reviewed Oct 24, 2025

View reviewed changes

ppl/src/main/java/org/opensearch/sql/ppl/parser/AstExpressionBuilder.java Show resolved Hide resolved

RyanL1997 reviewed Oct 28, 2025

View reviewed changes

docs/user/ppl/cmd/sort.rst Show resolved Hide resolved

ppl/src/main/java/org/opensearch/sql/ppl/utils/ArgumentFactory.java Show resolved Hide resolved

update docs and casting refactor

428c47b

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

RyanL1997 previously approved these changes Oct 28, 2025

View reviewed changes

fix formatting

00ddb41

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

ritvibhatt dismissed RyanL1997’s stale review via 00ddb41 October 28, 2025 20:49

fix formatting

18e09f0

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>

ykmr1224 approved these changes Oct 28, 2025

View reviewed changes

RyanL1997 approved these changes Oct 28, 2025

View reviewed changes

RyanL1997 added the backport 2.19-dev label Oct 28, 2025

RyanL1997 merged commit 448c42a into opensearch-project:main Oct 28, 2025
53 of 54 checks passed

opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 28, 2025

Fix asc/desc keyword behavior for sort command (#4651)

d67c120

(cherry picked from commit 448c42a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

opensearch-trigger-bot bot mentioned this pull request Oct 28, 2025

[Backport 2.19-dev] Fix asc/desc keyword behavior for sort command #4691

Merged

expani pushed a commit to vinaykpud/sql that referenced this pull request Nov 4, 2025

Fix asc/desc keyword behavior for sort command (opensearch-project#4651)

5872b1a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix asc/desc keyword behavior for sort command #4651

Fix asc/desc keyword behavior for sort command #4651

Uh oh!

ritvibhatt commented Oct 23, 2025 •

edited

Loading

Uh oh!

ykmr1224 Oct 24, 2025

Uh oh!

ritvibhatt Oct 24, 2025

Uh oh!

Uh oh!

Uh oh!

RyanL1997 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix asc/desc keyword behavior for sort command #4651

Fix asc/desc keyword behavior for sort command #4651

Uh oh!

Conversation

ritvibhatt commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

ykmr1224 Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

ritvibhatt Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RyanL1997 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ritvibhatt commented Oct 23, 2025 •

edited

Loading