他のバージョンの文書9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

9.15. JSON関数と演算子

表9.40「jsonjsonb演算子」に2つのJSONデータ型(8.14. JSONデータ型を参照)で使用可能な演算子を示します。

表9.40 jsonjsonb演算子

演算子右オペランド型説明例の結果
->intJSON配列要素を取得(添字はゼロから、負数なら後ろから数える)'[{"a":"foo"},{"b":"bar"},{"c":"baz"}]'::json->2{"c":"baz"}
->textキーに依るJSONオブジェクトフィールド取得'{"a": {"b":"foo"}}'::json->'a'{"b":"foo"}
->>intJSON 配列要素をtextとして取得'[1,2,3]'::json->>23
->>textJSON オブジェクトフィールドをtextとして取得'{"a":1,"b":2}'::json->>'b'2
#>text[]指定されたパスにあるJSONオブジェクトを取得'{"a": {"b":{"c": "foo"}}}'::json#>'{a,b}'{"c": "foo"}
#>>text[]指定されたパスにあるJSONオブジェクトをtextとして取得'{"a":[1,2,3],"b":[4,5,6]}'::json#>>'{a,2}'3

注記

jsonjsonb型の両方に対して、以上の演算子の対応するものがあります。 フィールド/要素/パス抽出演算子は左辺の入力と同じ型(jsonまたはjsonb)を返します。 ただし、textを返すと明示してあるものは、値をテキストに変換して返します。 JSON入力が要求と一致する正しい構造をしていなければ、フィールド/要素/パス抽出演算子は失敗するのではなくNULLを返します。例えばそのような要素が存在しない場合です。 JSON配列の添字を整数で受け取り、フィールド、要素、パスを返す演算子はすべて、配列の終わりから数える負の添字をサポートします。

表9.1「比較演算子」に示されている標準の比較演算子がjsonbで利用可能ですが、jsonではそうではありません。 それらは8.14.4. jsonb インデックスで概略を述べたB-tree演算子の順序規則に従います。

ほかにjsonbだけで利用可能な演算子もいくつか存在します。 それらを表9.41「追加jsonb演算子」に示します。 これらのうち多くの演算子はjsonb演算子クラスでインデックス付けすることが可能です。 jsonbの包含と存在の意味に関する完全な記述は8.14.3. jsonb型用包含演算子と存在演算子を参照してください。 8.14.4. jsonb インデックスには、jsonbデータを効率的にインデックス付けするためにこれらの演算子をどのように利用できるかについて書いてあります。

表9.41 追加jsonb演算子

演算子右オペランド型説明
@>jsonb左のJSON値はトップレベルにおいて右のJSONパスまたは値を包含するか'{"a":1, "b":2}'::jsonb @> '{"b":2}'::jsonb
<@jsonb左のJSONパスまたは値は右のJSON値にトップレベルで包含されるか'{"b":2}'::jsonb <@ '{"a":1, "b":2}'::jsonb
?text文字列はJSON値のトップレベルのキーとして存在するか'{"a":1, "b":2}'::jsonb ? 'b'
?|text[]配列の文字列のいずれかがトップレベルのキーとして存在するか。'{"a":1, "b":2, "c":3}'::jsonb ?| array['b', 'c']
?&text[]配列の文字列のすべてがトップレベルのキーとして存在するか。'["a", "b"]'::jsonb ?& array['a', 'b']
||jsonb2つのjsonb値を結合して、新しいjsonb値を作る'["a", "b"]'::jsonb || '["c", "d"]'::jsonb
-text左のオペランドからキー/値のペア、あるいは文字列要素を削除する。 キー/値のペアはキーの値に基づいてマッチされる。'{"a": "b"}'::jsonb - 'a'
-integer指定した添字の配列要素を削除する(負数の場合は後ろから数えます)。 トップレベルのコンテナが配列でないときはエラーが発生する。'["a", "b"]'::jsonb - 1
#-text[]指定したパスのフィールドまたは要素を削除する(JSON配列では、負数は後ろから数えます)'["a", {"b":1}]'::jsonb #- '{1,b}'

