Skip to content

Update PPL functions documentation#11747

Merged
natebower merged 11 commits intoopensearch-project:mainfrom
ritvibhatt:add-ppl-functions-docs
Jan 21, 2026
Merged

Update PPL functions documentation#11747
natebower merged 11 commits intoopensearch-project:mainfrom
ritvibhatt:add-ppl-functions-docs

Conversation

@ritvibhatt
Copy link
Copy Markdown
Contributor

@ritvibhatt ritvibhatt commented Jan 7, 2026

Description

  • Add folder for functions under sql-and-ppl/ppl directory and files for PPL functions (datetime, aggregate, etc) to export PPL function documentation from SQL repo
  • Uncomment links to function files in commands documentation
  • Add proper escaping for angle brackets and asterisks in patterns.md documentation examples
  • Add escaping for pipes in join.md examples

Issues Resolved

Closes #[Replace this text, including the brackets, with the issue number. Leave "Closes #" so the issue is closed properly.]

Version

3.4+

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    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>
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 7, 2026

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws kolchfa-aws added the In progress Issue/PR: The issue or PR is in progress. label Jan 8, 2026
ritvibhatt and others added 3 commits January 8, 2026 11:17
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
Signed-off-by: ritvibhatt <53196324+ritvibhatt@users.noreply.github.com>
@ritvibhatt ritvibhatt marked this pull request as ready for review January 8, 2026 21:54
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
@ritvibhatt
Copy link
Copy Markdown
Contributor Author

Hi @kolchfa-aws this PR is ready for review when you get the chance thanks!

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress backport 3.4 and removed In progress Issue/PR: The issue or PR is in progress. labels Jan 13, 2026

### Example

``` ppl ignore
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this coming from a script? Should be sql

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, I'll fix that in the script to make sure that they are all sql

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@kolchfa-aws kolchfa-aws added Editorial review and removed Doc review PR: Doc review in progress labels Jan 20, 2026
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@natebower natebower merged commit 9e7cfdf into opensearch-project:main Jan 21, 2026
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 21, 2026
* add ppl functions documentation

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

* add ppl functions documentation

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

* keep comments for admin section

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

* fix links

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

* fix settings link in expressions.md

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

* fix function examples

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

* add index.md for ppl functions

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

* Doc review

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Ritvi Bhatt <ribhatt@amazon.com>
Signed-off-by: ritvibhatt <53196324+ritvibhatt@users.noreply.github.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
(cherry picked from commit 9e7cfdf)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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.

3 participants