blog.foresta.me

jq を使った JSON の更新について

2024年8月19日 engineering

こんにちは、 @kz_morita です。

またまた、jq を使う際の Tops についての記事です。

JSON の値を更新したり、追加したりする方法について書いていきます。

代入演算子と更新演算子

jq には、代入演算子 (=) と更新演算子 (|=) があります。

{
  "name": "Alice",
  "age": 20,
  "address": {
    "street": "123 Main St",
    "city": "Wonderland"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "555-1234"
    }
  ],
  "isActive": true
}

この JSON に対して、name を更新する場合、代入演算子を使うと以下のようになります。

$ cat sample.json | jq '.name = "Hoge"'
{
  "name": "Hoge",
  "age": 20,
  "address": {
    "street": "123 Main St",
    "city": "Wonderland"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "555-1234"
    }
  ],
  "isActive": true
}

更新演算子でも同様に更新できます。

$ cat sample.json | jq '.name |= "Hoge"'
{
  "name": "Hoge",
  "age": 20,
  "address": {
    "street": "123 Main St",
    "city": "Wonderland"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "555-1234"
    }
  ],
  "isActive": true
}

代入演算子と更新演算子の違いは、ほとんどなさそうなのですが違いが出る例が公式サイトに記載されていました。興味がある方はみてみると楽しそうです。

https://yujiorama.github.io/unofficial-translations/jq/l10n/jp/manual/

算術自己代入演算子

算術自己代入演算子には +=, -=, *=, /=, %= のようなものがあります。

以下は Age に 1 を加算する例です。

$ cat sample.json | jq '.age += 1'
{
  "name": "Alice",
  "age": 21,
  "address": {
    "street": "123 Main St",
    "city": "Wonderland"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "555-1234"
    }
  ],
  "isActive": true
}

このように普通のプログラミング言語のように計算をすることもできそうです。

まとめ

今回は jq を用いて JSON の値を更新する方法について書きました。最近 AWS CLI で AWS リソースを操作することが多いのですが jq を使うとコマンドラインで色々なことが実現できるので非常に便利でした。

関連記事