✎ json_query [Wiki ubuntu-fr]

Vous affichez une ancienne révision du document ! Si vous l'enregistrez, vous créerez une nouvelle version avec ce contenu.

----

====== JSON Query (jq) ======

Cette commande est utilisée en [[:tutoriel/console_ligne_de_commande|ligne de commande]] pour mettre en forme du code [[wpfr>JavaScript_Object_Notation|JSON]] et n'afficher qu'une partie des enregistrements et/ou attributs.\\
Elle est particulièrement intéressante avec la commande //cUrl// lors d'exécution de tests en [[:CLI|ligne de commande]] pour par exemple questionner une base de données, notamment via une **API REST**

===== Installation =====

Installer avec les [[:sudo|droits d'administration]] le paquet jq
<code bash>
apt install jq
</code>

===== Utilisation =====
On peut l'utiliser simplement :
<code bash>
curl service:<port>/<table_ou_vue> | jq
</code>

On peut aussi ne récupérer qu'un attribut (dans le cas où seule une liste sans clé supérieure est retournée, sinon reportez-vous à l'exemple concret plus pas) :
<code bash>
curl service:<port>/<table_ou_vue> | jq '.[] | .mon_attribut'
</code>

Et on peut ne prendre que certains enregistrements, par exemple, si vous avez 10 enregistrements, pour voir les données que du 3ème et 4ème :
<code bash>
curl service:<port>/<table_ou_vue> | jq '.[3:5]'
</code>

ou des deux derniers :
<code bash>
curl service:<port>/<table_ou_vue> | jq '.[-2:]'
</code>

===== Exemples =====
==== avec le serveur de test JSONPlaceholder ====
Pour réaliser des tests, si vous ne disposer pas de serveur REST, vous pouvez utiliser le serveur [[https://jsonplaceholder.typicode.com|JSONPlaceholder]] qui propose de fausses données juste pour test,\\
ci-dessous récupération de 2 utilisateur (remarquer l'option //_limit=2// pour limiter le nombre de retour) :
<code bash>
curl https://jsonplaceholder.typicode.com/users?_limit=2 | jq
</code>
et si on ne souhaite ne récupérer que le nom auquel on concatène la ville ((src pour l'interpolation de chaîne de caractères : https://stackoverflow.com/a/71964370/6614155)) :
<code bash>
curl https://jsonplaceholder.typicode.com/users?_limit=2 | jq '.[] | "\(.name) \(.address.city)"'
</code>

==== avec le serveur Etalab ====
Pour extraire, à partir de l'[[https://adresse.data.gouv.fr/api-doc/adresse|API REST d'Etalab]], le nom d'une rue lyonnaise à partir de la chaîne //professeur// (et du code postal 69007), et ne récupérer que le premier retour (au cas où il y en aurait plusieurs)
<code bash>
curl "https://api-adresse.data.gouv.fr/search/?q=professeur&postcode=69007&limit=3" | jq '.features[0].properties.name'
# retourne :
"Rue Professeur Grignard"
</code>

==== avec un serveur elasticsearch exécuter sur votre poste/serveur ====
Autre exemple avec [[:elasticsearch]] en reprenant l'exemple autour des //movies// :
<code bash>
curl "localhost:9200/_search" -X GET -H "Content-Type: application/json" -d '{"query":{"match_all": {}}}' \
 | jq '.hits.hits[] | ._source.movies.title'
</code>

Source : [[https://dev-tips.com/tools/using-jq-to-filter-json-output]]

===== Voir aussi =====
  * (en) [[https://github.com/dominictarr/JSON.sh|parser JSON.sh]] pour "aplatir" une sortie JSON

----

//Contributeur : [[:utilisateurs/bcag2]]//

Merci de recopier le code ci-contre pour prouver que vous êtes humain : K P P X N Merci de laisser ce champ vide :

Résumé

Note : En modifiant cette page, vous acceptez que le contenu soit placé sous les termes de la licence suivante : CC Paternité-Partage des Conditions Initiales à l'Identique 3.0 Unported