jq - JSON processor

by @pixiebrix

Apply a jq expression: https://stedolan.github.io/jq/


How to Use

What is jq?

jq is a powerful expression language for filtering and transforming structured JSON data

Helpful Resources

Brick Arguments

The jq brick takes two input arguments:

  • data: an object, array, or single value which is passed to jq
  • filter: the jq "filter", which controls how to filter/transform the data

Filter Examples

Creating a new object from the input

View on jqplay

{foo: 42, bar: .}

Parsing and summing values

View on jqplay

.transactions | map(.amount | capture("(?<val>\\d+) USD") | .val | tonumber) | add

Filtering an array

View on jqplay

Assign the query to a variable so you can use it in the select clause

.query as $query | [.items[] | select(.text == $query)]

Inputs

Name Required Type Description
data unknown The input data, or blank to process the data from the previous step
filter string jq filter expression

Outputs

Name Required Type Description
No outputs for this brick defined.

@pixiebrix/jq

Version

1.7.16

Created

Aug. 17, 2021

Updated

June 13, 2022