PostgreSQLLa base de données la plus sophistiquée au monde.

Version anglaise

9.15. Fonctions et opérateurs JSON

Tableau 9.40, « Opérateurs json et jsonb » montre les opérateurs disponibles avec des données des deux types JSON (voir Section 8.14, « Types JSON »).

Tableau 9.40. Opérateurs json et jsonb

Opérateur Type de l'opérande droit Description Exemple Résultat de l'exemple
-> int Obtient un élément du tableau JSON (indexé à partir de zéro) '[{"a":"foo"},{"b":"bar"},{"c":"baz"}]'::json->2 {"c":"baz"}
-> text Obtient un champ de l'objet JSON par sa clé '{"a": {"b":"foo"}}'::json->'a' {"b":"foo"}
->> int Obtient un élément du tableau JSON en tant que text '[1,2,3]'::json->>2 3
->> text Obtient un champ de l'objet JSON en tant que text '{"a":1,"b":2}'::json->>'b' 2
#> text[] Obtient un objet JSON à partir du chemin spécifié '{"a": {"b":{"c": "foo"}}}'::json#>'{a,b}' {"c": "foo"}
#>> text[] Obtient un objet JSON à partir du chemin spécifié en tant que text '{"a":[1,2,3],"b":[4,5,6]}'::json#>>'{a,2}' 3

[Note]

Note

Il existe des variantes de ces opérateurs pour les types json et jsonb. Les opérateurs d'extraction de champ/élément/chemin renvoient le même type de données que l'élément à gauche (soit json soit jsonb), sauf pour ceux indiquant renvoyer du text, qui forcera la conversion vers le type text. Les opérateurs d'extraction de champ/élément/chemin renvoient NULL, plutôt que d'échouer, si la valeur JSON en entrée n'a pas la structure correspondant à la demande ; par exemple si un tel élément n'existe pas.

Les opérateurs de comparaison standards montrés dans Tableau 9.1, « Opérateurs de comparaison » sont disponibles pour le type jsonb, mais pas pour le type json. Ils suivent les règles de tri des opérations B-tree soulignées dans Section 8.14.4, « Indexation jsonb ».

Des opérateurs supplémentaires existent seulement pour le type jsonb, comme indiqué dans Tableau 9.41, « Opérateurs jsonb supplémentaires ». Plusieurs de ces opérateurs peuvent être indexés par les classes d'opérateur jsonb. Pour une description complète du contenant jsonb et des émantiques, voir Section 8.14.3, « Existence et inclusion jsonb ». Section 8.14.4, « Indexation jsonb » décrit comment ces opérateurs peuvent être utilisés pour indexer efficacement les données de type jsonb.

Tableau 9.41. Opérateurs jsonb supplémentaires

Opérateur Type de l'opérande droit Description Exemple
@> jsonb Est-ce que la valeur JSON à gauche contient la valeur de droite ? '{"a":1, "b":2}'::jsonb @> '{"b":2}'::jsonb
<@ jsonb Est-ce que la valeur JSON de gauche est contenue dans la valeur de droite ? '{"b":2}'::jsonb <@ '{"a":1, "b":2}'::jsonb
? text Est-ce que la chaîne clé/élément existe dans la valeur JSON ? '{"a":1, "b":2}'::jsonb ? 'b'
?| text[] Est-ce qu'une des chaînes clé/élément existent ? '{"a":1, "b":2, "c":3}'::jsonb ?| array['b', 'c']
?& text[] Est-ce que toutes les chaînes clé/élément existent ? '["a", "b"]'::jsonb ?& array['a', 'b']

Tableau 9.42, « Fonctions de création de données JSON » montre les fonctions disponibles pour la création de valeurs json. (Il n'existe actuellement pas de fonctions équivalentes pour le type jsonb, mais vous pouvez convertir le résultat d'une de ces fonctions en jsonb.)

Tableau 9.42. Fonctions de création de données JSON

Fonction Description Exemple Exemple du résultat
to_json(anyelement) Renvoie la valeur sous la forme d'un JSON. Les tableaux et valeurs compositent sont convertis (récursivement) en tableaux et objets. Dans le cas contraire, s'il existe une conversion de ce type vers le type json, la fonction de conversion sera utilisée pour réaliser la conversion. Dans les autres cas, un scalaire JSON est produit. Pour tout type scalaire autre qu'un nombre, un booléen ou une valeur NULL, la représentation textuelle sera utilisée, mise entre guillemets et/ou échappée si nécessaire, pour que la chaîne de texte JSON soit valide. to_json('Fred said "Hi."'::text) "Fred said \"Hi.\""
array_to_json(anyarray [, pretty_bool]) json Renvoie le tableau sous la forme d'un tableau JSON. Un tableau PostgreSQL multi-dimensionnel devient un tableau JSON de tableaux. Des retours à la ligne seront ajoutés entre les éléments de la première dimension si pretty_bool vaut true. array_to_json('{{1,5},{99,100}}'::int[]) [[1,5],[99,100]]
row_to_json(record [, pretty_bool]) json Renvoie la ligne sous la forme d'un objet JSON. Des retours à la ligne seront ajoutés entre les éléments du niveau 1 si pretty_bool vaut true. row_to_json(row(1,'foo')) {"f1":1,"f2":"foo"}
json_build_array(VARIADIC "any") json Construit un table JSON de type possiblement hétérogène à partir d'une liste d'arguments variables. json_build_array(1,2,'3',4,5) [1, 2, "3", 4, 5]
json_build_object(VARIADIC "any") int Construit un objet JSON à partir d'une liste d'arguments variables. Par convention, la liste d'arguments consiste en des clés et valeurs en alternance. json_build_object('foo',1,'bar',2) {"foo": 1, "bar": 2}
json_object(text[]) Construit un objet JSON à partir d'un tableau de textes. Le tableau doit avoir soit exactement une dimension avec un nombre pair de membres, auquel cas ils sont pros comme des paires clé/valeur en alternance, soit deux dimensions, de telle façon que chaque tableau interne contient exactement deux éléments, qui sont pris sous la forme d'une paire clé/valeur.

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[]) Cette forme de json_object prend des clés et valeurs sous forme de paires à partir de deux tableaux séparés. Tous les autres aspects sont identiques à la fonction avec un seul argument. json_object('{a, b}', '{1,2}') {"a": "1", "b": "2"}

