Redis Tutorial
Redis Tutorial
Please type TUTORIAL to begin a brief tutorial, HELP to see a list of supported commands, or any valid Redis
command to play with the database.
> TUTORIAL
The essence of a key-value store is the ability to store some data, called a value, inside a key. This data can later
be retrieved only if we know the exact key used to store it.
Often Redis it is called a data structure server because it has outer key-value shell, but each value can contain a
complex data structure, such as a string, a list, a hashes, or ordered data structures called sorted sets as well as
probabilistic data structures like hyperloglog.
As a first example, we can use the command SET to store the value "fido" at key "server:name":
Redis will store our data permanently, so we can later ask "What is the value stored at key server:name?" and
Redis will reply with "fido":
Tip: You can click the commands above to automatically execute them. The text after the arrow (=>) shows the expected output.
> NEXT
Other basic operations provided by Redis are DEL to delete a given key and associated value, INCR to atomically
increment a number stored at a given key:
SET connections 10
INCR connections => 11
INCR connections => 12
DEL connections
INCR connections => 1
It is also possible to increment the number contained inside a key by a specific amount:
And there are similar commands in order to decrement the value of the key.
When you manipulate Redis strings with incrementing and decrementing commands, you are
implementing counters. Counters are a very popular application for Redis.
> NEXT
There is something special about INCR. Why do we provide such an operation if we can do it ourself with a bit of
code? After all it is as simple as:
x = GET count
x = x + 1
SET count x
The problem is that doing the increment in this way will only work as long as there is a single client using the key.
See what happens if two clients are accessing this key at the same time:
We wanted the value to be 12, but instead it is 11! This is because incrementing the value in this way is not an
atomic operation. Calling the INCR command in Redis will prevent this from happening, because it is an atomic
operation.
All the Redis operations implemented by single commands are atomic, including the ones operating on more
complex data structures. So when you use a Redis command that modifies some value, you don't have to think
about concurrent access.
> NEXT
Redis can be told that a key should only exist for a certain length of time. This is accomplished with
the EXPIRE and TTL commands, and by the similar PEXPIRE and PTTL commands that operate using time in
milliseconds instead of seconds.
This causes the key resource:lock to be deleted in 120 seconds. You can test how long a key will exist with
the TTL command. It returns the number of seconds until it will be deleted.
The -2 for the TTL of the key means that the key does not exist (anymore). A -1 for the TTL of the key means that
it will never expire. Note that if you SET a key, its TTL will be reset.
The SET command is actually able to accept further arguments in order to directly set a time to live (TTL) to a
key, so you can alter the value of a key and set its TTL at the same time in a single atomic operation:
It is also possible to cancel the time to live of a key removing the expire and making the key permanent again.
> NEXT
Redis also supports several more complex data structures. The first one we'll look at is a list. A list is a series of
ordered values. Some of the important commands for interacting with lists
are RPUSH, LPUSH, LLEN, LRANGE, LPOP, and RPOP. You can immediately begin working with a key as a list, as
long as it doesn't already exist as a different type.
This concept is generally true for every Redis data structure: you don't create a key first, and add things to it later,
but you can just directly use the command in order to add new elements. As side effect the key will be created if it
did not exist. Similarly keys that will result empty after executing some command will automatically be removed
from the key space.
> NEXT
LRANGE gives a subset of the list. It takes the index of the first element you want to retrieve as its first parameter
and the index of the last element you want to retrieve as its second parameter. A value of -1 for the second
parameter means to retrieve elements until the end of the list, -2 means to include up to the penultimate, and so
forth.
> NEXT
So far we explored the commands that let you add elements to the list, and LRANGE that let you inspect ranges of
the list. A fundamental functionality of Redis lists is the ability to remove, and return to the client at the same time,
elements in the head or the tail of the list.
LPOP removes the first element from the list and returns it.
RPOP removes the last element from the list and returns it.
> NEXT
Both RPUSH and LPUSH commands are variadic, so you can specify multiple elements in the same command
execution.
Tip: RPUSH and LPUSH return the total length of the list after the operation.
You can also use LLEN to obtain the current length of the list.
> NEXT
The next data structure that we'll look at is a set. A set is similar to a list, except it does not have a specific order
and each element may only appear once. Both the data structures are very useful because while in a list is fast to
access the elements near the top or the bottom, and the order of the elements is preserved, in a set is very fast
to test for membership, that is, to immediately know if a given element was added or not. Moreover in a set a
given element can exist only in a single copy.
Some of the important commands in working with sets are SADD, SREM, SISMEMBER, SMEMBERS and SUNION.
SADD adds the given member to the set, again this command is also variadic.
SREM removes the given member from the set, returning 1 or 0 to signal if the member was actually there or not.
> NEXT
SISMEMBER tests if the given value is in the set. It returns 1 if the value is there and 0 if it is not.
SISMEMBER superpowers "flight" => 1
SISMEMBER superpowers "reflexes" => 0
SUNION combines two or more sets and returns the list of all elements.
> NEXT
The return value of SADD is as important as the one of SREM. If the element we try to add is already inside, then 0
is returned, otherwise SADD returns 1:
> NEXT
Sets also have a command very similar to LPOP and RPOP in order to extract elements from the set and return
them to the client in a single operation. However since sets are not ordered data structures the returned (and
removed) elements are totally casual in this case.
The argument of SPOP after the name of the key, is the number of elements we want it to return, and remove
from the set.
> NEXT
Sets are a very handy data type, but as they are unsorted they don't work well for a number of problems. This is
why Redis 1.2 introduced Sorted Sets.
A sorted set is similar to a regular set, but now each value has an associated score. This score is used to sort the
elements in the set.
In these examples, the scores are years of birth and the values are the names of famous hackers.
> NEXT
Simple strings, sets and sorted sets already get a lot done but there is one more data type Redis can handle:
Hashes.
Hashes are maps between string fields and string values, so they are the perfect data type to represent objects
(eg: A User with a number of fields like name, surname, age, and so forth):
HGETALL user:1000
You can also set multiple fields at once:
> NEXT
Numerical values in hash fields are handled exactly the same as in simple strings and there are operations to
increment this value in an atomic way.
> NEXT
That wraps up the Try Redis tutorial. Please feel free to goof around with this console as much as you'd like.
• Redis Documentation
• Command Reference
• Implement a Twitter Clone in Redis
• Introduction to Redis Data Types