relaysh/stdlib-step-jq

stdlib-step-jq

镜像概述

stdlib-step-jq是一个用于应用jq过滤器处理JSON数据的Docker镜像。作为工作流步骤组件，它能够接收JSON输入数据，通过用户定义的jq过滤器对数据进行处理，并返回处理结果，适用于各类JSON数据的筛选、转换和提取场景。

核心功能与特性

• JSON数据处理：支持通过jq过滤器对输入的JSON数据进行灵活处理
• 自定义过滤器：允许用户指定任意有效的jq过滤器表达式
• 参数传递：可通过args设置预定义变量，供过滤器中引用
• 原始输出支持：通过raw参数控制是否以原始字符串格式输出结果（对应jq的-r标志）

使用场景

• JSON数据筛选：从数组或对象中选择符合条件的元素
• 数据转换：对JSON结构进行重组、字段重命名或格式转换
• 数据提取：从复杂JSON中提取特定字段或计算结果
• 工作流数据处理：作为自动化工作流中的数据处理步骤，预处理或转换数据

配置说明

该镜像在工作流步骤定义的spec section中支持以下配置项：

使用方法示例

以下是一个完整的工作流步骤配置示例，演示如何使用该镜像筛选JSON数组中符合条件的元素：

yaml
step:
  name: grab-something  # 步骤名称
  image: relaysh/stdlib-step-jq  # 使用的Docker镜像
  spec:
    input:  # 输入数据（JSON数组）
    - foo: "bar"
    - foo: "baz"
    - foo: "quux"
    args:  # 传递给过滤器的参数
      something: "bar"  # 定义变量$something的值为"bar"
    filter: "map(select(.foo != $something))"  # jq过滤器：选择foo不等于$something的元素

配置说明

• input：此处为包含3个对象的JSON数组，每个对象包含foo字段
• args：定义了变量$something，值为"bar"，可在过滤器中直接引用
• filter：使用map(select(.foo != $something))过滤器，筛选出foo字段值不等于"bar"的元素
• 处理结果：将返回筛选后的数组[{"foo":"baz"},{"foo":"quux"}]