Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user/ppl/cmd/trendline.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The `trendline` command calculates moving averages of fields.
## Syntax

trendline [sort <[+\|-] sort-field>] [sma\|wma](number-of-datapoints, field) [as \<alias\>] [[sma\|wma](number-of-datapoints, field) [as \<alias\>]]...
trendline [sort <[+\|-] sort-field>] \[sma\|wma\](number-of-datapoints, field) [as \<alias\>] [\[sma\|wma\](number-of-datapoints, field) [as \<alias\>]]...
* [+\|-]: optional. The plus [+] stands for ascending order and NULL/MISSING first and a minus [-] stands for descending order and NULL/MISSING last. **Default:** ascending order and NULL/MISSING first.
* sort-field: mandatory when sorting is used. The field used to sort.
* sma\|wma: mandatory. Simple Moving Average (sma) applies equal weighting to all values, Weighted Moving Average (wma) applies greater weight to more recent values.
Expand Down
32 changes: 16 additions & 16 deletions docs/user/ppl/functions/cryptographic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

### Description

Version: 3.1.0
Usage: `md5(str)` calculates the MD5 digest and returns the value as a 32 character hex string.
Argument type: STRING
Return type: STRING
Example
Version: 3.1.0
Usage: `md5(str)` calculates the MD5 digest and returns the value as a 32-character hex string.
Argument type: STRING
Return type: STRING
Example

```ppl
source=people
Expand All @@ -31,11 +31,11 @@ fetched rows / total rows = 1/1

### Description

Version: 3.1.0
Usage: `sha1(str)` returns the hex string result of SHA-1.
Argument type: STRING
Return type: STRING
Example
Version: 3.1.0
Usage: `sha1(str)` returns the hex string result of SHA-1.
Argument type: STRING
Return type: STRING
Example

```ppl
source=people
Expand All @@ -58,12 +58,12 @@ fetched rows / total rows = 1/1

### Description

Version: 3.1.0
Usage: `sha2(str, numBits)` returns the hex string result of SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, and SHA-512).
The numBits indicates the desired bit length of the result, which must have a value of 224, 256, 384, or 512.
Argument type: STRING, INTEGER
Return type: STRING
Example
Version: 3.1.0
Usage: `sha2(str, numBits)` returns the hex string result of SHA-2 family of hash functions (SHA-224, SHA-256, SHA-384, and SHA-512).
The numBits indicates the desired bit length of the result, which must have a value of 224, 256, 384, or 512.
Argument type: STRING, INTEGER
Return type: STRING
Example

```ppl
source=people
Expand Down
3 changes: 2 additions & 1 deletion docs/user/ppl/functions/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

All PPL date and time functions use the UTC time zone. Both input and output values are interpreted as UTC.
For instance, an input timestamp literal like '2020-08-26 01:01:01' is assumed to be in UTC, and the now()
function also returns the current date and time in UTC.
function also returns the current date and time in UTC.

## ADDDATE

### Description
Expand Down
12 changes: 6 additions & 6 deletions docs/user/ppl/functions/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ fetched rows / total rows = 4/4

### Description

Version: 3.1.0
Limitation: Only works when plugins.calcite.enabled=true
Usage: `json_valid(value)` Evaluates whether a string uses valid JSON syntax. Returns TRUE if valid, FALSE if invalid. NULL input returns NULL.
Argument type: STRING
Return type: BOOLEAN
Example
Version: 3.1.0
Limitation: Only works when plugins.calcite.enabled=true
Usage: `json_valid(value)` Evaluates whether a string uses valid JSON syntax. Returns TRUE if valid, FALSE if invalid. NULL input returns NULL.
Argument type: STRING
Return type: BOOLEAN
Example

```ppl
source=people
Expand Down
2 changes: 0 additions & 2 deletions docs/user/ppl/general/datatypes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
##

# Data Types

## Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/user/ppl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The query start with search command and then flowing a set of command delimited

for example, the following query retrieve firstname and lastname from accounts if age large than 18.

```
```ppl ignore
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when should add ppl ignore?

Copy link
Contributor Author

@kylehounslow kylehounslow Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ignore keyword will omit the code block from doctests. For this case, we want to exclude from doctests but still want ppl syntax highlighting applied.
Note: All ppl blocks are converted to sql formatting on export to docs website (sql is the closest format supported for syntax highlighting).

source=accounts
| where age > 18
| fields firstname, lastname
Expand Down
Loading
Loading