2 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN">
5 <link type=
"text/css" rel=
"stylesheet" href=
"style.css" />
12 <img style=
"border:none" alt=
"Redis Documentation" src=
"redis.png">
16 <div id=
"pagecontent">
18 <!-- This is a (PRE) block. Make sure it's left aligned or your toc title will be off. -->
19 <b>README: Contents
</b><br> <a href=
"#Introduction">Introduction
</a><br> <a href=
"#Beyond key-value databases">Beyond key-value databases
</a><br> <a href=
"#What are the differences between Redis and Memcached?">What are the differences between Redis and Memcached?
</a><br> <a href=
"#What are the differences between Redis and Tokyo Cabinet / Tyrant?">What are the differences between Redis and Tokyo Cabinet / Tyrant?
</a><br> <a href=
"#Does Redis support locking?">Does Redis support locking?
</a><br> <a href=
"#Multiple databases support">Multiple databases support
</a><br> <a href=
"#Redis Data Types">Redis Data Types
</a><br> <a href=
"#Implementation Details">Implementation Details
</a><br> <a href=
"#Redis Tutorial">Redis Tutorial
</a><br> <a href=
"#License">License
</a><br> <a href=
"#Credits">Credits
</a>
22 <h1 class=
"wikiname">README
</h1>
29 <h1><a name=
"Introduction">Introduction
</a></h1>Redis is a database. To be specific, Redis is a very simple database implementing a dictionary, where every key is associated with a value. For example I can set the key
"surname_1992
" to the string
"Smith
".
30 What makes Redis different from many other key-value stores, is that every single value has a type. The following types are supported:
<br/><br/><ul><li> String
</li><li> List
</li><li> Set
</li><li> Sorted Set (since version
1.1)
</li></ul>
31 The type of a value determines what operations (called commands) are available for the value itself.
32 For example you can append elements to a list stored at the key
"mylist
" using the LPUSH or RPUSH command in O(
1). Later you'll be able to get a range of elements with LRANGE or trim the list with LTRIM. Sets are very flexible too, it is possible to add and remove elements from Sets (unsorted collections of strings), and then ask for server-side intersection, union, difference of Sets. Each command is performed through server-side atomic operations.
33 Please refer to the
<a href=
"CommandReference.html">Command Reference
</a> to see the full list of operations associated to these data types.
<br/><br/>In other words, you can look at Redis as a data structures server. A Redis user is virtually provided with an interface to
<a href=
"http://en.wikipedia.org/wiki/Abstract_data_type" target=
"_blank">Abstract Data Types
</a>, saving her from the responsibility to implement concrete data structures and algorithms. Indeed both algorithms and data structures in Redis are properly choosed in order to obtain the best performance.
<br/><br/>Redis loads and mantains the whole dataset into memory, but the dataset is persistent, since from time to time Redis writes a dump on disk asynchronously. The dataset is loaded from the dump every time the server is (re)started.
<br/><br/>Redis can be configured to save the dataset when a certain number of changes is reached and after a given number of seconds elapses. For example, you can configure Redis to save after
1000 changes and at most
60 seconds since the last save. You can specify any combination for these numbers.
<br/><br/>Because data is written asynchronously, when a system crash occurs, the last few queries can get lost (that is acceptable in many applications). Anyway it is possible to make this a non issue, since Redis supports master-slave replication from its early days, being effective even in the case where a few records lost are not acceptable.
<h1><a name=
"Beyond key-value databases">Beyond key-value databases
</a></h1>All these features allow to use Redis as the sole DB for your scalable application without the need of any relational database.
<a href=
"TwitterAlikeExample.html">We wrote a simple Twitter clone in PHP + Redis
</a> to show a real world example, the link points to an article explaining the design and internals in very simple words.
<h1><a name=
"What are the differences between Redis and Memcached?">What are the differences between Redis and Memcached?
</a></h1>In the following ways:
<br/><br/><ul><li> Memcached is not persistent, it just holds everything in memory without saving since its main goal is to be used as a cache. Redis instead can be used as the main DB for the application. We
<a href=
"TwitterAlikeExample.html">wrote a simple Twitter clone
</a> using only Redis as database.
</li></ul>
34 <ul><li> Like memcached Redis uses a key-value model, but while keys can just be strings, values in Redis can be lists and sets, and complex operations like intersections, set/get n-th element of lists, pop/push of elements, can be performed against sets and lists. It is possible to use lists as message queues.
</li></ul>
35 <h1><a name=
"What are the differences between Redis and Tokyo Cabinet / Tyrant?">What are the differences between Redis and Tokyo Cabinet / Tyrant?
</a></h1>Redis and Tokyo Cabinet can be used for the same applications, but actually they are
<b>very
</b> different beasts. If you read twitter messages of people involved in scalable things both products are reported to work well, but surely there are times where one or the other can be the best choice. Some differences are the followings (I may be biased, make sure to check yourself both the products).
<br/><br/><ul><li> Tokyo Cabinet writes synchronously on disk, Redis takes the whole dataset on memory and writes on disk asynchronously. Tokyo Cabinet is safer and probably a better idea if your dataset is going to be bigger than RAM, but Redis is faster (note that Redis supports master-slave replication that is trivial to setup, so you are safe anyway if you want a setup where data can't be lost even after a disaster).
</li></ul>
36 <ul><li> Redis supports higher level operations and data structures. Tokyo Cabinet supports a kind of database that is able to organize data into rows with named fields (in a way very similar to Berkeley DB) but can't do things like server side List and Set operations Redis is able to do: pushing or popping from Lists in an atomic way, in O(
1) time complexity, server side Set intersections,
<a href=
"SORT.html">SortCommand
</a> ing of schema free data in complex ways (Btw TC supports sorting in the table-based database format). Redis on the other hand does not support the abstraction of tables with fields, the idea is that you can build this stuff in software easily if you really need a table-alike approach.
</li></ul>
37 <ul><li> Tokyo Cabinet does not implement a networking layer. You have to use a networking layer called Tokyo Tyrant that interfaces to Tokyo Cabinet so you can talk to Tokyo Cabinet in a client-server fashion. In Redis the networking support is built-in inside the server, and is basically the only interface between the external world and the dataset.
</li></ul>
38 <ul><li> Redis is reported to be much faster, especially if you plan to access Tokyo Cabinet via Tokyo Tyrant. Here I can only say that with Redis you can expect
100,
000 operations/seconds with a normal Linux box and
50 concurrent clients. You should test Redis, Tokyo, and the other alternatives with your specific work load to get a feeling about performances for your application.
</li></ul>
39 <ul><li> Redis is (IMHO) generally an higher level and simpler to use beast in the operations supported, and to get started.
<a href=
"Check.html">the command reference CommandReference
</a> to get a feeling. You can even start playing with Redis by telnet after reading the five minutes tutorial at the end of this README file. To implement new client libraries is trivial.
<a href=
"Check.html">the protocol specification ProtocolSpecification
</a> for more information.
</li></ul><blockquote></blockquote><ul><li> Redis is not an on-disk DB engine like Tokyo: the latter can be used as a fast DB engine in your C project without the networking overhead just linking to the library. Still in many scalable applications you need multiple servers talking with multiple clients, so the client-server model is almost always needed, this is why in Redis this is built-in.
</li></ul>
40 <h1><a name=
"Does Redis support locking?">Does Redis support locking?
</a></h1>No, the idea is to provide atomic primitives in order to make the programmer
41 able to use redis with locking free algorithms. For example imagine you have
42 10 computers and one Redis server. You want to count words in a very large text.
43 This large text is split among the
10 computers, every computer will process
44 its part and use Redis's INCR command to atomically increment a counter
45 for every occurrence of the word found.
<br/><br/>INCR/DECR are not the only atomic primitives, there are others like PUSH/POP
46 on lists, POP RANDOM KEY operations, UPDATE and so on. For example you can
47 use Redis like a Tuple Space (
<a href=
"http://en.wikipedia.org/wiki/Tuple_space" target=
"_blank">http://en.wikipedia.org/wiki/Tuple_space
</a>) in
48 order to implement distributed algorithms.
<br/><br/>(News: locking with key-granularity is now planned)
<h1><a name=
"Multiple databases support">Multiple databases support
</a></h1>Another synchronization primitive is the support for multiple DBs. By default DB
0 is selected for every new connection, but using the SELECT command it is possible to select a different database. The MOVE operation can move an item from one DB to another atomically. This can be used as a base for locking free algorithms together with the 'RANDOMKEY' commands.
<h1><a name=
"Redis Data Types">Redis Data Types
</a></h1>Redis supports the following three data types as values:
<br/><br/><ul><li> Strings: just any sequence of bytes. Redis strings are binary safe so they can not just hold text, but images, compressed data and everything else.
</li><li> Lists: lists of strings, with support for operations like append a new string on head, on tail, list length, obtain a range of elements, truncate the list to a given length, sort the list, and so on.
</li><li> Sets: an unsorted set of strings. It is possible to add or delete elements from a set, to perform set intersection, union, subtraction, and so on.
</li></ul>
49 Values can be Strings, Lists or Sets. Keys can be a subset of strings not containing newlines (
"\n
") and spaces (
" ").
<br/><br/>Note that sometimes strings may hold numeric vaules that must be parsed by
50 Redis. An example is the INCR command that atomically increments the number
51 stored at the specified key. In this case Redis is able to handle integers
52 that can be stored inside a 'long long' type, that is a
64-bit signed integer.
<h2><a name=
"Implementation Details">Implementation Details
</a></h2>Strings are implemented as dynamically allocated strings of characters.
53 Lists are implemented as doubly linked lists with cached length.
54 Sets are implemented using hash tables that use chaining to resolve collisions.
<h1><a name=
"Redis Tutorial">Redis Tutorial
</a></h1>(note, you can skip this section if you are only interested in
"formal
" doc.)
<br/><br/>Later in this document you can find detailed information about Redis commands,
55 the protocol specification, and so on. This kind of documentation is useful
56 but... if you are new to Redis it is also BORING! The Redis protocol is designed
57 so that is both pretty efficient to be parsed by computers, but simple enough
58 to be used by humans just poking around with the 'telnet' command, so this
59 section will show to the reader how to play a bit with Redis to get an initial
60 feeling about it, and how it works.
<br/><br/>To start just compile redis with 'make' and start it with './redis-server'.
61 The server will start and log stuff on the standard output, if you want
62 it to log more edit redis.conf, set the loglevel to debug, and restart it.
<br/><br/>You can specify a configuration file as unique parameter:
<br/><br/><blockquote>./redis-server /etc/redis.conf
</blockquote>
63 This is NOT required. The server will start even without a configuration file
64 using a default built-in configuration.
<br/><br/>Now let's try to set a key to a given value:
<br/><br/><pre class=
"codeblock python" name=
"code">
65 $ telnet localhost
6379
67 Connected to localhost.
68 Escape character is '^]'.
72 </pre>The first line we sent to the server is
"set foo
3". This means
"set the key
73 foo with the following three bytes I'll send you
". The following line is
74 the
"bar
" string, that is, the three bytes. So the effect is to set the
75 key
"foo
" to the value
"bar
". Very simple!
<br/><br/>(note that you can send commands in lowercase and it will work anyway,
76 commands are not case sensitive)
<br/><br/>Note that after the first and the second line we sent to the server there
77 is a newline at the end. The server expects commands terminated by
"\r\n
"
78 and sequence of bytes terminated by
"\r\n
". This is a minimal overhead from
79 the point of view of both the server and client but allows us to play with
80 Redis with the telnet command easily.
<br/><br/>The last line of the chat between server and client is
"+OK
". This means
81 our key was added without problems. Actually SET can never fail but
82 the
"+OK
" sent lets us know that the server received everything and
83 the command was actually executed.
<br/><br/>Let's try to get the key content now:
<br/><br/><pre class=
"codeblock python python" name=
"code">
87 </pre>Ok that's very similar to 'set', just the other way around. We sent
"get foo
",
88 the server replied with a first line that is just the $ character follwed by
89 the number of bytes the value stored at key contained, followed by the actual
90 bytes. Again
"\r\n
" are appended both to the bytes count and the actual data. In Redis slang this is called a bulk reply.
<br/><br/>What about requesting a non existing key?
<br/><br/><pre class=
"codeblock python python python" name=
"code">
93 </pre>When the key does not exist instead of the length, just the
"$-
1" string is sent. Since a -
1 length of a bulk reply has no meaning it is used in order to specifiy a 'nil' value and distinguish it from a zero length value. Another way to check if a given key exists or not is indeed the EXISTS command:
<br/><br/><pre class=
"codeblock python python python python" name=
"code">
98 </pre>As you can see the server replied ':
0' the first time since 'nokey' does not
99 exist, and ':
1' for 'foo', a key that actually exists. Replies starting with the colon character are integer reply.
<br/><br/>Ok... now you know the basics, read the
<a href=
"CommandReference.html">REDIS COMMAND REFERENCE
</a> section to
100 learn all the commands supported by Redis and the
<a href=
"ProtocolSpecification.html">PROTOCOL SPECIFICATION
</a>
101 section for more details about the protocol used if you plan to implement one
102 for a language missing a decent client implementation.
<h1><a name=
"License">License
</a></h1>Redis is released under the BSD license. See the COPYING file for more information.
<h1><a name=
"Credits">Credits
</a></h1>Redis is written and maintained by Salvatore Sanfilippo, Aka 'antirez'.
<br/><br/>Enjoy,
projects / redis.git / blob