Tair (Redis® OSS-Compatible):Doc

Prérequis

Avant de commencer, assurez-vous de disposer des éléments suivants :

• Une instance Tair basée sur DRAM

• Version mineure de l'instance 1.8.4 ou ultérieure (requise pour la prise en charge complète de JSONPath via JSON.GET)

Pour mettre à jour votre instance vers la dernière version mineure, consultez la rubrique Mettre à jour la version mineure d'une instance.

Pour les instances en cluster ou avec répartition lecture/écriture, mettez à jour les nœuds proxy vers la dernière version mineure afin de garantir le bon fonctionnement de toutes les commandes.

Liste des commandes

Conventions de syntaxe utilisées dans cette référence :

• MAJUSCULES : mot-clé de commande

• _italique_ : variable

• [option] : paramètre facultatif

• A | B : options mutuellement exclusives

• ... : le paramètre peut être répété

JSON.SET

Syntaxe : JSON.SET clé chemin json [NX | XX]

Crée une clé TairDoc et stocke un élément JSON au chemin spécifié. Si la clé et le chemin existent déjà, met à jour l'élément.

Paramètres :

Valeurs de retour :

Exemple — créer un document JSON :

La commande suivante crée une clé doc au chemin racine ($) et stocke un document de librairie contenant quatre livres et un vélo :

JSON.SET doc $ '{ "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 }, { "category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99 }, { "category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }'

Sortie attendue :

OK

JSON.GET

Syntaxe : JSON.GET clé chemin [FORMAT XML | YAML] [ROOTNAME racine] [ARRNAME tab]

Récupère l'élément JSON au chemin spécifié. Prend en charge les syntaxes JSONPath et JSON Pointer.

Paramètres :

Valeurs de retour :

Exemple — récupérer un document au format XML :

Tout d'abord, créez le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Ensuite, récupérez-le au format XML, en spécifiant ROOT comme nom de balise racine et ARR comme nom de balise de tableau :

JSON.GET doc . FORMAT XML ROOTNAME ROOT ARRNAME ARR

Sortie attendue :

"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ROOT><foo>bar</foo><baz>42</baz></ROOT>"

JSON.DEL

Syntaxe : JSON.DEL clé chemin

Supprime l'élément JSON au chemin spécifié. Si aucun chemin n'est indiqué, supprime la clé entière. Ne fait rien silencieusement si la clé ou le chemin n'existe pas.

Paramètres :

Valeurs de retour :

Exemple — supprimer un champ :

Tout d'abord, créez le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Supprimez le champ foo :

JSON.DEL doc .foo

Sortie attendue — 1 indique que l'élément a été supprimé :

(integer) 1

JSON.TYPE

Syntaxe : JSON.TYPE key path

Renvoie le type de l'élément JSON situé au chemin spécifié.

Paramètres :

Valeurs de retour :

Exemple — obtenir le type d'un champ :

Commencez par créer le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Obtenez le type du champ foo ("bar" est une chaîne de caractères) :

JSON.TYPE doc .foo

Sortie attendue :

string

JSON.MERGE

Syntaxe : JSON.MERGE key path value

Fusionne une valeur JSON dans le chemin spécifié. Cette commande permet d'ajouter de nouvelles valeurs, de mettre à jour des valeurs existantes et de supprimer des valeurs au niveau du chemin indiqué.

Paramètres :

Valeurs de retour :

Exemple — ajouter, mettre à jour et supprimer des valeurs en une seule opération :

Commencez par créer le document :

JSON.SET doc $ '{"f1": {"a":1}, "f2":{"a":2}}'

Fusionnez les modifications : définissez f1 sur null (ce qui le supprime), mettez à jour f2.a et ajoutez f2.b, puis ajoutez un nouveau tableau f3 :

JSON.MERGE doc $ '{"f1": null, "f2":{"a":3, "b":4}, "f3":[2,4,6]}'

Sortie attendue :

OK

Vérifiez le résultat avec JSON.GET doc .. La clé f1 est supprimée, car définir un champ sur null dans un correctif de fusion entraîne sa suppression :

