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>index: Contents
</b><br> <a href=
"#Getting started">Getting started
</a><br> <a href=
"#Full programming examples">Full programming examples
</a><br> <a href=
"#FAQs and benchmarks">FAQs and benchmarks
</a><br> <a href=
"#HOWTOs about selected features">HOWTOs about selected features
</a><br> <a href=
"#Hacking">Hacking
</a><br> <a href=
"#Videos">Videos
</a><br> <a href=
"#Recipes and books">Recipes and books
</a>
22 <h1 class=
"wikiname">index
</h1>
29 = Redis Documentation =
<br/><br/><a href=
"http://pyha.ru/wiki/index.php?title=Redis:index" target=
"_blank">Russian Translation
</a>Hello! The followings are pointers to different parts of the Redis Documentation.
<h1><a name=
"Getting started">Getting started
</a></h1><ul><li> New! You can now
<a href=
"http://try.redis-db.com" target=
"_blank">Try Redis directly in your browser!
</a>.
</li><li> <a href=
"README.html">The README
</a> is a good starting point to know more about the project.
</li><li> <a href=
"QuickStart.html">This short Quick Start
</a> provides a five minutes step-by-step istructions on how to download, compile, run and test the basic workings of a Redis server.
</li><li> <a href=
"CommandReference.html">The command reference
</a> is a description of all the Redis commands with links to command specific pages. You can also download the
<a href=
"http://go2.wordpress.com/?id=725X1342&site=masonoise.wordpress.com&url=http%3A%2F%2Fmasonoise.files.wordpress.com%2F2010%2F03%2Fredis-cheatsheet-v1.pdf" target=
"_blank">Redis Commands Cheat-Sheet
</a> provided by Mason Jones (btw some command may be missing, the primary source is the wiki).
</li><li> <a href=
"IntroductionToRedisDataTypes.html">A Fifteen Minutes Introduction to the Redis Data Types
</a> explains how Redis data types work and the basic patterns of working with Redis.
</li><li> <a href=
"http://simonwillison.net/static/2010/redis-tutorial/" target=
"_blank">the Simon Willison Redis Tutorial
</a> is a
<b>must read
</b>, very good documentation where you will find a lot of real world ideas and use cases.
</li><li> <a href=
"http://blog.mjrusso.com/2010/10/17/redis-from-the-ground-up.html" target=
"_blank">Redis from the ground up
</a> is an impressive article to know more about Redis if you are a newcomer.
</li><li> <a href=
"http://playnice.ly/blog/2010/10/19/getting-started-redis-python/" target=
"_blank">Getting started with Redis and Python
</a></li></ul>
30 <h1><a name=
"Full programming examples">Full programming examples
</a></h1><ul><li> <a href=
"TwitterAlikeExample.html">This is a tutorial about creating a Twitter clone using *only* Redis as database, no relational DB at all is used
</a>, it is a good start to understand the key-value database paradigm.
</li></ul>
31 <h1><a name=
"FAQs and benchmarks">FAQs and benchmarks
</a></h1><ul><li> <a href=
"Benchmarks.html">The benchmark page
</a> is about the speed performances of Redis.
</li><li> <a href=
"FAQ.html">Our FAQ
</a> contains of course some answers to common questions about Redis. Not very up-to-date.
</li></ul>
32 <h1><a name=
"HOWTOs about selected features">HOWTOs about selected features
</a></h1><ul><li> <a href=
"ReplicationHowto.html">The Redis Replication HOWTO
</a> is what you need to read in order to understand how Redis master
<code name=
"code" class=
"python"><-
></code> slave replication works.
</li><li> <a href=
"AppendOnlyFileHowto.html">The Append Only File HOWTO
</a> explains how the alternative Redis durability mode works. AOF is an alternative to snapshotting on disk from time to time (the default).
</li><li> <a href=
"VirtualMemoryUserGuide.html">Virtual Memory User Guide
</a>. A simple to understand guide about using and configuring the Redis Virtual Memory.
</li><li> <a href=
"RedisPipelining.html">Redis Pipelining Guide
</a>.
</li><li> Memory optimization: Full of keys, a
<a href=
"http://antirez.com/post/redis-weekly-update-7.html" target=
"_blank">blog post at antirez.com
</a> showing how to use Redis
2.0 and hashes to create a setup where you can store
5 times more data in your Redis instance.
</li><li> <a href=
"http://antirez.com/post/autocomplete-with-redis.html" target=
"_blank">Implementing auto complete with Redis
</a>.
</li></ul>
33 <h1><a name=
"Hacking">Hacking
</a></h1>
34 <ul><li> <a href=
"ProtocolSpecification.html">The Protocol Specification
</a> is all you need in order to implement a Redis client library for a missing language. PHP, Python, Ruby and Erlang are already supported.
</li><li> Look at
<a href=
"RedisInternals.html">Redis Internals
</a> if you are interested in the implementation details of the Redis server.
</li></ul>
35 <h1><a name=
"Videos">Videos
</a></h1><ul><li> <a href=
"http://confreaks.net/videos/62-mwrc2009-redis-key-value-nirvana" target=
"_blank">Ezra Zygmuntowicz at the Mountain West Ruby Conference
2009</a> to know the most important Redis ideas in few minutes.
</li><li> <a href=
"http://www.ustream.tv/recorded/7855635" target=
"_blank">Salvatore Sanfilippo and Pieter Noordhuis at the SF Redis Meetup
</a></li></ul>
36 <h1><a name=
"Recipes and books">Recipes and books
</a></h1><ul><li> <a href=
"http://www.rediscookbook.org/" target=
"_blank">The Redis Cookbook
</a> is a collaborative effort to provide some good recipe.
</li><li> There is an ongoing effort to write a Redis book for O'Reilly
</li></ul>