ハイスコアボード

オブジェクト

JSONのオブジェクトは、他の言語の用語で言えば「ハッシュ」「マップ」「辞書」にあたります。

JSONは_オブジェクト_を次のように定義しています。

オブジェクトは、名前と値のペアの順序を持たない集合です。 オブジェクトは{左波括弧で始まり、}右波括弧で終わります。 各_名前_の後には:コロンが続き、_名前_と_値_のペアは,カンマで区切られます。

_名前_は必ず文字列でなければなりません。 _名前_は_キー_とも呼ばれます。

_値_には、任意のJSONの型を指定できます。 次の例のように、同じオブジェクトの中でも_値_ごとに異なる型を使えます。

{
  "name": "Jane",
  "age": 42,
  "pets": ["cat", "fish"],
  "address": {"street": "123 Main St", "city": "Springfield"}
}

_最後_のキーと値のペアの後ろにカンマを付けてはいけない点に注意してください。

オブジェクトの作成

波括弧を使って、名前と値のペアをまとめます。 名前は文字列でなければなりませんが、名前が識別子のような形（英数字とアンダースコアで構成され、数字で始まらない）であれば、引用符で囲む必要はありません。

{name: "Jane", age: 42}

_識別子のような形_でないキーを使うこともできます。 その場合は、引用符で囲むだけです。

{"first name": "Jane", "last name": "Lopez", age: 42}

名前が式の結果である場合、その式は必ず括弧（()）で囲まなければなりません。

$ echo "Jane" | jq -Rc '{.: 42}'
# verbose error message ...

$ echo "Jane" | jq -Rc '{(.): 42}'
{"Jane":42}

インデックス参照

値はドット記法を使ってオブジェクトから取り出します。

{name: "Jane", age: 42} | .age    # => 42

キーを識別子として参照できない場合は、角括弧記法を使います。

"name" as $key | {name: "Jane", age: 42} | .$key    # => error
"name" as $key | {name: "Jane", age: 42} | .[$key]  # => "Jane"

キーと値のペアの追加と変更

配列に新しいキーと値のペアを追加したり、既存のキーの値を更新したりするには、=代入演算子を使います。左辺にはインデックス式を書きます。

{name: "Jane", age: 42} | .sport = "tennis" | .age = 21
# => {
#      "name": "Jane",
#      "age": 21,
#      "sport": "tennis"
#    }

+演算子は、オブジェクトを_マージ_します。

{Richard: 54} + {Jane: 42}
# => {
#      "Richard": 54,
#      "Jane": 42
#    }

キーの削除

キーを削除するには、del関数を使います。 更新後のオブジェクトが返ります。

{name: "Jane", age: 42} | del(.age)   # => {"name": "Jane"}

delへの入力は、オブジェクト内のキーを指し示すインデックス式（ドット記法または角括弧記法を使います）です。 jqではこれをパス式と呼んでいます。 文字列をそのまま渡すだけでは不十分です。

{name: "Jane", age: 42} | del(name)        # error: name/0 is not defined
{name: "Jane", age: 42} | del("name")      # error: Invalid path expression with result "name"
{name: "Jane", age: 42} | del(.name)       # OK
{name: "Jane", age: 42} | del(.["name"])   # OK

キーの存在確認

• オブジェクトに特定のキーがあるかどうかを調べるには、has関数を使います。

  {name: "Jane", age: 42} as $example
  |
    ($example | has("name")),    # => true
    ($example | has("sport"))    # => false
  

• あるキーがオブジェクトの中にあるかどうかは、inで調べられます。

  {name: "Jane", age: 42} as $example
  |
    ("name"  | in($example)),    # => true
    ("sport" | in($example))     # => false
  

すべてのキーの一覧表示

すべてのキーの一覧を出力するには、keys関数を使います。

{name: "Jane", age: 42} | keys   # => ["age", "name"]

keysはキーを_並べ替える_点に注意してください。 元の順序でキーを取得したい場合は、keys_unsortedを使います。

すべての_値_を一覧表示するための同等の関数はありません。 ただし、.[]フィルターはオブジェクトの値を_ストリーム_として出力し、そのストリームは[...]配列コンストラクターで取り込むことができます。

[{first: "Jane", last: "Lopez", status: "awesome!"} | .[]]
# => ["Jane", "Lopez", "awesome!"]

繰り返し

• map_values(filter)関数は、フィルターをオブジェクト内の各_値_に適用します。

  {first: "Jane", last: "Lopez", status: "awesome!"}
  | map_values(ascii_upcase)
  # => {"first": "JANE", "last": "LOPEZ", "status": "AWESOME!"}
  

• オブジェクトを繰り返し処理するには、まずキーと値のオブジェクトの配列に変換する必要があります。 それを行うのがto_entries関数です。

  {name: "Jane", age: 42} | to_entries'
  # => [
  #      {
  #        "key": "name",
  #        "value": "Jane"
  #      },
  #      {
  #        "key": "age",
  #        "value": 42
  #      }
  #    ]
  

  ここまで来れば、mapのような配列の繰り返し用の関数を使えます。

• from_entries関数はその逆で、キーと値のオブジェクトの配列をオブジェクトに変換します。

  [
    {"key":"name", "value":"Jane"},
    {"key":"age", "value":42}
  ] | from_entries                  # =>{"name": "Jane", "age": 42}
  

• オブジェクト内の_各_キーと値のペアにフィルターを適用するには、with_entries(filter)関数を使います。

  たとえば、名前を年齢に対応づけるオブジェクトがあるとき、次のようにキーと値を入れ替えられます。

  {"Jane": 42, "Richard": 54}
  | with_entries({key: (.value | tostring), value: .key})
  

  と出力されます。

  {
    "42": "Jane",
    "54": "Richard"
  }
  

  with_entries(filter)は、次のものと同じです。

  to_entries | map(filter) | from_entries