注記

||演算子は、両オペランドのトップレベルで要素を結合します。 再帰的には作用しません。 例えば、両方のオペランドが同じキーフィールド名のオブジェクトの場合、そのフィールドの値は、単に右側のオペランドの値になります。

表9.42「JSON作成関数」に、JSON値およびjsonb値を作成するために利用可能な関数を示します。 (row_to_json関数およびarray_to_json関数と同等なjsonbの関数はありません。 しかし、to_jsonbを使えば、これらの関数と同じ機能を提供できるでしょう。)

表9.42 JSON作成関数

関数説明例の結果

to_json(anyelement)

to_jsonb(anyelement)

jsonあるいはjsonbとして値を返す。 配列と複合型は(再帰的に)配列とオブジェクトに変換される。 あるいは、その型からjsonにキャストがあれば、キャスト関数が変換のために用いられる。 そうでなければ、スカラ値が生成される。 数値、論理値、またはNULL値以外のスカラ型に対しては、有効なjson値あるいはjsonb値となる形式の文字列表現が使用される。 to_json('Fred said "Hi."'::text)"Fred said \"Hi.\""
array_to_json(anyarray [, pretty_bool]) 配列をJSON配列として返す。 PostgreSQLの多次元配列はJSON配列の配列となる。 pretty_boolが真の場合、次元数-1の要素の間に改行が加えられる。 array_to_json('{{1,5},{99,100}}'::int[])[[1,5],[99,100]]
row_to_json(record [, pretty_bool]) 行をJSONオブジェクトとして返す。 pretty_boolが真の場合、レベル-1の要素の間に改行が加えられる。 row_to_json(row(1,'foo')){"f1":1,"f2":"foo"}

json_build_array(VARIADIC "any")

jsonb_build_array(VARIADIC "any")

異なる型から構成される可能性のあるJSON配列をvariadic引数リストから作成。 json_build_array(1,2,'3',4,5)[1, 2, "3", 4, 5]

json_build_object(VARIADIC "any")

jsonb_build_object(VARIADIC "any")

variadic引数リストからJSONオブジェクトを作成。 慣例により引数リストはキーと値が交互に並んだもの。 json_build_object('foo',1,'bar',2){"foo": 1, "bar": 2}

json_object(text[])

jsonb_object(text[])

テキスト配列からJSONオブジェクトを作成。 配列は、偶数個の要素からなる1次元(キー/値の対が交互に並んでいるものと扱われる))あるいは内側の配列が2つの要素を持つ2次元(2つの要素がキー/値の対として扱われる)のいずれかでなければならない。

json_object('{a, 1, b, "def", c, 3.5}')

json_object('{{a, 1},{b, "def"},{c, 3.5}}')

{"a": "1", "b": "def", "c": "3.5"}

json_object(keys text[], values text[])

jsonb_object(keys text[], values text[])

この形のjson_objectは2つの別々の配列からキーと値の対を取る。 他の点ではすべて、引数1つの形と同じ。 json_object('{a, b}', '{1,2}'){"a": "1", "b": "2"}

注記

array_to_jsonrow_to_jsonは表示を整えるオプションを提供する以外はto_jsonと同様の振舞いをします。 同様にto_jsonに書かれた振舞いはJSON作成関数により変換された個々の値に適用されます。

注記

hstore拡張はhstoreからjsonへのキャストを含みます。従って、JSON作成関数で変換されたhstore値は元の文字列値ではなくJSONオブジェクトとして示されます。

表9.43「JSON処理関数」jsonjsonb値を処理するのに使える関数を示します。

表9.43 JSON処理関数

関数戻り値型説明例の結果

json_array_length(json)

jsonb_array_length(jsonb)

int JSON配列の最も外側の要素の数を返す。 json_array_length('[1,2,3,{"f1":1,"f2":[5,6]},4]')5