"{\"f2\":{\"a\":3,\"b\":4},\"f3\":[2,4,6]}"

JSON.NUMINCRBY

Syntaxe : JSON.NUMINCRBY key path value

Incrémente l'élément JSON numérique situé au chemin spécifié. L'élément existant et la valeur d'incrément doivent être du même type, soit entier, soit double.

Paramètres :

Valeurs de retour :

Exemple — incrémenter un champ numérique :

Commencez par créer le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Incrémentez baz de 10 (42 + 10 = 52) :

JSON.NUMINCRBY doc .baz 10

Sortie attendue :

"52"

JSON.STRAPPEND

Syntaxe : JSON.STRAPPEND key path json-string

Ajoute une chaîne à l'élément de chaîne JSON situé au chemin spécifié. L'élément existant et la valeur ajoutée doivent tous deux être de type string.

Paramètres :

Valeurs de retour :

Exemple — ajouter du texte à un champ de chaîne :

Commencez par créer le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Ajoutez rrrrr à foo : "bar" devient "barrrrrr", soit 8 caractères :

JSON.STRAPPEND doc .foo rrrrr

Sortie attendue :

(integer) 8

JSON.STRLEN

Syntaxe : JSON.STRLEN key path

Renvoie la longueur en caractères de l'élément de chaîne JSON situé au chemin spécifié. L'élément doit être de type string.

Paramètres :

Valeurs de retour :

Exemple — obtenir la longueur d'un champ de chaîne :

Commencez par créer le document :

JSON.SET doc . '{"foo": "bar", "baz" : 42}'

Obtenez la longueur de foo : "bar" contient 3 caractères :

JSON.STRLEN doc .foo

Sortie attendue :

(integer) 3

JSON.ARRAPPEND

Syntaxe : JSON.ARRAPPEND key path json [json ...]

Ajoute un ou plusieurs éléments JSON à la fin d'un tableau. La complexité temporelle est de O(M×N), où M représente le nombre d'éléments à ajouter et N la longueur actuelle du tableau.

Paramètres :

Valeurs de retour :

Exemple — ajouter plusieurs éléments à un tableau :

Commencez par créer le document :

JSON.SET doc . '{"id": [1,2,3]}'

Ajoutez null, false et true au tableau id. Le tableau passe de 3 à 6 éléments :

JSON.ARRAPPEND doc .id null false true

Sortie attendue :

(integer) 6

JSON.ARRPOP

Syntaxe : JSON.ARRPOP key path [index]

Supprime et renvoie l'élément situé à l'index spécifié dans un tableau. La complexité temporelle est de O(M×N), où M représente le nombre d'éléments enfants dans la clé et N la longueur du tableau.

Paramètres :

Valeurs de retour :

Exemple — supprimer le premier élément d'un tableau :

Commencez par créer le document :

JSON.SET doc . '{"id": [1,2,3]}'

Supprimez et renvoyez l'élément à l'index 0 (le premier élément, 1) :

JSON.ARRPOP doc .id 0

Sortie attendue :

"1"

JSON.ARRINSERT

Syntaxe : JSON.ARRINSERT key path [index] json [json ...]

Insère un ou plusieurs éléments JSON dans un tableau avant l'index spécifié. La complexité temporelle est de O(M×N), où M représente le nombre d'éléments à insérer et N la longueur actuelle du tableau.

Paramètres :

Valeurs de retour :

Exemple : insertion d'éléments au début d'un tableau

Commencez par créer le document :

JSON.SET doc . '{"id": [1,2,3]}'

Insérez 10 et 15 avant l'index 0. Le tableau résultant est [10, 15, 1, 2, 3] :

JSON.ARRINSERT doc .id 0 10 15

Sortie attendue :

(integer) 5

JSON.ARRLEN

Syntaxe : JSON.ARRLEN key path

Renvoie le nombre d'éléments contenus dans un tableau.

Paramètres :

Valeurs de retour :

Exemple : obtention de la longueur d'un tableau

Commencez par créer le document :

JSON.SET doc . '{"id": [1,2,3]}'

Obtenez le nombre d'éléments du tableau id :

JSON.ARRLEN doc .id

