Update SQL plugin documentation #830
Conversation
|
@Naarcha-AWS, do you want me to rebase and squash? This will fix the DCO failure as well, I think. |
|
@Yury-Fridlyand: Please do! |
Update SQL plugin relevance functions documentation. Co-authored-by: MaxKsyunz <[email protected]> Signed-off-by: Yury Fridlyand <[email protected]>
|
@Naarcha-AWS, ready for review, thanks! |
_search-plugins/sql/cli.md
Outdated
| 1. Save the sample [accounts test data](https://github.com/opensearch-project/sql/blob/main/doctest/test_data/accounts.json) file. | ||
|
|
||
| 1. Index the sample data. | ||
| 1. Run the CLI tool. If you cluster runs with default security settings, use following command line: |
There was a problem hiding this comment.
"If your cluster runs with the default security settings, use the following command:"
There was a problem hiding this comment.
Thank you, fixed in d5e9d0d.
Signed-off-by: Yury Fridlyand <[email protected]>
| @@ -10,7 +10,7 @@ has_toc: false | |||
|
|
|||
| ML Commons for OpenSearch eases the development of machine learning features by providing a set of common machine learning (ML) algorithms through transport and REST API calls. Those calls choose the right nodes and resources for each ML request and monitors ML tasks to ensure uptime. This allows you to leverage existing open-source ML algorithms and reduce the effort required to develop new ML features. | |||
|
|
|||
| Interaction with the ML Commons plugin occurs through either the [REST API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api) or [AD]({{site.url}}{{site.baseurl}}/observability-plugin/ppl/commands#ad) and [kmeans]({{site.url}}{{site.baseurl}}/observability-plugin/ppl/commands#kmeans) Piped Processing Language (PPL) commands. | |||
| Interaction with the ML Commons plugin occurs through either the [REST API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api) or [AD]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#ad) and [kmeans]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions#kmeans) Piped Processing Language (PPL) commands. | |||
There was a problem hiding this comment.
i think i brought this up previously but couldn't remember the conclusion. SQL is under search category and PPL is under observability category because they have different use cases from user's perspective. is there a reason to move PPL out of observability?
There was a problem hiding this comment.
I agree with you -- the use cases are different. I moved to SQL, because it is implemented by SQL plugin. I'm welcome for proposals and ready to move it back.
There was a problem hiding this comment.
got it. I don't have a strong opinion on this, i think it's ok if no objections
_search-plugins/sql/index.md
Outdated
| @@ -1,76 +1,17 @@ | |||
| --- | |||
| layout: default | |||
| title: SQL | |||
| title: SQL Plugin - SQL & PPL | |||
There was a problem hiding this comment.
i don't see other plugin titles having Plugin in them, should this just say SQL & PPL?
_search-plugins/sql/ppl/functions.md
Outdated
| title: Commands | ||
| parent: Piped processing language | ||
| nav_order: 4 | ||
| title: Functions |
There was a problem hiding this comment.
the content in this file are mostly commands instead of functions?
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| layout: default | |||
| title: Functions | |||
There was a problem hiding this comment.
i see there are sql/sql/functions, sql/ppl/functions (those are actually commands), sql/functions.
SQL language supports all SQL plugin functions
PPL supports all SQL functions
sql/functions are referred as "SQL functions" or "SQL plugin functions", but then there are also SQL specific functions (sql/sql/functions). seems a bit confusing, should sql/functions be referred as maybe SQL plugin common (or shared) functions?
Signed-off-by: Yury Fridlyand <[email protected]>
|
@Naarcha-AWS, |
|
Dear @hdhalter, |
Naarcha-AWS
added
1 - Backlog
|
@Yury-Fridlyand: Are you if someone from the Docs team takes this PR over and adds edits and redirects? |
For sure, do whatever you need. |
Naarcha-AWS
added
backport 2.1
|
@Yury-Fridlyand: Closing this in favor of #1111 |
Signed-off-by: Yury Fridlyand [email protected]
Description
Update SQL plugin documentation.
Issues Resolved
query_stringandmatch_phrase_prefixwould be released in 2.2.0PPLlanguage block moved fromobservability plugintoSQL plugin, because it is provided by the SQL plugin.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.