json_each(json)

jsonb_each(jsonb)

setof key text, value json

setof key text, value jsonb

JSONオブジェクトの最も外側をkey/valueの組み合わせに拡張する。 select * from json_each('{"a":"foo", "b":"bar"}')
 key | value
-----+-------
 a   | "foo"
 b   | "bar"

json_each_text(json)

jsonb_each_text(jsonb)

setof key text, value text JSONオブジェクトの最も外側をkey/valueの組み合わせに拡張する。返り値は型textselect * from json_each_text('{"a":"foo", "b":"bar"}')
 key | value
-----+-------
 a   | foo
 b   | bar

json_extract_path(from_json json, VARIADIC path_elems text[])

jsonb_extract_path(from_json jsonb, VARIADIC path_elems text[])

json

jsonb

path_elemsで示されたJSONオブジェクトを返す(#>と同じ)。 json_extract_path('{"f2":{"f3":1},"f4":{"f5":99,"f6":"foo"}}','f4'){"f5":99,"f6":"foo"}

json_extract_path_text(from_json json, VARIADIC path_elems text[])

jsonb_extract_path_text(from_json jsonb, VARIADIC path_elems text[])

text path_elemsで示されたJSONオブジェクトをtextとして返す(#>>演算子と同じ)。 json_extract_path_text('{"f2":{"f3":1},"f4":{"f5":99,"f6":"foo"}}','f4', 'f6')foo

json_object_keys(json)

jsonb_object_keys(jsonb)

setof text 最も外側のJSONオブジェクトの中のキーの集合を返す。 json_object_keys('{"f1":"abc","f2":{"f3":"a", "f4":"b"}}')
 json_object_keys
------------------
 f1
 f2

json_populate_record(base anyelement, from_json json)

jsonb_populate_record(base anyelement, from_json jsonb)

anyelementfrom_json内のオブジェクトを行をbaseで定義されたレコード型に一致する列に拡張する(以下の注意書きを参照)。 select * from json_populate_record(null::myrowtype, '{"a":1,"b":2}')
 a | b
---+---
 1 | 2

json_populate_recordset(base anyelement, from_json json)

jsonb_populate_recordset(base anyelement, from_json jsonb)

setof anyelementfrom_jsonにおけるオブジェクトの最も外側の配列をbaseで定義されたレコード型に一致する列を持つ行の集合に展開する(以下の注意書き参照)。 select * from json_populate_recordset(null::myrowtype, '[{"a":1,"b":2},{"a":3,"b":4}]')
 a | b
---+---
 1 | 2
 3 | 4

json_array_elements(json)

jsonb_array_elements(jsonb)

setof json

setof jsonb

JSON配列をJSON値の集合に展開する。 select * from json_array_elements('[1,true, [2,false]]')
   value
-----------
 1
 true
 [2,false]

json_array_elements_text(json)

jsonb_array_elements_text(jsonb)

setof textJSON配列をtext値の集合に展開する。 select * from json_array_elements_text('["foo", "bar"]')
   value
-----------
 foo
 bar

json_typeof(json)

jsonb_typeof(jsonb)

text最も外側のJSON値の型をテキスト文字列として返す。 取りうる型はobjectarraystringnumberbooleannullである。 json_typeof('-123.4')number

json_to_record(json)

jsonb_to_record(jsonb)

recordJSONオブジェクトから任意のレコードを作成する(下記の注釈を参照)。 recordを返す関数すべてと同様、呼び出し側がAS句でレコードの構造を明示的に決める必要がある。 select * from json_to_record('{"a":1,"b":[1,2,3],"c":"bar"}') as x(a int, b text, d text)
 a |    b    | d
---+---------+---
 1 | [1,2,3] |

json_to_recordset(json)

jsonb_to_recordset(jsonb)

setof recordオブジェクトの配列のJSONから任意のレコードの集合を作成する(下記の注釈を参照)。 recordを返す関数すべてと同様、呼び出し側がAS句でレコードの構造を明示的に決める必要がある。 select * from json_to_recordset('[{"a":1,"b":"foo"},{"a":"2","c":"bar"}]') as x(a int, b text);
 a |  b
---+-----
 1 | foo
 2 |

json_strip_nulls(from_json json)

jsonb_strip_nulls(from_json jsonb)

json

jsonb

NULL値を持つオブジェクトフィールドを削除したfrom_jsonを返す。 他のNULL値はそのまま残る。 json_strip_nulls('[{"f1":1,"f2":null},2,null,3]')[{"f1":1},2,null,3]

jsonb_set(target jsonb, path text[], new_value jsonb[, create_missing boolean])

jsonb

pathで指定した部分をnew_valueで置換、 あるいはcreate_missingが真(デフォルトはtrue)でpathで指定した項目が存在しないならnew_valueを追加して、 targetを返す。 パスの位置についての演算子について、pathの中にある負の整数はJSON配列の終わりから数える。

jsonb_set('[{"f1":1,"f2":null},2,null,3]', '{0,f1}','[2,3,4]', false)

jsonb_set('[{"f1":1,"f2":null},2]', '{0,f3}','[2,3,4]')

[{"f1":[2,3,4],"f2":null},2,null,3]

[{"f1": 1, "f2": null, "f3": [2, 3, 4]}, 2]

jsonb_pretty(from_json jsonb)

text

from_jsonをインデントしたJSON文字列にして返す。 jsonb_pretty('[{"f1":1,"f2":null},2,null,3]')
[
    {
        "f1": 1,
        "f2": null
    },
    2,
    null,
    3
]

注記

これらの多くの関数や演算子は、JSON文字列のUnicodeのエスケープを適切な一文字に変換します。 これは入力がjsonb型であれば、変換は既に行なわれていますので、重要な問題ではありません。しかし、jsonの入力に対しては、8.14. JSONデータ型で言及したようにこれはエラーを発生させる結果になるかもしれません.

注記

json_populate_recordjson_populate_recordsetjson_to_recordおよびjson_to_recordsetにおけるJSONからの型強制は最善努力であり、ある型では望んだ結果にならないかもしれません。 JSONキーは対象の行の型の中の同一の列の名前と一致します。 対象の行の型に現れないJSONフィールドは出力から省略され、JSONフィールドに一致しない対象の列は単にNULLになります。

注記

create_missingが真でないときは、jsonb_setpathパラメータのすべての項目がtarget内に存在しなければなりません。 create_missingが真なら、最後の項目を除き、すべての項目が存在しなければなりません。 これらの条件が満たされなければ、targetが変更されずに返されます。

パスの最後の要素がオブジェクトのキーの場合、それが存在しなければ作成されて、新しい値が与えられます。 パスの最後の項目が配列の添字の場合、それが正ならセットすべき項目は左から数えられ、負なら右から数えられます(-1は最も右側の要素を指す、という具合です)。 項目が[-array_length .. array_length -1]の範囲外にあり、かつcreate_missingが真なら、新しい値が配列の先頭(項目が負数のとき)あるいは配列の終わり(項目が正数のとき)に追加されます。

注記

json_typeofnull戻り値をSQLのNULLと混同してはいけません。 json_typeof('null'::json)を呼び出すとnullが返りますが、json_typeof(NULL::json)を呼び出すとSQLのNULLが返ります。

注記

json_strip_nullsの引数で、オブジェクト内にフィールド名が重複しているものがある場合、それが発生している順序によって、結果は意味的にやや異なるものになることがあります。 jsonb値はオブジェクトのフィールド名が重複することがないので、jsonb_strip_nullsにはこのような問題はありません。

レコードの値をJSONに集約するjson_agg集約関数、値の対をJSONオブジェクトに集約するjson_object_agg集約関数、およびそれらのjsonb版のjsonb_aggjsonb_object_aggについては9.20. 集約関数を参照して下さい。