Skip to content

Add more examples to the where command doc #4457

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
RyanL1997 merged 3 commits into from
Oct 14, 2025
Merged

Add more examples to the where command doc #4457

RyanL1997 merged 3 commits into from
Oct 14, 2025

Conversation

@ahkcs
Copy link
Contributor

@ahkcs ahkcs commented Oct 8, 2025 •
edited
Loading

Description

This PR significantly expands the WHERE command documentation to provide users with comprehensive examples covering a wide range of filtering scenarios in Piped Processing Language (PPL).

What Changed

  • Enhanced document structure: Improved formatting consistency for headings, sections, and syntax highlighting

  • Expanded examples: Added 7 new practical examples (previously 1 → now 8 total) illustrating diverse filtering use cases, including:

    • Basic field comparisons
    • Pattern matching using the LIKE operator (underscore and percent wildcards)
    • Multiple conditions with the AND operator
    • The IN operator for matching multiple values
    • NULL value checks using ISNULL()
    • Complex conditions combining parentheses and logical operators
    • The NOT operator for exclusion filtering

From #4227

manasvinibs and others added 2 commits October 8, 2025 11:33
@manasvinibs @ahkcs
Add more examples to the where command doc
d61bec7 
Signed-off-by: Manasvini B S <manasvis@amazon.com>
@ahkcs
where doc update
a31226d 
Signed-off-by: Kai Huang <ahkcs@amazon.com>
@ahkcs ahkcs marked this pull request as ready for review October 8, 2025 18:45
@ahkcs
update formatting
95a1463 
Signed-off-by: Kai Huang <ahkcs@amazon.com>
@dai-chen dai-chen added documentation Improvements or additions to documentation PPL Piped processing language labels Oct 8, 2025
@RyanL1997 RyanL1997 merged commit 02ee33e into opensearch-project:main Oct 14, 2025
39 of 40 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 14, 2025
@github-actions @manasvinibs
Add more examples to the where command doc (#4457)
08f819c 
Co-authored-by: Manasvini B S <manasvis@amazon.com>
(cherry picked from commit 02ee33e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Oct 14, 2025
Merged
ykmr1224 added a commit to ykmr1224/sql that referenced this pull request Oct 15, 2025
@ykmr1224
Merge main to map-remove:
6acef56 
commit cba8d02
Author: Tomoyuki MORITA <moritato@amazon.com>
Date:   Wed Oct 15 13:08:05 2025 -0700

    Add MAP_APPEND internal function to Calcite PPL (opensearch-project#4515)

    * Add MAP_APPEND internal function to Calcite PPL

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    * Minor fix

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    * Address comment

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    * Rebase and fix IT issue

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    ---------

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

commit 3388dc7
Author: Lantao Jin <ltjin@amazon.com>
Date:   Thu Oct 16 01:45:29 2025 +0800

    Use `_doc` + `_shard_doc` as sort tiebreaker to get better performance (opensearch-project#4569)

    * Use _shard_doc as sort tiebreaker

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * _doc as a part of tie-breaker have better performance

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    ---------

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

commit 5630119
Author: qianheng <qianheng@amazon.com>
Date:   Wed Oct 15 16:40:41 2025 +0800

    Fix sort push down into agg after project already pushed (opensearch-project#4546)

    * Fix sort push down into agg

    Signed-off-by: Heng Qian <qianheng@amazon.com>

    * Change some json files to yaml format

    Signed-off-by: Heng Qian <qianheng@amazon.com>

    ---------

    Signed-off-by: Heng Qian <qianheng@amazon.com>

commit 1e62fba
Author: Tomoyuki MORITA <moritato@amazon.com>
Date:   Tue Oct 14 17:20:38 2025 -0700

    Fix JsonExtractAllFunctionIT failure (opensearch-project#4556)

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

commit 02ee33e
Author: Kai Huang <105710027+ahkcs@users.noreply.github.com>
Date:   Tue Oct 14 14:28:53 2025 -0700

    Add more examples to the `where` command doc (opensearch-project#4457)

    Co-authored-by: Manasvini B S <manasvis@amazon.com>

commit 0b7e86c
Author: Jialiang Liang <jiallian@amazon.com>
Date:   Tue Oct 14 10:46:01 2025 -0700

    [Enhancement] Error handling for illegal character usage in java regex named capture group (opensearch-project#4434)

    Co-authored-by: Simeon Widdis <sawiddis@amazon.com>

commit 9c97cfb
Author: Tomoyuki MORITA <moritato@amazon.com>
Date:   Tue Oct 14 08:36:43 2025 -0700

    Add JSON_EXTRACT_ALL internal function for Calcite PPL (opensearch-project#4489)

    * Add JSON_EXTRACT_ALL internal function for Calcite PPL

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    * Address comments

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    * Minor fix

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

    ---------

    Signed-off-by: Tomoyuki Morita <moritato@amazon.com>

commit 89dbc31
Author: Lantao Jin <ltjin@amazon.com>
Date:   Tue Oct 14 18:24:52 2025 +0800

    Check server status before starting Prometheus (opensearch-project#4537)

    * Check server status before starting Prometheus

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * Change to func call

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * Fix doc

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    ---------

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

commit fe62472
Author: Lantao Jin <ltjin@amazon.com>
Date:   Tue Oct 14 18:10:27 2025 +0800

    Update request builder after pushdown sort into agg buckets (opensearch-project#4541)

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

commit 42a415f
Author: qianheng <qianheng@amazon.com>
Date:   Tue Oct 14 17:42:45 2025 +0800

    Including metadata fields type when doing agg/filter script push down (opensearch-project#4522)

    * Including metadata fields type when doing agg/filter script push down

    Signed-off-by: Heng Qian <qianheng@amazon.com>

    * Fix IT

    Signed-off-by: Heng Qian <qianheng@amazon.com>

    ---------

    Signed-off-by: Heng Qian <qianheng@amazon.com>

commit 8de0386
Author: Xinyuan Lu <xinyual@amazon.com>
Date:   Tue Oct 14 16:41:08 2025 +0800

    Fix percentile bug (opensearch-project#4539)

    * fix percentile bug

    Signed-off-by: xinyual <xinyual@amazon.com>

    * add IT

    Signed-off-by: xinyual <xinyual@amazon.com>

    * optimize it

    Signed-off-by: xinyual <xinyual@amazon.com>

    ---------

    Signed-off-by: xinyual <xinyual@amazon.com>

commit de2fdc8
Author: Lantao Jin <ltjin@amazon.com>
Date:   Tue Oct 14 12:29:03 2025 +0800

    [FollowUp] Set 0 and negative value of subsearch.maxout as unlimited (opensearch-project#4534)

    * [FollowUp] Set 0 and negative value of subsearch.maxout as unlimited

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * fix doctest

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * Fix conflicts

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    ---------

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

commit 977b7ab
Author: Simeon Widdis <sawiddis@gmail.com>
Date:   Mon Oct 13 20:23:10 2025 -0700

    Update stalled action (opensearch-project#4485)

commit fddbb70
Author: Lantao Jin <ltjin@amazon.com>
Date:   Tue Oct 14 10:23:12 2025 +0800

    Add configurable sytem limitations for `subsearch` and `join` command (opensearch-project#4501)

    * Add configurable sytem limitations for subsearch and join command

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * Fix IT

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * typo

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * fix IT

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * remove rollback in doc

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * address comments

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * fix typo

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    * Fix IT

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

    ---------

    Signed-off-by: Lantao Jin <ltjin@amazon.com>

Signed-off-by: Tomoyuki Morita <moritato@amazon.com>
yuancu pushed a commit that referenced this pull request Oct 17, 2025
@opensearch-trigger-bot @github-actions
@manasvinibs @LantaoJin
Add more examples to the where command doc (#4457) (#4557)
e5bc2cd 
(cherry picked from commit 02ee33e)

Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Signed-off-by: Lantao Jin <ltjin@amazon.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Manasvini B S <manasvis@amazon.com>
Co-authored-by: Lantao Jin <ltjin@amazon.com>
@tkykenmt tkykenmt mentioned this pull request Jan 11, 2026
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ykmr1224 ykmr1224 ykmr1224 approved these changes

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

@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

@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

@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

@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

backport 2.19-dev documentation Improvements or additions to documentation PPL Piped processing language

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ahkcs @ykmr1224 @RyanL1997 @dai-chen @manasvinibs