Merge remote-tracking branch 'origin/update-correlation-experimental-…

…comment' into describe-show-commands

Signed-off-by: YANGDB <[email protected]>

README.md

@@ -7,6 +7,7 @@ OpenSearch Flint is ... It consists of four modules:
 - `flint-spark-integration`: a module that provides Spark integration for Flint and derived dataset based on it.
 - `ppl-spark-integration`: a module that provides PPL query execution on top of Spark See [PPL repository](https://github.com/opensearch-project/piped-processing-language).
 
+
 ## Documentation
 
 Please refer to the [Flint Index Reference Manual](./docs/index.md) for more information.

docs/PPL-Correlation-command.md

@@ -1,5 +1,8 @@
 ## PPL Correlation Command
 
+> This is an experimental command - it may be removed in future versions
+
+
 ## Overview
 
 In the past year OpenSearch Observability & security teams have been busy with many aspects of improving data monitoring and visibility.
@@ -262,6 +265,8 @@ The new correlation command is actually a ‘hidden’ join command therefore th
 
 Catalyst engine will optimize this query according to the most efficient join ordering.
 
+> This is an experimental command - it may be removed in future versions
+
 * * *
 
 ## Appendix

ppl-spark-integration/README.md

@@ -221,8 +221,8 @@ Next tasks ahead will resolve this:
 
 This section describes the next steps planned for enabling additional commands and gamer translation.
 
-#### Supported
-The next samples of PPL queries are currently supported:
+#### Example PPL Queries
+See the next samples of PPL queries :
 
 **Fields**
  - `source = table`
@@ -272,31 +272,15 @@ Limitation: Overriding existing field is unsupported, following queries throw ex
 - `source = table | stats sum(productsAmount) by span(transactionDate, 1d) as age_date | sort age_date`
 - `source = table | stats sum(productsAmount) by span(transactionDate, 1w) as age_date, productId`
 
-> For additional details, review [FlintSparkPPLTimeWindowITSuite.scala](../integ-test/src/test/scala/org/opensearch/flint/spark/ppl/FlintSparkPPLTimeWindowITSuite.scala)
-
-#### Supported Commands:
- - `search` - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/search.rst)  
- - `where`  - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/where.rst)  
- - `fields` - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/fields.rst)  
- - `eval`   - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/eval.rst)
- - `head`   - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/head.rst)
- - `stats`  - [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/stats.rst) (supports AVG, COUNT, DISTINCT_COUNT, MAX, MIN and SUM aggregation functions)
- - `sort` -   [See details](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/sort.rst)
- - `correlation` - [See details](../docs/PPL-Correlation-command.md)
-
-> For additional details, review [Integration Tests](../integ-test/src/test/scala/org/opensearch/flint/spark/)
- 
 ---
 
-#### Planned Support
+For additional details on PPL commands - view [PPL Commands Docs](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/index.rst)
 
- - support the `explain` command to return the explained PPL query logical plan and expected execution plan
+For additional details on Spark PPL commands project, see [PPL Project](https://github.com/orgs/opensearch-project/projects/214/views/2)
+For additional details on Spark PPL commands support campaign, see [PPL Commands Campaign](https://github.com/opensearch-project/opensearch-spark/issues/408)
+
+#### Experimental Commands:
+ - `correlation` - [See details](../docs/PPL-Correlation-command.md)
 
- - attend [sort](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/sort.rst) partially supported, missing capability to sort by alias field (span like or aggregation)
- - attend `alias` - partially supported, missing capability to sort by / group-by alias field name 
+> This is an experimental command - it may be removed in future versions
 
- - add [conditions](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/functions/condition.rst) support
- - add [top](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/top.rst) support
- - add [cast](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/functions/conversion.rst) support
- - add [math](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/functions/math.rst) support
- - add [deduplicate](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/cmd/dedup.rst) support