Merge branch 'master' of github.com:/antirez/redis-doc

.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+   - 1.9.3
+
+gemfile:
+  - .travis/Gemfile
+
+before_install:
+ - sudo apt-get install -y aspell aspell-en

.travis/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem "batch"
+gem "rdiscount"

.travis/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    batch (0.0.3)
+    rake (0.9.2.2)
+    rdiscount (1.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  batch
+  rake
+  rdiscount

Rakefile

@@ -42,9 +42,9 @@ end
 
 namespace :format do
 
-  require "./remarkdown"
-
   def format(file)
+    require "./remarkdown"
+
     return unless File.exist?(file)
 
     STDOUT.print "formatting #{file}..."

clients.json

@@ -27,15 +27,14 @@
     "recommended": true,
     "active": true
   },
-
   {
-    "name": "Carmine",
+    "name": "aleph",
     "language": "Clojure",
-    "repository": "https://github.com/ptaoussanis/carmine",
-    "description": "Deliberately simple, high-performance Redis (2.0+) client for Clojure.",
-    "authors": ["ptaoussanis"]
-  },
-
+    "repository": "https://github.com/ztellman/aleph.git",
+    "description": "Redis client build on top of lamina",
+    "authors":["Zach Tellman"],
+    "active": true
+  },  
   {
     "name": "CL-Redis",
     "language": "Common Lisp",
@@ -64,6 +63,15 @@
     "active": true
   },
 
+  {
+    "name": "sharded_eredis",
+    "language": "Erlang",
+    "repository": "https://github.com/jeremyong/sharded_eredis",
+    "description": "Wrapper around eredis providing process pools and consistent hashing.",
+    "authors": ["jeremyong", "hiroeorz"],
+    "active": true
+  },
+
   {
     "name": "redis.fy",
     "language": "Fancy",

commands.json

@@ -723,6 +723,13 @@
   },
   "INFO": {
     "summary": "Get information and statistics about the server",
+    "arguments": [
+      {
+        "name": "section",
+        "type": "string",
+        "optional": true
+      }
+    ],
     "since": "1.0.0",
     "group": "server"
   },

commands/ttl.md

@@ -4,7 +4,7 @@ given key will continue to be part of the dataset.
 
 @return
 
-@integer-reply: TTL in seconds or `-1` when `key` does not exist or does not
+@integer-reply: TTL in seconds, `-2` when `key` does not exist or `-1` when `key` does not
 have a timeout.
 
 @examples

tools.json

@@ -266,5 +266,20 @@
     "repository": "http://github.com/qi4j/qi4j-sdk",
     "description": "Qi4j EntityStore backed by Redis",
     "authors": ["eskatos"]
+  },
+  {
+    "name": "Spring Data Redis",
+    "language": "Java",
+    "url": "http://www.springsource.org/spring-data/redis",
+    "repository": "http://github.com/SpringSource/spring-data-redis",
+    "description": "Spring integration for Redis promoting POJO programming, portability and productivity",
+    "authors": ["costinl"]
+  },
+  {
+    "name": "PHPRedMin",
+    "language": "PHP",
+    "repository": "https://github.com/sasanrose/phpredmin",
+    "description": "Yet another web interface for Redis",
+    "authors": ["sasanrose"]
   }
-]
+]

topics/license.md

@@ -38,7 +38,7 @@ Redis uses source code from third parties. All this code contians a BSD or BSD-c
 
 * Redis uses the `sha1.c` file that is copyright by Steve Reid and released under the **public domain**. This file is extremely popular and used among open source and proprietary code.
 
