Tair (Redis® OSS-Compatible):Doc

Requisitos previos

Antes de empezar, asegúrese de contar con lo siguiente:

• Una instancia basada en DRAM de Tair

• Versión secundaria de la instancia 1.8.4 o posterior (obligatoria para la compatibilidad total con JSONPath mediante JSON.GET)

Para actualizar su instancia a la última versión secundaria, consulte Actualizar la versión secundaria de una instancia.

En instancias de clúster o con división de lectura/escritura, actualice los nodos de proxy a la última versión secundaria para garantizar que todos los comandos funcionen correctamente.

Lista de comandos

Convenciones de sintaxis utilizadas en esta referencia:

• MAYÚSCULAS: palabra clave del comando

• _cursiva_: variable

• [opción]: parámetro opcional

• A | B: opciones mutuamente excluyentes

• ...: el parámetro se puede repetir

JSON.SET

Sintaxis: JSON.SET key path json [NX | XX]

Crea una clave de TairDoc y almacena un elemento JSON en la ruta especificada. Si la clave y la ruta ya existen, actualiza el elemento.

Parámetros:

Valores de retorno:

Ejemplo: crear un documento JSON:

El siguiente comando crea una clave doc en la ruta raíz ($) y almacena un documento de librería con cuatro libros y una bicicleta:

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 } } }'

Salida esperada:

OK

JSON.GET

Sintaxis: JSON.GET key path [FORMAT XML | YAML] [ROOTNAME root] [ARRNAME arr]

Recupera el elemento JSON en la ruta especificada. Admite tanto la sintaxis JSONPath como JSON Pointer.

Parámetros:

Valores de retorno:

Ejemplo: recuperar un documento como XML:

Primero, cree el documento:

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

Luego, recupérelo como XML y especifique ROOT como nombre de la etiqueta raíz y ARR como nombre de la etiqueta del arreglo:

JSON.GET doc . FORMAT XML ROOTNAME ROOT ARRNAME ARR

Salida esperada:

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

JSON.DEL

Sintaxis: JSON.DEL key path

Elimina el elemento JSON en la ruta especificada. Si no se proporciona ninguna ruta, elimina toda la clave. No realiza ninguna acción si la clave o la ruta no existen.

Parámetros:

Valores de retorno:

Ejemplo: eliminar un campo:

Primero, cree el documento:

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

Elimine el campo foo:

JSON.DEL doc .foo

Salida esperada: 1 indica que el elemento se eliminó:

(integer) 1

JSON.TYPE

Sintaxis: JSON.TYPE key path

Devuelve el tipo del elemento JSON en la ruta especificada.

Parámetros:

Valores de retorno:

Ejemplo: obtener el tipo de un campo:

Primero, cree el documento:

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

Obtenga el tipo del campo foo ("bar" es una cadena):

JSON.TYPE doc .foo

Salida esperada:

string

JSON.MERGE

Sintaxis: JSON.MERGE key path value

Combina un valor JSON en la ruta especificada. Permite agregar nuevos valores, actualizar valores existentes y eliminar valores en la ruta indicada.

Parámetros:

Valores de retorno:

Ejemplo: agregar, actualizar y eliminar valores en una sola operación:

Primero, cree el documento:

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

Combine los cambios: establezca f1 en null (lo elimina), actualice f2.a y agregue f2.b, además de añadir un nuevo arreglo f3:

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

Salida esperada:

OK

Compruebe el resultado con JSON.GET doc .. La clave f1 se elimina porque establecer un campo en null dentro de un parche de combinación lo borra:

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

JSON.NUMINCRBY

Sintaxis: JSON.NUMINCRBY key path value

Incrementa el elemento JSON numérico en la ruta especificada. Tanto el elemento existente como el valor de incremento deben ser del mismo tipo: entero o doble.

Parámetros:

Valores de retorno:

Ejemplo: incrementar un campo numérico:

Primero, cree el documento:

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

Incremente baz en 10 (42 + 10 = 52):

JSON.NUMINCRBY doc .baz 10

Salida esperada:

"52"

JSON.STRAPPEND

Sintaxis: JSON.STRAPPEND key path json-string

Agrega una cadena al final del elemento de cadena JSON en la ruta especificada. Tanto el elemento existente como el valor agregado deben ser del tipo string.

