valkey-json

This package provides support for the ValkeyJSON module, which adds JSON as a native data type to Valkey. It extends the Node Valkey client to include functions for each of the ValkeyJSON commands.

To use these extra commands, your Valkey server must have the ValkeyJSON module installed.

Usage

For a complete example, see managing-json.js in the Node Valkey examples folder.

Storing JSON Documents in Valkey

The JSON.SET command stores a JSON value at a given JSON Path in a Valkey key.

Here, we'll store a JSON document in the root of the Valkey key "mydoc":

1import { createClient } from 'valkey';
2
3...
4await client.json.set('nodevalkey:jsondata', '$', {
5  name: 'Roberta McDonald',
6  pets: [
7    {
8    name: 'Rex',
9    species: 'dog',
10    age: 3,
11    isMammal: true
12    },
13    {
14    name: 'Goldie',
15    species: 'fish',
16    age: 2,
17    isMammal: false
18    }
19  ]
20});

For more information about ValkeyJSON's path syntax, check out the documentation.

Retrieving JSON Documents from Valkey

With ValkeyJSON, we can retrieve all or part(s) of a JSON document using the JSON.GET command and one or more JSON Paths. Let's get the name and age of one of the pets:

1const results = await client.json.get('nodevalkey:jsondata', {
2  path: [
3    '.pets[1].name',
4    '.pets[1].age'
5  ]
6});

results will contain the following:

1 { '.pets[1].name': 'Goldie', '.pets[1].age': 2 }

Performing Atomic Updates on JSON Documents Stored in Valkey

ValkeyJSON includes commands that can atomically update values in a JSON document, in place in Valkey without having to first retrieve the entire document.

Using the JSON.NUMINCRBY command, we can update the age of one of the pets like this:

1await client.json.numIncrBy('nodevalkey:jsondata', '.pets[1].age', 1);

And we can add a new object to the pets array with the JSON.ARRAPPEND command:

1await client.json.arrAppend('nodevalkey:jsondata', '.pets', {
2  name: 'Robin',
3  species: 'bird',
4  age: 1,
5  isMammal: false
6});