Skip to content
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.

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

[DOC] Documentation for PPL new engine (V3) and limitations of 3.0.0 Beta #3488

Merged
merged 2 commits into from
Apr 1, 2025

Conversation

LantaoJin
Copy link
Member

@LantaoJin LantaoJin commented Mar 28, 2025

Description

Documentation for PPL new engine (V3) and limitations of 3.0.0 Beta

Related Issues

Resolves #3431

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • New functionality has javadoc added.
  • New functionality has a user manual doc added.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • 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.

@LantaoJin LantaoJin added documentation Improvements or additions to documentation calcite calcite migration releated labels Mar 28, 2025
Signed-off-by: Lantao Jin <[email protected]>

PPL query::

>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_plugins/_ppl -d '{
Copy link
Collaborator

Choose a reason for hiding this comment

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

in docTest, we can use PPL without curl, which is much clearner in doc, for instantce, https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/fields.rst

Copy link
Member Author

Choose a reason for hiding this comment

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

Calcite is not enabled by default in main branch. Query started with OS> will fail. That's why I use curl formatting.

- All SQL queries
- `trendline`
- `show datasource`
- `explain`
Copy link
Collaborator

@dai-chen dai-chen Mar 31, 2025

Choose a reason for hiding this comment

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

So we cannot check the query plan for a PPL query supported by V3 engine?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. The original code freeze is March 31. So it is out of P0 tasks for beta. But seems the deadline postponed to April 8, I will add this command if possible.

Copy link
Member Author

Choose a reason for hiding this comment

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

Discussed offline with Charlie, it requires a RFC for details of new explain command.

@LantaoJin LantaoJin merged commit 0d96879 into opensearch-project:main Apr 1, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
calcite calcite migration releated documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Documentation for PPL new engine and limitations within 3.0.0 Beta
3 participants