Introduction to RedisJSON - The Perfect Combination for RediSearch

Introduction to RedisJSON - The Perfect Combination for RediSearch

Daily short news for you
  • For a long time, I have been thinking about how to increase brand presence, as well as users for the blog. After much contemplation, it seems the only way is to share on social media or hope they seek it out, until...

    Wearing this shirt means no more worries about traffic jams, the more crowded it gets, the more fun it is because hundreds of eyes are watching 🤓

    (It really works, you know 🤭)

    » Read more
  • A cycle of developing many projects is quite interesting. Summarized in 3 steps: See something complex -> Simplify it -> Add features until it becomes complex again... -> Back to a new loop.

    Why is that? Let me give you 2 examples to illustrate.

    Markdown was created with the aim of producing a plain text format that is "easy to write, easy to read, and easy to convert into something like HTML." At that time, no one had the patience to sit and write while also adding formatting for how the text displayed on the web. Yet now, people are "stuffing" or creating variations based on markdown to add so many new formats that… they can’t even remember all the syntax.

    React is also an example. Since the time of PHP, there has been a desire to create something that clearly separates the user interface from the core logic processing of applications into two distinct parts for better readability and writing. The result is that UI/UX libraries have developed very robustly, providing excellent user interaction, while the application logic resides on a separate server. The duo of Front-end and Back-end emerged from this, with the indispensable REST API waiter. Yet now, React doesn’t look much different from PHP, leading to Vue, Svelte... all converging back to a single point.

    However, the loop is not bad; on the contrary, this loop is more about evolution than "regression." Sometimes, it creates something good from something old, and people rely on that goodness to continue the loop. In other words, it’s about distilling the essence little by little 😁

    » Read more
  • Alongside the official projects, I occasionally see "side" projects aimed at optimizing or improving the language in some aspects. For example, nature-lang/nature is a project focused on enhancing Go, introducing some changes to make using Go more user-friendly.

    Looking back, it resembles JavaScript quite a bit 😆

    » Read more

The Problem

I recently wrote an article about using RediSearch as the main database on What is RediSearch? Estacks is using RediSearch as a database!. Along with that, I explained why I chose RediSearch for the full-text search feature in RediSearch, making the search functionality of my blog more powerful and useful for readers.

Everything is working great so far, but there's one problem - Redis does not have a JSON data type, and I want to work with JSON data in the most user-friendly way possible. During my research, I discovered that Redis provides a module called RedisJSON that allows me to do just that. If you are using Redis or RediSearch and want to work with JSON data, this is a fantastic solution.

What is RedisJSON?

RedisJSON is a module that provides JSON support for Redis. RedisJSON allows you to store, update, and retrieve JSON values in the Redis database just like any other Redis data type. RedisJSON also works with RediSearch, allowing you to index and query JSON documents.

127.0.0.1:6379> JSON.SET obj $ '{"title": "Hello Developers - What to Drink and Code Today?", "url": "https://2coffee.dev"}'
"OK"
127.0.0.1:6379> JSON.GET obj $
[{"title":"Hello Developers - What to Drink and Code Today?","url":"https://2coffee.dev"}]

Usage

To use RedisJSON, you need to install Redis v6.x on your server. Redis provides several different methods for loading the RedisJSON module. Two popular methods are:

  • Edit the redis.conf configuration file:
loadmodule /path/to/module/target/release/librejson.so
  • Use the Command-line:
$ redis-server --loadmodule /path/to/module/librejson.so

Where /path/to/module is the path to your Redis installation directory. For example:

$ redis-server --loadmodule /usr/lib/redis/module/librejson.so

For more details, you can refer to the official documentation page.

Basic Syntax

As mentioned above, RedisJSON provides us with many syntaxes to store, update, or retrieve JSON values.

127.0.0.1:6379> JSON.SET obj $.year 2022
OK
127.0.0.1:6379> JSON.SET obj $.users '["admin"]'
OK
127.0.0.1:6379> JSON.ARRAPPEND obj $.users '"hoaitx"'
2
127.0.0.1:6379> JSON.GET obj $
[{"title":"Hello Developers - What to Drink and Code Today?","url":"https://2coffee.dev","year":2022,"users":["admin","hoaitx"]}]
127.0.0.1:6379> JSON.DEL obj
"OK"

To see the complete list of JSON data manipulation commands, you can visit the Commands documentation page

Using with RediSearch

To use RedisJSON with RediSearch, you need to have RediSearch v2.2 or higher and RedisJSON v2.0 or higher installed on your Redis server.

Then, create a schema in RediSearch to serve the search:

127.0.0.1:6379> FT.CREATE article ON JSON PREFIX 1 article: SCHEMA $.title AS title TEXT $.content as content TEXT $.view AS view NUMERIC
OK

To add data to the Schema, use the JSON.SET command:

127.0.0.1:6379> JSON.SET article:1 $ '{"title": "2coffee", "content": "Hello Developers - What to Drink and Code Today?", "view": 0}'

Then, you can perform full-text search using RediSearch syntax:

127.0.0.1:6379> FT.SEARCH article '@title:%coffee%'
1
article:1000
$
{"title":"2coffee","content":"Hello Developers - What to Drink and Code Today?","view":0}

Starting from RediSearch 2.6.0, you can also perform full-text search on attributes that are an array of strings.

127.0.0.1:6379> JSON.SET article:1 $ '{"title": ["2coffee", "hicoffee"], "content": "Hello Developers - What to Drink and Code Today?", "view": 0}'
127.0.0.1:6379> FT.SEARCH article '@title:%coffee%'

Starting from RediSearch 2.6.1, you can perform search on attributes that are an array of numbers (NUMERIC).

127.0.0.1:6379> JSON.SET article:1 $ '{"title": ["2coffee", "hicoffee"], "content": "Hello Developers - What to Drink and Code Today?", "view": [0, 1, 2]}'
127.0.0.1:6379> FT.SEARCH article '@view:[0 1]'

The syntax above will return records with any value in view satisfying >= 0 and <= 1.

There are many other syntaxes to support indexing and searching documents, which you can explore in the official documentation.

Summary

If you are familiar with working with NoSQL, RedisJSON provides a convenient way to handle JSON data without worrying about data inconsistency. SQL databases have long integrated JSON data types, giving us more options in organizing data.

RedisJSON seamlessly integrates with RediSearch for indexing and searching, providing both storage convenience and the powerful full-text search capabilities of RediSearch and the speed of Redis. I'm using this trio of tools, what are your plans for upcoming projects? :D

Premium
Hello

The secret stack of Blog

As a developer, are you curious about the technology secrets or the technical debts of this blog? All secrets will be revealed in the article below. What are you waiting for, click now!

As a developer, are you curious about the technology secrets or the technical debts of this blog? All secrets will be revealed in the article below. What are you waiting for, click now!

View all

Subscribe to receive new article notifications

or
* The summary newsletter is sent every 1-2 weeks, cancel anytime.

Comments (3)

Leave a comment...
Avatar
Ẩn danh2 years ago

Hơi xi đa thằng redisearch này cú pháp các thứ hơi khó dùng

Reply
Avatar
Nguyễn Quang Tú2 years ago

Thằng này mà có orm thì ngon chứ mấy lib query raw mệt vãi

Reply
Avatar
Trần Ngọc Hải2 years ago

Redisearch có vẻ mạnh nhỉ thấy ad giới thiệu suốt

Reply
Avatar
Xuân Hoài Tống2 years ago

Đúng rồi nhanh mà nhẹ đó bạn