@@ -48,85 +48,55 @@ The query start with search command and then flowing a set of command delimited
4848
4949* **Commands **
5050
51- - `Syntax <cmd/syntax.rst >`_
52-
53- - `ad command <cmd/ad.rst >`_ (1.3+, deprecated): Apply Random Cut Forest algorithm on the search result returned by a PPL command.
54-
55- - `append command <cmd/append.rst >`_ (3.3+, experimental): Append the result of a sub-search to the bottom of the input search results.
56-
57- - `appendcol command <cmd/appendcol.rst >`_ (3.1+, experimental): Append the result of a sub-search and attach it alongside the input search results.
58-
59- - `bin command <cmd/bin.rst >`_ (3.3+, experimental): Group numeric values into buckets of equal intervals.
60-
61- - `dedup command <cmd/dedup.rst >`_ (1.0+, stable): Remove identical documents defined by the field from the search result.
62-
63- - `describe command <cmd/describe.rst >`_ (2.1+, stable): Query the metadata of an index.
64-
65- - `eval command <cmd/eval.rst >`_ (1.0+, stable): Evaluate an expression and append the result to the search result.
66-
67- - `eventstats command <cmd/eventstats.rst >`_ (3.1+, experimental): Calculate aggregation statistics and add them as new fields to each event.
68-
69- - `expand command <cmd/expand.rst >`_ (3.1+, experimental): Transform a single document into multiple documents by expanding a nested array field.
70-
71- - `explain command <cmd/explain.rst >`_ (3.1+, stable): Explain the plan of query.
72-
73- - `fields command <cmd/fields.rst >`_ (1.0+, stable): Keep or remove fields from the search result.
74-
75- - `fillnull command <cmd/fillnull.rst >`_ (3.0+, experimental): Fill null with provided value in one or more fields in the search result.
76-
77- - `flatten command <cmd/flatten.rst >`_ (3.1+, experimental): Flatten a struct or an object field into separate fields in a document.
78-
79- - `grok command <cmd/grok.rst >`_ (2.4+, stable): Parse a text field with a grok pattern and append the results to the search result.
80-
81- - `head command <cmd/head.rst >`_ (1.0+, stable): Return the first N number of specified results after an optional offset in search order.
82-
83- - `join command <cmd/join.rst >`_ (3.0+, stable): Combine two datasets together.
84-
85- - `kmeans command <cmd/kmeans.rst >`_ (1.3+, stable): Apply the kmeans algorithm on the search result returned by a PPL command.
86-
87- - `lookup command <cmd/lookup.rst >`_ (3.0, experimental): Add or replace data from a lookup index (dimension table).
88-
89- - `ml command <cmd/ml.rst >`_: Apply machine learning algorithms to analyze data.
90-
91- - `multisearch command <cmd/multisearch.rst >`_ (3.4+, experimental): Execute multiple search queries and combine their results.
92-
93- - `parse command <cmd/parse.rst >`_ (1.3+, stable): Parse a text field with a regular expression and append the result to the search result.
94-
95- - `patterns command <cmd/patterns.rst >`_ (2.4+, stable): Extract log patterns from a text field and append the results to the search result.
96-
97- - `rare command <cmd/rare.rst >`_ (1.0+, stable): Find the least common tuple of values of all fields in the field list.
98-
99- - `regex command <cmd/regex.rst >`_ (3.3+, experimental): Filter search results by matching field values against a regular expression pattern.
100-
101- - `rename command <cmd/rename.rst >`_ (1.0+, stable): Rename one or more fields in the search result.
102-
103- - `replace command <cmd/replace.rst >`_ (3.4+, experimental): Replace text in one or more fields in the search result
104-
105- - `reverse command <cmd/reverse.rst >`_ (3.2+, experimental): Reverse the display order of search results.
106-
107- - `rex command <cmd/rex.rst >`_ (3.3+, experimental): Extract fields from a raw text field using regular expression named capture groups.
108-
109- - `search command <cmd/search.rst >`_ (1.0+, stable): Retrieve documents from the index.
110-
111- - `show datasources command <cmd/showdatasources.rst >`_ (2.4+, stable): Query datasources configured in the PPL engine.
112-
113- - `sort command <cmd/sort.rst >`_ (1.0+, stable): Sort all the search results by the specified fields.
114-
115- - `spath command <cmd/spath.rst >`_ (3.3+, experimental): Extract fields from structured text data.
116-
117- - `stats command <cmd/stats.rst >`_ (1.0+, stable): Calculate aggregation from search results.
118-
119- - `subquery command <cmd/subquery.rst >`_ (3.0, experimental): Embed one PPL query inside another for complex filtering and data retrieval operations.
120-
121- - `table command <cmd/table.rst >`_ (3.3+, experimental): Keep or remove fields from the search result using enhanced syntax options.
122-
123- - `timechart command <cmd/timechart.rst >`_ (3.3+, experimental): Create time-based charts and visualizations.
124-
125- - `top command <cmd/top.rst >`_ (1.0+, stable): Find the most common tuple of values of all fields in the field list.
126-
127- - `trendline command <cmd/trendline.rst >`_ (3.0+, experimental): Calculate moving averages of fields.
128-
129- - `where command <cmd/where.rst >`_ (1.0+, stable): Filter the search result using boolean expressions.
51+ - `Syntax <cmd/syntax.rst >`_ - General PPL syntax and query structure
52+
53+ The following commands are available in PPL:
54+
55+ * **Experimental commands are ready for use, but specific parameters may change before becoming stable **
56+
57+ ============================================================== ================== ======================== ==============================================================================================
58+ Command Name Version Introduced Current Status Command Description
59+ ============================================================== ================== ======================== ==============================================================================================
60+ `search command <cmd/search.rst >`_ 1.0 stable (since 1.0) Retrieve documents from the index.
61+ `where command <cmd/where.rst >`_ 1.0 stable (since 1.0) Filter the search result using boolean expressions.
62+ `subquery command <cmd/subquery.rst >`_ 3.0 experimental (since 3.0) Embed one PPL query inside another for complex filtering and data retrieval operations.
63+ `fields command <cmd/fields.rst >`_ 1.0 stable (since 1.0) Keep or remove fields from the search result.
64+ `rename command <cmd/rename.rst >`_ 1.0 stable (since 1.0) Rename one or more fields in the search result.
65+ `eval command <cmd/eval.rst >`_ 1.0 stable (since 1.0) Evaluate an expression and append the result to the search result.
66+ `replace command <cmd/replace.rst >`_ 3.4 experimental (since 3.4) Replace text in one or more fields in the search result
67+ `fillnull command <cmd/fillnull.rst >`_ 3.0 experimental (since 3.0) Fill null with provided value in one or more fields in the search result.
68+ `expand command <cmd/expand.rst >`_ 3.1 experimental (since 3.1) Transform a single document into multiple documents by expanding a nested array field.
69+ `flatten command <cmd/flatten.rst >`_ 3.1 experimental (since 3.1) Flatten a struct or an object field into separate fields in a document.
70+ `table command <cmd/table.rst >`_ 3.3 experimental (since 3.3) Keep or remove fields from the search result using enhanced syntax options.
71+ `stats command <cmd/stats.rst >`_ 1.0 stable (since 1.0) Calculate aggregation from search results.
72+ `eventstats command <cmd/eventstats.rst >`_ 3.1 experimental (since 3.1) Calculate aggregation statistics and add them as new fields to each event.
73+ `bin command <cmd/bin.rst >`_ 3.3 experimental (since 3.3) Group numeric values into buckets of equal intervals.
74+ `timechart command <cmd/timechart.rst >`_ 3.3 experimental (since 3.3) Create time-based charts and visualizations.
75+ `trendline command <cmd/trendline.rst >`_ 3.0 experimental (since 3.0) Calculate moving averages of fields.
76+ `sort command <cmd/sort.rst >`_ 1.0 stable (since 1.0) Sort all the search results by the specified fields.
77+ `reverse command <cmd/reverse.rst >`_ 3.2 experimental (since 3.2) Reverse the display order of search results.
78+ `head command <cmd/head.rst >`_ 1.0 stable (since 1.0) Return the first N number of specified results after an optional offset in search order.
79+ `dedup command <cmd/dedup.rst >`_ 1.0 stable (since 1.0) Remove identical documents defined by the field from the search result.
80+ `top command <cmd/top.rst >`_ 1.0 stable (since 1.0) Find the most common tuple of values of all fields in the field list.
81+ `rare command <cmd/rare.rst >`_ 1.0 stable (since 1.0) Find the least common tuple of values of all fields in the field list.
82+ `parse command <cmd/parse.rst >`_ 1.3 stable (since 1.3) Parse a text field with a regular expression and append the result to the search result.
83+ `grok command <cmd/grok.rst >`_ 2.4 stable (since 2.4) Parse a text field with a grok pattern and append the results to the search result.
84+ `rex command <cmd/rex.rst >`_ 3.3 experimental (since 3.3) Extract fields from a raw text field using regular expression named capture groups.
85+ `regex command <cmd/regex.rst >`_ 3.3 experimental (since 3.3) Filter search results by matching field values against a regular expression pattern.
86+ `spath command <cmd/spath.rst >`_ 3.3 experimental (since 3.3) Extract fields from structured text data.
87+ `patterns command <cmd/patterns.rst >`_ 2.4 stable (since 2.4) Extract log patterns from a text field and append the results to the search result.
88+ `join command <cmd/join.rst >`_ 3.0 stable (since 3.0) Combine two datasets together.
89+ `append command <cmd/append.rst >`_ 3.3 experimental (since 3.3) Append the result of a sub-search to the bottom of the input search results.
90+ `appendcol command <cmd/appendcol.rst >`_ 3.1 experimental (since 3.1) Append the result of a sub-search and attach it alongside the input search results.
91+ `lookup command <cmd/lookup.rst >`_ 3.0 experimental (since 3.0) Add or replace data from a lookup index.
92+ `multisearch command <cmd/multisearch.rst >`_ 3.4 experimental (since 3.4) Execute multiple search queries and combine their results.
93+ `ml command <cmd/ml.rst >`_: 2.5 stable (since 2.5) Apply machine learning algorithms to analyze data.
94+ `kmeans command <cmd/kmeans.rst >`_ 1.3 stable (since 1.3) Apply the kmeans algorithm on the search result returned by a PPL command.
95+ `ad command <cmd/ad.rst >`_ 1.3 deprecated (since 2.5) Apply Random Cut Forest algorithm on the search result returned by a PPL command.
96+ `describe command <cmd/describe.rst >`_ 2.1 stable (since 2.1) Query the metadata of an index.
97+ `explain command <cmd/explain.rst >`_ 3.1 stable (since 3.1) Explain the plan of query.
98+ `show datasources command <cmd/showdatasources.rst >`_ 2.4 stable (since 2.4) Query datasources configured in the PPL engine.
99+ ============================================================== ================== ======================== ==============================================================================================
130100
131101* **Functions **
132102
0 commit comments