Sync PPL commands doc with main repo (#549)

Signed-off-by: Peng Huo <[email protected]>
opensearch-project · Mar 9, 2022 · 91cacf9 · 91cacf9
1 parent 4a9ad9b
commit 91cacf9
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 0 deletions.
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/dedup.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/dedup.ts
@@ -108,4 +108,7 @@ PPL query:
     | 13               | F        |
     | 18               | M        |
     +------------------+----------+
+
+#### Limitation
+The \`dedup\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/eval.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/eval.ts
@@ -73,4 +73,7 @@ PPL query:
     | 28    | 56          | 112     |
     | 33    | 66          | 132     |
     +-------+-------------+---------+
+
+#### Limitation
+The \`eval\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/head.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/head.ts
@@ -55,4 +55,7 @@ PPL query:
     | Hattie        | 36        |
     | Nanette       | 28        |
     +---------------+-----------+
+
+#### Limitation
+The \`head\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/rare.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/rare.ts
@@ -69,4 +69,7 @@ PPL query:
     | M        | 25       |
     | M        | 29       |
     +----------+----------+
+
+#### Limitation
+The \`rare\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/rename.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/rename.ts
@@ -51,4 +51,7 @@ PPL query:
     | 13   | Quility |
     | 18   | null    |
     +------+---------+
+
+#### Limitation
+The \`rename\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/stats.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/stats.ts
@@ -334,4 +334,20 @@ PPL query:
     | 1            | 20         |
     | 3            | 30         |
     +--------------+------------+
+
+### Example 9: Calculate the count by a gender and span
+
+The example gets the count of age by the interval of 10 years and group by gender.
+
+PPL query::
+
+    os> source=accounts | stats count() as cnt by span(age, 5) as age_span, gender
+    fetched rows / total rows = 3/3
+    +-------+------------+----------+
+    | cnt   | age_span   | gender   |
+    |-------+------------+----------|
+    | 1     | 25         | F        |
+    | 2     | 30         | M        |
+    | 1     | 35         | M        |
+    +-------+------------+----------+
 `;
diff --git a/dashboards-observability/public/components/common/helpers/ppl_docs/commands/top.ts b/dashboards-observability/public/components/common/helpers/ppl_docs/commands/top.ts
@@ -62,4 +62,7 @@ PPL query:
     | F        | 39       |
     | M        | 31       |
     +----------+----------+
+
+#### Limitation
+The \`top\` command is not rewritten to OpenSearch DSL, it is only executed on the coordination node.
 `;