A function is defined as a function name followed by comma separated arguments wrapped in round brackets. it is important to understand functions like filter, sort, and max are executed as a method in a chain: the operation is applied to the data input, and forwarded to the next method in the chain (if any).

Examples:

sort(.address.city, "asc")

filter(.age >= 21) | sort(.age, "asc")

Documentation:

Function reference:

JSON Query supports all basic operators. Operators must have both a left and right hand side. To override the default precedence, an operator can be wrapped in parentheses (...).

Examples:

.age >= 18

filter(.age >= 18 and .age <= 65)

Documentation:

Operator reference:

A pipe is an array containing a series of queries. The queries in the pipeline are executed one by one, and the output of the first is the input for the next.

Example:

filter(.age >= 18) | sort(.name)

Documentation:

An object is defined as a regular JSON object with a property name as key, and a query as value. Objects can be used to transform data or to execute multiple query pipelines in parallel.

Example:

{
  names: map(.name),
  numberOfNames: size()
}

Documentation:

An array is defined as a regular JSON array: enclosed in square brackets, with items separated by a comma.

Example:

filter(.city in ["New York", "Atlanta"])

Documentation:

A property retrieves a property from an object. Multiple consecutive properties will retrieve a nested property.

Examples:

.age

.address.city

"first name"

get()

get("address", "city")

Documentation:

JSON Query supports the following primitive values, the same as in JSON: "string", number, boolean, null.

Examples:

"Hello world"

"Multi line textnwith "quoted" contents"

42

2.74

-1.2e3

true

false

null

Documentation: