From 4db82f040857587d378c669f08a859653a3f141a Mon Sep 17 00:00:00 2001 From: YANGDB Date: Thu, 3 Oct 2024 17:43:06 -0700 Subject: [PATCH] update main ppl-lang README.md page Signed-off-by: YANGDB --- docs/ppl-lang/README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/ppl-lang/README.md b/docs/ppl-lang/README.md index f561e11c2..81b7736b7 100644 --- a/docs/ppl-lang/README.md +++ b/docs/ppl-lang/README.md @@ -1,16 +1,12 @@ -### PPL Language +## PPL Language -Overview ---------- -Piped Processing Language (PPL), powered by OpenSearch, enables OpenSearch users with exploration and discovery of, and finding search patterns in data stored in OpenSearch, using a set of commands delimited by pipes (|). These are essentially read-only requests to process data and return results. +## Overview -Currently, OpenSearch users can query data using either Query DSL or SQL. Query DSL is powerful and fast. However, it has a steep learning curve, and was not designed as a human interface to easily create ad hoc queries and explore user data. SQL allows users to extract and analyze data in OpenSearch in a declarative manner. OpenSearch now makes its search and query engine robust by introducing Piped Processing Language (PPL). It enables users to extract insights from OpenSearch with a sequence of commands delimited by pipes (|). It supports a comprehensive set of commands including search, where, fields, rename, dedup, sort, eval, head, top and rare, and functions, operators and expressions. Even new users who have recently adopted OpenSearch, can be productive day one, if they are familiar with the pipe (|) syntax. It enables developers, DevOps engineers, support engineers, site reliability engineers (SREs), and IT managers to effectively discover and explore log, monitoring and observability data stored in OpenSearch. +Piped Processing Language (PPL), powered by OpenSearch, enables OpenSearch users with exploration and discovery of, and finding search patterns in data stored in OpenSearch Or S3. -We expand the capabilities of our Workbench, a comprehensive and integrated visual query tool currently supporting only SQL, to run on-demand PPL commands, and view and save results as text and JSON. We also add a new interactive standalone command line tool, the PPL CLI, to run on-demand PPL commands, and view and save results as text and JSON. - -The query start with search command and then flowing a set of command delimited by pipe (|). -| for example, the following query retrieve firstname and lastname from accounts if age large than 18. +The PPL query start with search command and then flowing a set of command delimited by pipe (|). +for example, the following query retrieve firstname and lastname from accounts if age larger than 18. ```sql source=accounts @@ -18,8 +14,10 @@ source=accounts | fields firstname, lastname ``` +For additional examples see the next [documentation](PPL-Example-Commands.md). + --- -### Specifications +### Commands Specifications * **Commands**