4 JSONPath機能

概要

このセクションでは、アイテムの値の前処理ステップ内でサポートされるJSONPath機能の概要を説明します。

JSONPathは、ドットで区切られたセグメントで構成されます。 セグメントは、JSON値の名前を表す単純な単語、ワイルドカード文字（*）、または角括弧で囲まれたより複雑な構文の形式を取ることができます。 角括弧で囲まれたセグメントの前のドットは任意であり、省略できます。

参照: JSONPathでLLDマクロ値の特殊文字をエスケープする。

サポートされているセグメント

一致するセグメントをその祖先を無視して検索するには（detached segment）、先頭に2つのドット（..）を付ける必要があります。 たとえば、$..name または $..['name'] は、すべての name プロパティの値を返します。

一致した要素名は、JSONPath にチルダ（~）接尾辞を追加することで抽出できます。 これにより、一致したオブジェクトの名前、または一致した配列アイテムのインデックスが文字列形式で返されます。 出力形式は他の JSONPath クエリと同じルールに従います。確定パスの結果はそのまま返され、不確定パスの結果は配列で返されます。 ただし、確定パスに一致する要素の名前を抽出することにはほとんど意味がありません。なぜなら、その名前はすでに分かっているためです。

フィルター式

フィルター式は、中置記法による算術式です。

サポートされるオペランド:

サポートされる演算子:

関数

関数はJSONPathの末尾で使用できます。 先行する関数が後続の関数で受け入れられる値を返す場合、複数の関数を連結できます。

サポートされている関数:

JSONPath集計関数は、引用符で囲まれた数値を受け入れます。 これらの値は、集計が必要な場合に文字列から数値型へ自動的に変換されます。 互換性のない入力が与えられた場合、関数はエラーを生成します。

出力値

JSONPath は、確定パスと不確定パスに分けることができます。
確定パスが返せるのは、null または単一の一致のみです。
不確定パスは複数の一致を返すことができます。これには、分離されたパス、複数の名前/インデックスのリスト、配列スライス、または式セグメントを含む JSONPath が該当します。
ただし、関数が使用される場合、JSONPath は確定になります。関数は常に単一の値を出力するためです。

確定パスは、参照しているオブジェクト/配列/値を返します。
一方、不確定パスは、一致したオブジェクト/配列/値の配列を返します。

パスの書式設定ルール

空白文字（スペース、タブ文字）は、たとえば $[ 'a' ][ 0 ][ ?( $.b == 'c' ) ][ : -1 ].first( ) のように、ブラケット記法のセグメントや式で使用できます。

文字列は、シングルクォート（'）またはダブルクォート（"）で囲む必要があります。 文字列内では、シングルクォートまたはダブルクォート（どちらで囲んでいるかに応じて）およびバックスラッシュ（\）は、バックスラッシュ文字（\）でエスケープします。

例

{
  "books": [
    {
      "category": "reference",
      "author": "Nigel Rees",
      "title": "Sayings of the Century",
      "price": 8.95,
      "id": 1
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99,
      "id": 2
    },
    {
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "isbn": "0-553-21311-3",
      "price": 8.99,
      "id": 3
    },
    {
      "category": "fiction",
      "author": "J. R. R. Tolkien",
      "title": "The Lord of the Rings",
      "isbn": "0-395-19395-8",
      "price": 22.99,
      "id": 4
    }
  ],
  "services": {
    "delivery": {
      "servicegroup": 1000,
      "description": "地元の町での翌日配達",
      "active": true,
      "price": 5
    },
    "bookbinding": {
      "servicegroup": 1001,
      "description": "A5形式での書籍の印刷および製本",
      "active": true,
      "price": 154.99
    },
    "restoration": {
      "servicegroup": 1002,
      "description": "さまざまな修復方法",
      "active": false,
      "methods": [
        {
          "description": "化学洗浄",
          "price": 46
        },
        {
          "description": "湿気で損傷したページの圧着",
          "price": 24.5
        },
        {
          "description": "破れた本の再製本",
          "price": 99.49
        }
      ]
    }
  },
  "filters": {
    "price": 10,
    "category": "fiction",
    "no filters": "no \"filters\""
  },
  "closed message": "店舗は閉店しています",
  "tags": [
    "a",
    "b",
    "c",
    "d",
    "e"
  ]
}