-* When compiled on Linux Redis usees the [Jemalloc allocator](http://www.canonware.com/jemalloc/), that is copyright by Jason Evans, Mozilla Foundation and Facebook, Inc and is released under the **two clause BSD license**.
+* When compiled on Linux Redis uses the [Jemalloc allocator](http://www.canonware.com/jemalloc/), that is copyright by Jason Evans, Mozilla Foundation and Facebook, Inc and is released under the **two clause BSD license**.
 
 * Inside Jemalloc the file `pprof` is copyright Google Inc and released under the **three clause BSD license**.
 

topics/mass-insert.md

@@ -2,7 +2,7 @@ Redis Mass Insertion
 ===
 
 Sometimes Redis instances needs to be loaded with big amount of preexisting
-or user generated data in a short amount of time, so that million of keys
+or user generated data in a short amount of time, so that millions of keys
 will be created as fast as possible.
 
 This is called a *mass insertion*, and the goal of this document is to
@@ -13,7 +13,7 @@ Use the protocol, Luke
 
 Using a normal Redis client to perform mass insertion is not a good idea
 for a few reasons: the naive approach of sending one command after the other
-is slow because there is to pay the round trip time for every command.
+is slow because you have to pay for the round trip time for every command.
 It is possible to use pipelining, but for mass insertion of many records
 you need to write new commands while you read replies at the same time to
 make sure you are inserting as fast as possible.

topics/memory-optimization.md

@@ -8,7 +8,7 @@ Since Redis 2.2 many data types are optimized to use less space up to a certain
 This is completely transparent from the point of view of the user and API.
 Since this is a CPU / memory trade off it is possible to tune the maximum number of elements and maximum element size for special encoded types using the following redis.conf directives.
 
-    hash-max-zipmap-entries 64 (hahs-max-ziplist-entries for Redis >= 2.6)
+    hash-max-zipmap-entries 64 (hash-max-ziplist-entries for Redis >= 2.6)
     hash-max-zipmap-value 512  (hash-max-ziplist-value for Redis >= 2.6)
     list-max-ziplist-entries 512
     list-max-ziplist-value 64

topics/persistence.md

@@ -267,8 +267,8 @@ Since many Redis users are in the startup scene and thus don't have plenty
 of money to spend we'll review the most interesting disaster recovery techniques
 that don't have too high costs.
 
-* Amazon S3 and other similar services are a good way for mounting your disaster recovery system. Simply transfer your daily or hourly RDB snapshot to S3 in an encrypted form. You can encrypt your data using gpg -c (in symmetric encryption mode). Make sure to store your password in many differnet safe places (for instance give a copy to the most important guys of your organization). It is recommanded to use multiple storage services for improved data safety.
-* Transfer your snapshots using scp (part of ssh) to far servers. This is a fairly simple and safe route: get a small VPS in a place that is very far from you, install ssh there, and greate an ssh client key without passphrase, then make
+* Amazon S3 and other similar services are a good way for mounting your disaster recovery system. Simply transfer your daily or hourly RDB snapshot to S3 in an encrypted form. You can encrypt your data using `gpg -c` (in symmetric encryption mode). Make sure to store your password in many different safe places (for instance give a copy to the most important guys of your organization). It is recommanded to use multiple storage services for improved data safety.
+* Transfer your snapshots using SCP (part of SSH) to far servers. This is a fairly simple and safe route: get a small VPS in a place that is very far from you, install ssh there, and greate an ssh client key without passphrase, then make
 add it in the authorized_keys file of your small VPS. You are ready to transfer
 backups in an automated fashion. Get at least two VPS in two different providers
 for best results.

topics/quickstart.md

@@ -138,27 +138,27 @@ We assume you already copied **redis-server** and **redis-cli** executables unde
 
 * Create a directory where to store your Redis config files and your data:
 
-    sudo mkdir /etc/redis
-    sudo mkdir /var/redis
+        sudo mkdir /etc/redis
+        sudo mkdir /var/redis
 
 * Copy the init script that you'll find in the Redis distribution under the **utils** directory into /etc/init.d. We suggest calling it with the name of the port where you are running this instance of Redis. For example:
 
-    sudo cp utils/redis_init_script /etc/init.d/redis_6379
+        sudo cp utils/redis_init_script /etc/init.d/redis_6379
 
 * Edit the init script.
 
-    sudo vi /etc/init.d/redis_6379
+        sudo vi /etc/init.d/redis_6379
 
 Make sure to modify **REDIS_PORT** accordingly to the port you are using.
 Both the pid file path and the configuration file name depend on the port number.
 
 * Copy the template configuration file you'll find in the root directory of the Redis distribution into /etc/redis/ using the port number as name, for instance:
 
-    sudo cp redis.conf /etc/redis/6379.conf
+        sudo cp redis.conf /etc/redis/6379.conf
 
 * Create a directory inside /var/redis that will work as data and working directory for this Redis instance:
 
-    sudo mkdir /var/redis/6379
+        sudo mkdir /var/redis/6379
 
 * Edit the configuration file, making sure to perform the following changes:
     * Set **daemonize** to yes (by default it is set to no).
@@ -167,9 +167,9 @@ Both the pid file path and the configuration file name depend on the port number
     * Set your preferred **loglevel**.
     * Set the **logfile** to /var/log/redis_6379.log
     * Set the **dir** to /var/redis/6379 (very important step!)
-    * Finally add the new Redis init script to all the default runlevels using the following command:
+* Finally add the new Redis init script to all the default runlevels using the following command:
 
-    sudo update-rc.d redis_6379 defaults
+        sudo update-rc.d redis_6379 defaults
 
 You are done! Now you can try running your instance with:
 

topics/twitter-clone.md

@@ -14,7 +14,7 @@ of this article targets PHP, but Ruby programmers can also check the other
 source code, it conceptually very similar.
 
 **Note:** [Retwis-J](http://retwisj.cloudfoundry.com/) is a port of Retwis to
-Java, using the Spring Data Framework, written by Costin Leau. The source code
+Java, using the Spring Data Framework, written by [Costin Leau](http://twitter.com/costinl). The source code
 can be found on
 [GitHub](https://github.com/SpringSource/spring-data-keyvalue-examples) and
 there is comprehensive documentation available at