Sortie attendue :

(integer) 3

JSON.ARRTRIM

Syntaxe : JSON.ARRTRIM key path start stop

Découpe un tableau afin de ne conserver que les éléments situés dans la plage [start, stop] (bornes incluses). Tous les éléments extérieurs à cette plage sont supprimés.

Paramètres :

Valeurs de retour :

Exemple : découpage d'un tableau vers une sous-plage

Commencez par créer le document :

JSON.SET doc . '{"id": [1,2,3,4,5,6]}'

Découpez le tableau pour ne conserver que les éléments aux index 3 et 4 (valeurs 4 et 5). Les éléments situés en dehors de cette plage sont ignorés :

JSON.ARRTRIM doc .id 3 4

Sortie attendue — 2 éléments restent :

(integer) 2

JSONPath

La commande JSON.GET prend en charge la syntaxe du projet de norme JSONPath RFC draft-4 pour des requêtes flexibles. La prise en charge complète de JSONPath nécessite la version 1.8.4 ou ultérieure.

Sélecteurs pris en charge :

Exemples de requête :

Les exemples suivants utilisent ce document de librairie. Créez-le d'abord :

JSON.SET dockey $
'{
    "store": {
        "book": [{
                "category": "reference",
                "author": "Nigel Rees",
                "title": "Sayings of the Century",
                "price": 8.95
            },
            {
                "category": "fiction",
                "author": "Evelyn Waugh",
                "title": "Sword of Honour",
                "price": 12.99
            },
            {
                "category": "fiction",
                "author": "Herman Melville",
                "title": "Moby Dick",
                "isbn": "0-553-21311-3",
                "price": 8.99
            },
            {
                "category": "fiction",
                "author": "J. R. R. Tolkien",
                "title": "The Lord of the Rings",
                "isbn": "0-395-19395-8",
                "price": 22.99
            }
        ],
        "bicycle": {
            "color": "red",
            "price": 19.95
        }
    },
    "expensive": 10
}'

Résultat attendu :

OK

JSON.GET dockey $

"[{"store":{"book":[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99},{"category":"fiction","author":"J. R. R. Tolkien","title":"The Lord of the Rings","isbn":"0-395-19395-8","price":22.99}],"bicycle":{"color":"red","price":19.95}}}]"

JSON.GET dockey $.store.bicycle.*

"["red",19.95]"

JSON.GET dockey $.store.bicycle.price

"[19.95]"

JSON.GET dockey $.store.book[0]

"[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95}]"

JSON.GET dockey "$.store.book[*]['title']"

"["Sayings of the Century","Sword of Honour","Moby Dick","The Lord of the Rings"]"

JSON.GET dockey $.store.book[0:2:1]

"[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99},{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99}]"

JSON.GET dockey $..price

"[8.95,12.99,8.99,22.99,19.95]"

JSON.GET dockey $.store.book[0,2]

"[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]"

JSON.GET dockey $.store.book[?(@.isbn)]

"[{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99},{"category":"fiction","author":"J. R. R. Tolkien","title":"The Lord of the Rings","isbn":"0-395-19395-8","price":22.99}]"

JSON.GET dockey '$.store.book[?(@.price < 10)]'

"[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Herman Melville","title":"Moby Dick","isbn":"0-553-21311-3","price":8.99}]"

JSON.GET dockey "$..book[?((@.price == 12.99 || @.price > $.store.bicycle.price) || @.category == 'reference')]"

"[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"J. R. R. Tolkien","title":"The Lord of the Rings","isbn":"0-395-19395-8","price":22.99},{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99}]"

Pointeur JSON

TairDoc prend entièrement en charge la syntaxe JSON Pointer (RFC 6901). Utilisez des chemins délimités par / pour naviguer dans un document.

Exemple : récupération d'un élément de tableau imbriqué :

Commencez par créer le document :

JSON.SET doc . '{"foo": "bar", "baz" : [1,2,3]}'

Récupérez le premier élément du tableau baz à l'aide du chemin JSON Pointer /baz/0 :

JSON.GET doc /baz/0

Résultat attendu :

"1"