jq

BETA: This component is experimental and therefore subject to change outside of major version releases.

Transforms and filters messages using jq queries.

# Common config fields, showing default values
jq:
query: .
Try out Bloblang

For better performance and improved capabilities try out native Benthos mapping with the bloblang processor.

The provided query is executed on each message, targeting either the contents as a structured JSON value or as a raw string using the field raw, and the message is replaced with the query result.

Message metadata is also accessible within the query from the variable $metadata.

This processor uses the gojq library, and therefore does not require jq to be installed as a dependency. However, this also means there are some differences in how these queries are executed versus the jq cli which you can read about here.

If the query does not emit any value then the message is filtered, if the query returns multiple values then the resulting message will be an array containing all values.

The full query syntax is described in jq's documentation.

Error Handling

Queries can fail, in which case the message remains unchanged, errors are logged, and the message is flagged as having failed, allowing you to use standard processor error handling patterns.

Fields

query

The jq query to filter and transform messages with.

Type: string
Default: "."

raw

Whether to process the input as a raw string instead of as JSON.

Type: bool
Default: false

Examples

When receiving JSON documents of the form:

{
"locations": [
{"name": "Seattle", "state": "WA"},
{"name": "New York", "state": "NY"},
{"name": "Bellevue", "state": "WA"},
{"name": "Olympia", "state": "WA"}
]
}

We could collapse the location names from the state of Washington into a field Cities:

{"Cities": "Bellevue, Olympia, Seattle"}

With the following config:

pipeline:
processors:
- jq:
query: '{Cities: .locations | map(select(.state == "WA").name) | sort | join(", ") }'