[DOC] Ensure PPL docs have consistent look (opensearch-project#926)

* refactor ppl docs to keep consistent look Signed-off-by: Lantao Jin <[email protected]> * remove auto generated file Signed-off-by: Lantao Jin <[email protected]> * minor updates Signed-off-by: Lantao Jin <[email protected]> * address comments Signed-off-by: Lantao Jin <[email protected]> * fix hyper-link issue Signed-off-by: Lantao Jin <[email protected]> --------- Signed-off-by: Lantao Jin <[email protected]>
Bit-Quill · Dec 11, 2024 · 87bc2e8 · 87bc2e8
1 parent f13fadc
commit 87bc2e8
Show file tree

Hide file tree

Showing 22 changed files with 587 additions and 521 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Please refer to the [Flint Index Reference Manual](./docs/index.md) for more inf
 
 * For additional details on Spark PPL commands project, see [PPL Project](https://github.com/orgs/opensearch-project/projects/214/views/2)
 
-* Experiment ppl queries on local spark cluster[PPL on local spark ](docs/ppl-lang/local-spark-ppl-test-instruction.md)
+* Experiment ppl queries on local spark cluster [PPL on local spark ](docs/ppl-lang/local-spark-ppl-test-instruction.md)
 
 ## Prerequisites
 
@@ -88,7 +88,7 @@ bin/spark-shell --packages "org.opensearch:opensearch-spark-ppl_2.12:0.7.0-SNAPS
 ```
 
 ### PPL Run queries on a local spark cluster
-See ppl usage sample on local spark cluster[PPL on local spark ](local-spark-ppl-test-instruction.md)
+See ppl usage sample on local spark cluster [PPL on local spark ](docs/ppl-lang/local-spark-ppl-test-instruction.md)
 
 
 ## Code of Conduct

diff --git a/docs/ppl-lang/README.md b/docs/ppl-lang/README.md
@@ -94,7 +94,7 @@ For additional examples see the next [documentation](PPL-Example-Commands.md).
 
     - [`IP Address Functions`](functions/ppl-ip.md)
 
-    - [`Lambda Functions`](functions/ppl-lambda.md)
+    - [`Collection Functions`](functions/ppl-collection)
 
 ---
 ### PPL On Spark

diff --git a/docs/ppl-lang/functions/ppl-lambda.md → docs/ppl-lang/functions/ppl-collection.md b/docs/ppl-lang/functions/ppl-lambda.md → docs/ppl-lang/functions/ppl-collection.md
@@ -1,4 +1,56 @@
-## Lambda Functions
+## PPL Collection Functions
+
+### `ARRAY`
+
+**Description**
+
+`array(<value>...)` Returns an array with the given elements.
+
+**Argument type:**
+- A \<value\> can be any kind of value such as string, number, or boolean.
+
+**Return type:** ARRAY
+
+Example:
+
+    os> source=people | eval `array` = array(1, 2, 0, -1, 1.1, -0.11)
+    fetched rows / total rows = 1/1
+    +------------------------------+
+    | array                        |
+    +------------------------------+
+    | [1.0,2.0,0.0,-1.0,1.1,-0.11] |
+    +------------------------------+
+    os> source=people | eval `array` = array(true, false, true, true)
+    fetched rows / total rows = 1/1
+    +------------------------------+
+    | array                        |
+    +------------------------------+
+    | [true, false, true, true]    |
+    +------------------------------+
+
+
+### `ARRAY_LENGTH`
+
+**Description**
+
+`array_length(array)` Returns the number of elements in the outermost array.
+
+**Argument type:** ARRAY
+
+ARRAY or JSON_ARRAY object.
+
+**Return type:** INTEGER
+
+Example:
+
+    os> source=people | eval `array` = array_length(array(1,2,3,4)), `empty_array` = array_length(array())
+    fetched rows / total rows = 1/1
+    +---------+---------------+
+    | array   | empty_array   |
+    +---------+---------------+
+    | 4       | 0             |
+    +---------+---------------+
+
 
 ### `FORALL`
 
@@ -14,15 +66,15 @@ Returns `TRUE` if all elements in the array satisfy the lambda predicate, otherw
 
 Example:
 
-    os> source=people | eval array = json_array(1, -1, 2), result = forall(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(1, -1, 2), result = forall(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | false     |
     +-----------+
 
-    os> source=people | eval array = json_array(1, 3, 2), result = forall(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(1, 3, 2), result = forall(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
@@ -41,15 +93,15 @@ Consider constructing the following array:
 
 and perform lambda functions against the nested fields `a` or `b`. See the examples:
 
-    os> source=people | eval array = json_array(json_object("a", 1, "b", 1), json_object("a" , -1, "b", 2)), result = forall(array, x -> x.a > 0) | fields result
+    os> source=people | eval array = array(json_object("a", 1, "b", 1), json_object("a" , -1, "b", 2)), result = forall(array, x -> x.a > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | false     |
     +-----------+
 
-    os> source=people | eval array = json_array(json_object("a", 1, "b", 1), json_object("a" , -1, "b", 2)), result = forall(array, x -> x.b > 0) | fields result
+    os> source=people | eval array = array(json_object("a", 1, "b", 1), json_object("a" , -1, "b", 2)), result = forall(array, x -> x.b > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
@@ -71,15 +123,15 @@ Returns `TRUE` if at least one element in the array satisfies the lambda predica
 
 Example:
 
-    os> source=people | eval array = json_array(1, -1, 2), result = exists(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(1, -1, 2), result = exists(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | true      |
     +-----------+
 
-    os> source=people | eval array = json_array(-1, -3, -2), result = exists(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(-1, -3, -2), result = exists(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
@@ -102,15 +154,15 @@ An ARRAY that contains all elements in the input array that satisfy the lambda p
 
 Example:
 
-    os> source=people | eval array = json_array(1, -1, 2), result = filter(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(1, -1, 2), result = filter(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | [1, 2]    |
     +-----------+
 
-    os> source=people | eval array = json_array(-1, -3, -2), result = filter(array, x -> x > 0) | fields result
+    os> source=people | eval array = array(-1, -3, -2), result = filter(array, x -> x > 0) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
@@ -132,15 +184,15 @@ An ARRAY that contains the result of applying the lambda transform function to e
 
 Example:
 
-    os> source=people | eval array = json_array(1, 2, 3), result = transform(array, x -> x + 1) | fields result
+    os> source=people | eval array = array(1, 2, 3), result = transform(array, x -> x + 1) | fields result
     fetched rows / total rows = 1/1
     +--------------+
     | result       |
     +--------------+
     | [2, 3, 4]    |
     +--------------+
 
-    os> source=people | eval array = json_array(1, 2, 3), result = transform(array, (x, i) -> x + i) | fields result
+    os> source=people | eval array = array(1, 2, 3), result = transform(array, (x, i) -> x + i) | fields result
     fetched rows / total rows = 1/1
     +--------------+
     | result       |
@@ -162,23 +214,23 @@ The final result of applying the lambda functions to the start value and the inp
 
 Example:
 
-    os> source=people | eval array = json_array(1, 2, 3), result = reduce(array, 0, (acc, x) -> acc + x) | fields result
+    os> source=people | eval array = array(1, 2, 3), result = reduce(array, 0, (acc, x) -> acc + x) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | 6         |
     +-----------+
 
-    os> source=people | eval array = json_array(1, 2, 3), result = reduce(array, 10, (acc, x) -> acc + x) | fields result
+    os> source=people | eval array = array(1, 2, 3), result = reduce(array, 10, (acc, x) -> acc + x) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |
     +-----------+
     | 16        |
     +-----------+
 
-    os> source=people | eval array = json_array(1, 2, 3), result = reduce(array, 0, (acc, x) -> acc + x, acc -> acc * 10) | fields result
+    os> source=people | eval array = array(1, 2, 3), result = reduce(array, 0, (acc, x) -> acc + x, acc -> acc * 10) | fields result
     fetched rows / total rows = 1/1
     +-----------+
     | result    |