@redis/json

npmpackage.info

Gathering detailed insights and metrics for @redis/json

Other packages similar to @redis/json

@redis/search

5.5.6

This package provides support for the [RediSearch](https://redis.io/docs/interact/search-and-query/) module, which adds indexing and querying support for data stored in Redis Hashes or as JSON documents with the [RedisJSON](https://redis.io/docs/data-type

@node-redis/json

1.0.2

This package provides support for the [RedisJSON](https://redisjson.io) module, which adds JSON as a native data type to Redis. It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RedisJSON command

@jsonjoy.com/json-pack

1.2.0

High-performance JSON serialization library

redis-json

6.0.3

A wrapper library to store JSON Objects in redis-hashsets and retrieve it back as JSON objects

Gathering detailed insights and metrics for @redis/json

Usage

Storing JSON Documents in Redis

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

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

1await client.json.set('noderedis:jsondata', '$', { 2 name: 'Roberta McDonald', 3 pets: [{ 4 name: 'Rex', 5 species: 'dog', 6 age: 3, 7 isMammal: true 8 }, { 9 name: 'Goldie', 10 species: 'fish', 11 age: 2, 12 isMammal: false 13 }] 14});

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

Retrieving JSON Documents from Redis

With RedisJSON, 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('noderedis: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 Redis

RedisJSON includes commands that can atomically update values in a JSON document, in place in Redis 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('noderedis: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('noderedis:jsondata', '.pets', { 2 name: 'Robin', 3 species: 'bird', 4 age: 1, 5 isMammal: false 6});

Other packages similar to @redis/json

Other packages similar to @redis/json

Installations

Developer Guide

Yes

CommonJS

>= 18

23.11.0

10.9.2

Score

Pull Requests

64

1,041

385

592

Issues

301

1,898

1,597

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

8.36 kB

1.63 kB

Maintainers

Package Meta Information

Total Downloads

227,290,579

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

@redis/json

Usage

Storing JSON Documents in Redis

Retrieving JSON Documents from Redis

Performing Atomic Updates on JSON Documents Stored in Redis

10

10

10

10

10

10

3

2

1

0

0

0

5.7

/10