Parámetros:

Valores de retorno:

Ejemplo: agregar texto a un campo de cadena:

Primero, cree el documento:

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

Agregue rrrrr a foo: "bar" se convierte en "barrrrrr", que tiene 8 caracteres:

JSON.STRAPPEND doc .foo rrrrr

Salida esperada:

(integer) 8

JSON.STRLEN

Sintaxis: JSON.STRLEN key path

Devuelve la longitud en caracteres del elemento de cadena JSON en la ruta especificada. El elemento debe ser del tipo string.

Parámetros:

Valores de retorno:

Ejemplo: obtener la longitud de un campo de cadena:

Primero, cree el documento:

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

Obtenga la longitud de foo: "bar" tiene 3 caracteres:

JSON.STRLEN doc .foo

Salida esperada:

(integer) 3

JSON.ARRAPPEND

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

Agrega uno o más elementos JSON al final de un arreglo. La complejidad temporal es O(M×N), donde M es el número de elementos por agregar y N es la longitud actual del arreglo.

Parámetros:

Valores de retorno:

Ejemplo: agregar varios elementos a un arreglo:

Primero, cree el documento:

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

Agregue null, false y true al arreglo id. El arreglo pasa de 3 a 6 elementos:

JSON.ARRAPPEND doc .id null false true

Salida esperada:

(integer) 6

JSON.ARRPOP

Sintaxis: JSON.ARRPOP key path [index]

Extrae y devuelve el elemento en el índice especificado de un arreglo. La complejidad temporal es O(M×N), donde M es el número de elementos secundarios en la clave y N es la longitud del arreglo.

Parámetros:

Valores de retorno:

Ejemplo: extraer el primer elemento de un arreglo:

Primero, cree el documento:

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

Extraiga y devuelva el elemento en el índice 0 (el primer elemento, 1):

JSON.ARRPOP doc .id 0

Salida esperada:

"1"

JSON.ARRINSERT

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

Inserta uno o más elementos JSON en un arreglo antes del índice especificado. La complejidad temporal es O(M×N), donde M es el número de elementos por insertar y N es la longitud actual del arreglo.

Parámetros:

Valores de retorno:

Ejemplo: insertar elementos al inicio de un arreglo:

Primero, cree el documento:

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

Inserte 10 y 15 antes del índice 0. El arreglo resultante es [10, 15, 1, 2, 3]:

JSON.ARRINSERT doc .id 0 10 15

Salida esperada:

(integer) 5

JSON.ARRLEN

Sintaxis: JSON.ARRLEN key path

Devuelve el número de elementos en un arreglo.

Parámetros:

Valores de retorno:

Ejemplo: obtener la longitud de un arreglo:

Primero, cree el documento:

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

Obtenga el número de elementos en el arreglo id:

JSON.ARRLEN doc .id

Salida esperada:

(integer) 3

JSON.ARRTRIM

Sintaxis: JSON.ARRTRIM key path start stop

Recorta un arreglo para que solo permanezcan los elementos dentro del rango [start, stop] (inclusive). Todos los elementos fuera de este rango se eliminan.

Parámetros:

Valores de retorno:

Ejemplo: recortar un arreglo a un subrango:

Primero, cree el documento:

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

Recorte el arreglo para conservar solo los elementos en los índices 3 y 4 (valores 4 y 5). Los elementos fuera de este rango se descartan:

JSON.ARRTRIM doc .id 3 4

Salida esperada: permanecen 2 elementos:

(integer) 2

JSONPath

JSON.GET admite la sintaxis del borrador RFC-4 de JSONPath para realizar consultas flexibles. La compatibilidad total con JSONPath requiere la versión 1.8.4 o posterior.

Selectores admitidos:

Ejemplos de consultas:

Los siguientes ejemplos utilizan este documento de librería. Créelo primero:

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
}'

Salida esperada:

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}]"

JSON Pointer

TairDoc admite completamente la sintaxis de JSON Pointer (RFC 6901). Utilice rutas delimitadas por / para navegar dentro de un documento.

Ejemplo: recuperar un elemento anidado de un arreglo:

Primero, cree el documento:

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

Recupere el primer elemento del arreglo baz mediante la ruta JSON Pointer /baz/0:

JSON.GET doc /baz/0

Salida esperada:

"1"