[Note]

Note

array_to_json et row_to_json ont le même comportement que to_json, en dehors du fait qu'elles ne proposent pas d'option d'affichage propre. Le comportement décrit pour to_json s'applique à chaque valeur individuelle convertie par les autres fonctions de création JSON.

[Note]

Note

L'extension hstore dispose d'une conversion du type hstore vers le type json, pour que les valeurs hstore converties via les fonctions de création JSON seront représentées en tant qu'objets JSON et non pas en tant que les valeurs des chaînes de caractères habituelles.

Tableau 9.43, « Fonctions de traitement du JSON » montre les fonctions disponibles pour le traitement des valeurs json et jsonb.

Tableau 9.43. Fonctions de traitement du JSON

Fonction Type renvoyé Description Exemple Exemple de résultat

json_array_length(json)

jsonb_array_length(jsonb)

int Renvoie le nombre d'éléments dans le tableau JSON externe. 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

SETOF key text, value json Étend l'objet JSON extérieur en un ensemble de paires clé/valeur. 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 Étend l'objet JSON externe en un ensemble de paires clé/valeur. La valeur renvoyée est de type text. select * 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

json Renvoie l'objet JSON pointé par path_elems (equivalent to #> operator). 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 Renvoie l'objet JSON pointé par path_elems as text (equivalent to #>> operator). 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 Renvoie l'ensemble de clés de l'objet externe 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)

anyelement Étend l'objet dans from_json en une ligne dont les colonnes correspondent au type d'enregistrement défini par base (voir la note ci-dessous). 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 anyelement Étend le tableau externe d'objets dans from_json en un ensemble de lignes dont les colonnes correspondent au type d'enregistrement défini par base (voir la note ci-dessous). 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

Étend un tableau JSON en un ensemble de valeurs 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 text Étend un tableau JSON en un ensemble de valeurs text. select * from json_array_elements_text('["foo", "bar"]')
   value
-----------
 foo
 bar
                

json_typeof(json)

jsonb_typeof(jsonb)

text Renvoie le type de la valeur externe du JSON en tant que chaîne de type text. Les types possibles sont object, array, string, number, boolean et null. json_typeof('-123.4') number

json_to_record(json)

jsonb_to_record(jsonb)

record Construit un enregistrement arbitraire à partir d'un objet JSON (voir la note ci-dessous). Comme avec toutes les fonctions renvoyant le type record, l'appelant doit définir explicitement la structure du type record avec une clause 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 Construit un ensemble arbitraire d'enregistrements à partir d'un tableau JSON d'objets (voir la note ci-dessous). Comme avec toutes les fonctions renvoyant le type record, l'appelant doit définir explicitement la structure du type record avec une clause 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 |
                

[Note]

Note

Un grand nombre de ces fonctions et opérateurs convertiront les échappements Unicode en chaînes JSON avec le caractère approprié. Ce n'est pas un problème si la valeur en entrée est de type jsonb parce que la conversion est déjà faite. Par contre, pour une valeur de type json, cela pourrait résulter par le renvoi d'une erreur comme indiqué dans Section 8.14, « Types JSON ».

[Note]

Note

Dans json_populate_record, json_populate_recordset, json_to_record et json_to_recordset, la coercion de type à partir de JSON est fait sur le principe du « meilleur effort » et pourrait ne pas résulter en les valeurs souhaitées pour certains types. Les clés JSON sont comparées aux colonnes de même nom dans le type row cible. Les champs JSON qui n'apparaissent pas dans le type row cible seront omis de la sortie, et les colonnes cibles qui ne correspondent à aucun champ JSON auront simplement pour valeur NULL.

[Note]

Note

La valeur de retour null de la fonction json_typeof ne doit pas être confondue avec la valeur SQL NULL. Bien qu'appeler json_typeof('null'::json) renverra null, appeler json_typeof(NULL::json) renverra un NULL au sens SQL.

Voir aussi Section 9.20, « Fonctions d'agrégat » pour la fonction d'agrégat json_agg qui agrège les valeurs en tant que JSON, et la fonction d'agrégat json_object_agg qui agrège les paires de valeurs en un objet JSON.