TransformItems

Transform or query a JSON file using JSONata.

JSONata is a query and transformation language for JSON data.

yaml
type: "io.kestra.plugin.transform.jsonata.TransformItems"

Examples

Transform a JSON file using a JSONata expression.

yaml
id: jsonata_example
namespace: company.team

tasks:
  - id: http_download
    type: io.kestra.plugin.core.http.Download
    uri: https://dummyjson.com/products

  - id: get_product_and_brand_name
    description: "String Transformation"
    type: io.kestra.plugin.transform.jsonata.TransformItems
    from: "{{ outputs.http_download.uri }}"
    expression: products.(title & ' by ' & brand)

  - id: get_total_price
    description: "Number Transformation"
    type: io.kestra.plugin.transform.jsonata.TransformItems
    from: "{{ outputs.http_download.uri }}"
    expression: $sum(products.price)

  - id: sum_up
    description: "Writing out results in the form of JSON"
    type: io.kestra.plugin.transform.jsonata.TransformItems
    from: "{{ outputs.http_download.uri }}"
    expression: |
      {
        "total_products": $count(products),
        "total_price": $sum(products.price),
        "total_discounted_price": $sum(products.(price-(price*discountPercentage/100)))
      }

Calculate the total price per order from a JSON file.

yaml
id: jsonata
namespace: company.team

tasks:
  - id: extract
    type: io.kestra.plugin.core.http.Download
    uri: https://huggingface.co/datasets/kestra/datasets/resolve/main/json/orders.json

  - id: jsonata
    type: io.kestra.plugin.transform.jsonata.TransformItems
    from: "{{ outputs.extract.uri }}"
    expression: |
      Account.Order.{
        "order_id": OrderID,
        "total": $round($sum(Product.(Price * Quantity)), 2)
      }

Properties

expression *string

The JSONata expression to apply on the JSON object.

from *string

The file to be transformed.

Must be a kestra:// internal storage URI.

Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.

explodeArray booleanstring

Default true

Specifies whether to explode arrays into separate records.

If the JSONata expression results in a JSON array and this property is set to true, then a record will be written for each element. Otherwise, the JSON array is kept as a single record.

maxDepth integerstring

Default 1000

The maximum number of recursive calls allowed for the JSONata transformation.

Outputs

processedItemsTotal integer

The total number of items that was processed by the task.

uri string

Format uri

File URI containing the result of transformation.

​Transform​Items

TransformItems