How to Run Redis Locally on a Docker Container and Manage it with Redis Insight

My journey with Redis started one story ago. In my previous story, I discussed 10 things you didn’t know about Redis and listed many of its powerful capabilities most people are unaware of.

I’m very interested in understanding and experimenting with Redis’ capabilities. This is another story of a series where I am documenting my experience with Redis. Join me in this adventure. 🙂

In this tutorial, you will learn how to run Redis locally alongside Redis Insight to manage its data and how to perform simple CRUD operations.

In addition, we will also see how we can perform the same operations using Redis CLI and how to connect to it from within the container.

Let’s put our hands in the fire!

Running Redis Server and Redis Insight

Starting a Redis Server locally is very easy, and running it with Redis Insight is even easier! For running them, we are going to use Docker and although we’re running both applications, I will leave the command to run only the server as well:

Only Redis Server

docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest

Redis Server + Redis Insight

docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest

We will see the image being downloaded, and when it finishes, we can see that the container is running by executing docker ps in our terminal and that it’s exposing ports 6379 and 8001 as defined by -p 6739:6379 -p 8001:8001:

Redis Insight

6379 is the port of our server and 8001 is the port of Redis Insight. We can connect to it by accessing localhost:8001

If we access it, we should see something like:

On the top right, you can see a few stats of the database. On the top left you can check your database details and in the center left you can see your list of key values and on the center-right, you can see the details of these key values.

Remembering that conceptually, Redis is based on the key-value database paradigm. Every piece of data is associated with a key, either directly or indirectly.

Adding a new key-value

To add a new key value, we need to click on the +key button.

Our first key is going to be of type hash. The TTL, which is the expiration for the key, is gonna be empty, which means it will never expire.

The key name is going to be RaphaelDeLio and then we are going to add some values associated with that key:

We can click on Add Key and we will see our key in the key list and the fields associated with it:

You can edit or delete any field, or even the key itself, by clicking on the pencils or bins next to them.

Redis CLI

Connecting to Redis CLI

In order to send commands to Redis, we need to connect to Redis CLI. Redis CLI is installed within the container, and we can access it by running the following command in our terminal:

docker exec -it redis-stack redis-cli

Adding a new key

To add a new key, we are going to use the HSET command. This command is specific for setting keys of type hash, each type has a different prefix, such as LSET for list, SET for string, among others we will see later in this story.

In order to add the same object we added with Redis Insight, we are going to run the following command:

HSET RaphaelDeLio name "Raphael" lastName "De Lio" age 27 job "Software Developer"

As a response, Redis should return the number of fields set in the key:

(integer) 4

Retrieving a key

There’s also a command for getting each type of key and they follow the same pattern we saw before.

We will cover two ways of retrieving hash keys, one is for getting all fields of this hash. We can do it by running:

HGETALL RaphaelDeLio

And we should see a response like:

1) "name"
2) "Raphael"
3) "lastName"
4) "De Lio"
5) "age"
6) "27"
7) "job"
8) "Software Developer"

And the second, is by retrieving an specific field, by running:

HGET RaphaelDeLio job

Which will return:

"Software Developer"

Editing a field or adding a new one

Editing a field or adding a new one is done by the same set command HSET, we can do it by running:

HSET RaphaelDeLio newKey "This is a new Key"
HSET RaphaelDeLio job "I'm editing an existing key!"

And you can test them, by running the GET commands we saw before.

Deleting a field or a key

To delete a hash field, you just need to run the HDEL command, as in:

HDEL RaphaelDeLio job

And to delete the key, you run:

DEL RaphaelDeLio

Disconnecting from Redis CLI

To disconnect from Redis CLI just press ctrl + c

What about the other types?

Hashes

Redis Hashes are maps between string fields and string values, so they are the perfect data type to represent objects (e.g. A User with a number of fields like name, surname, age, and so forth).

Every hash can store up to 2³² — 1 field-value pairs (more than 4 billion).

Strings

Strings are the most basic kind of Redis value. Redis Strings are binary safe, this means that a Redis string can contain any kind of data, for instance, a JPEG image or a serialized Ruby object.

A String value can be at a max of 512 Megabytes in length.

Commands for Strings:

• SET: To add or edit a key
• GET: To retrieve a key
• DEL: To delete a key

Lists

Redis Lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List by pushing new elements on the head (on the left) or on the tail (on the right) of the list.

Sets

Redis Sets are an unordered collection of Strings. It is possible to add, remove, and test for the existence of members in O(1).

Redis Sets have the desirable property of not allowing repeated members. Adding the same element multiple times will result in a set having a single copy of this element. Practically speaking this means that adding a member does not require a check if exists then add operation.

Commands:

• SADD: Adds one member to a set
• SREM: Removes one member from a set
• SMEMBERS: List all members from a set

Sorted Sets

Redis Sorted Sets are, similarly to Redis Sets, non-repeating collections of Strings. The difference is that every member of a Sorted Set is associated with a score, that is used to keep the Sorted Set in order, from the smallest to the greatest score. While members are unique, scores may be repeated.

Commands:

• ZADD: To add new members
• ZREM: To remove existing members
• ZRANGE: To list members by range

Streams

A Redis stream is a data structure that acts like an append-only log. Streams are useful for recording events in the order they occur.

For Streams, we need to provide an entry key, which can be a timestamp or sequence number. If we leave it as *, Redis will assign the Database timestamp to it.

Commands:

• XADD: To append a new entry to a stream
• XRANGE: List all entries matching a range of IDs
• XDEL: Removes an entry from a stream

JSON

RedisJSON is part of the JSON module and allows you to add JSON objects as the value for your keys.

Commands:

• JSON.SET: To add or replace a new JSON or field in an existing JSON
• JSON.DEL: To delete a JSON or field in a JSON
• JSON.GET: To retrieve a JSON

Conclusion

In this story, you learned how to start a Redis Server and Redis Insight locally. You also learned about different types of keys supported by Redis and also how to perform simple CRUD operations with Redis Insight and Redis CLI.

I hope you have enjoyed this story. I will be diving more into Redis on the following stories, so don’t forget to follow me and subscribe to my next stories!