From 7f4e28e75046104599a5d83c493fdfd78f93ab49 Mon Sep 17 00:00:00 2001 From: antirez Date: Wed, 8 Apr 2009 13:42:34 +0200 Subject: [PATCH] html doc updated --- doc/Credits.html | 2 +- doc/LlenCommand.html | 5 ++--- doc/LremCommand.html | 2 -- doc/MoveCommand.html | 6 +++--- doc/RenamenxCommand.html | 2 -- doc/ReplyTypes.html | 16 +++++++--------- doc/SaddCommand.html | 1 - doc/ScardCommand.html | 5 ++--- doc/SismemberCommand.html | 3 +-- doc/SremCommand.html | 1 - doc/TypeCommand.html | 2 +- doc/UnstableSource.html | 1 + 12 files changed, 18 insertions(+), 28 deletions(-) diff --git a/doc/Credits.html b/doc/Credits.html index 751cce78..7504d5e3 100644 --- a/doc/Credits.html +++ b/doc/Credits.html @@ -26,7 +26,7 @@
-

Credits

+

Credits

p.s. sorry to take this file in sync is hard in this early days. Please drop me an email if I forgot to add your name here!
diff --git a/doc/LlenCommand.html b/doc/LlenCommand.html index e1284a31..661a6755 100644 --- a/doc/LlenCommand.html +++ b/doc/LlenCommand.html @@ -29,9 +29,8 @@

LLEN _key_

Time complexity: O(1)
Return the length of the list stored at the specified key. If thekey does not exist zero is returned (the same behaviour as forempty lists). If the value stored at key is not a list an error is returned.

Return value

Integer reply, specifically:

-The length of the list as an integer `>=` 0 if the operation succeeded
--2 if the specified key does not hold a list value
-
Note that library clients should raise an error if -2 is returned by the Redis server instead to pass the negative value back to the caller.

See also

+The length of the list. +

See also

diff --git a/doc/LremCommand.html b/doc/LremCommand.html index a2441ba2..f0585ef7 100644 --- a/doc/LremCommand.html +++ b/doc/LremCommand.html @@ -30,8 +30,6 @@ Time complexity: O(N) (with N being the length of the list)
Remove the first count occurrences of the value element from the list.If count is zero all the elements are removed. If count is negativeelements are removed from tail to head, instead to go from head to tailthat is the normal behaviour. So for example LREM with count -2 and_hello_ as value to remove against the list (a,b,c,hello,x,hello,hello) willlave the list (a,b,c,hello,x). The number of removed elements is returnedas an integer, see below for more information aboht the returned value.

Return value

Integer Reply, specifically:

 The number of removed elements if the operation succeeded
--1 if the specified key does not exist
--2 if the specified key does not hold a list value

See also

diff --git a/doc/MoveCommand.html b/doc/MoveCommand.html index f3252f84..db14f4bf 100644 --- a/doc/MoveCommand.html +++ b/doc/MoveCommand.html @@ -28,10 +28,10 @@

MOVE _key_ _dbindex_

Move the specified key from the currently selected DB to the specifieddestination DB. Note that this command returns 1 only if the key wassuccessfully moved, and 0 if the target key was already there or if thesource key was not found at all, so it is possible to use MOVE as a lockingprimitive.
-

Return value

Integer reply, specifically:

1 if the key was moved +

Return value

Integer reply, specifically:

+1 if the key was moved
 0 if the key was not moved because already present on the target DB or was not found in the current DB.
--3 if the destination DB is the same as the source DB
--4 if the database index if out of range
See also

+

See also

diff --git a/doc/RenamenxCommand.html b/doc/RenamenxCommand.html index 232cb65d..d2a742a4 100644 --- a/doc/RenamenxCommand.html +++ b/doc/RenamenxCommand.html @@ -31,8 +31,6 @@

Return value

Integer reply, specifically:

 1 if the key was renamed
 0 if the target key already exist
--1 if the source key does not exist
--3 if source and destination keys are the same

See also

diff --git a/doc/ReplyTypes.html b/doc/ReplyTypes.html index 18b4a640..9f60aecf 100644 --- a/doc/ReplyTypes.html +++ b/doc/ReplyTypes.html @@ -16,7 +16,7 @@
-ReplyTypes: Contents
  Redis Reply Types
  Status code reply
  Integer reply
  Bulk reply
  Multi bulk reply +ReplyTypes: Contents
  Redis Reply Types
  Status code reply
  Error reply
  Integer reply
  Bulk reply
  Multi bulk reply

ReplyTypes

@@ -27,14 +27,12 @@

Redis Reply Types

Redis commands can reply to the client with four different kind of replies, you can find the protocol level specification of this replies in the Redis Protocol Specification. This page is instead an higher level description of the four types of replies from the point of view of the final user.

Status code reply

-Status code replies are in the form of a +OK from the server, or a -ERR followed by an error string. At the protocol level this replies are sent as a single line. Client libraries should return true on OK, and should raise an exception in form of an error that stops the execution of the program on ERR replies from server, because this kind of replies are used by operations that usually fails because of a programming error, an inconsistent DB, and so on.

Integer reply

-At protocol level integer replies are single line replies in form of a decimal singed number. Redis commands returning true or false will use an integer reply and "1" and "0" as replies. A negative value in an integer reply is used to signal an error by all the commands, with the exception of INCR/INCRBY/DECR/DECRBY where negative return values are allowed (this command never fails).

All the integer replies using negative values to return errors will use the same values to signal the same errors: - -1 key not found - -2 key contains a value of the wrong type - -3 source object and destination object are the same - -4 out of range argument

Integer replies are usually passed by client libraries as integer values. On negative integer reply an exception should be raised (excluding the INCR family commands).

Bulk reply

-A bulk reply is a binary-safe reply that is used to return a single string value (string is not limited to alphanumerical strings, it may contain binary data of any kind). Client libraries will usually return a string as return value of Redis commands returning bulk replies. There is a special bulk reply that signal that the element does not exist. When this happens the client library should return 'nil', 'false', or some other special element that can be distinguished by an empty string.

Multi bulk reply

-While a bulk reply returns a single string value, multi bulk replies are used to return multiple values: lists, sets, and so on. Elements of a bulk reply can be missing (-1 length count at protocol level). Client libraries should return 'nil' or 'false' in order to make this elements distinguishable from empty strings. Client libraries should return multi bulk replies that are about ordered elements like list ranges as lists, and bulk replies about sets as hashes. +Status code replies are single line strings having the + character as first byte. The string to return to the client is simply verything that follows the first + character. For example the PING command returns +PONG, that is the string "PONG".

Error reply

+This is like a status code reply but the first character is - instead of +. The client library should raise an error for error replies and stop the execution of the program if the exception is not trapped, showing the error message (everything following the first - character). An example of error is "-Error no such key" or "-foobar". Note that error replies will not collide with negative integer replies since integer replies are prefixed with the : character.

Integer reply

+At protocol level integer replies are single line replies in form of a decimal singed number prefixed by a : character. For example :10 is an integer reply. Redis commands returning true or false will use an integer reply with 0 or 1 as values where 0 is false and 1 is true.

Integer replies are usually passed by client libraries as integer values.

Bulk reply

+A bulk reply is a binary-safe reply that is used to return a binary safe single string value (string is not limited to alphanumerical strings, it may contain binary data of any kind). Client libraries will usually return a string as return value of Redis commands returning bulk replies. There is a special bulk reply that signal that the element does not exist. When this happens the client library should return 'nil', 'false', or some other special element that can be distinguished by an empty string.

Multi bulk reply

+While a bulk reply returns a single string value, multi bulk replies are used to return multiple values: lists, sets, and so on. Elements of a bulk reply can be missing. Client libraries should return 'nil' or 'false' in order to make this elements distinguishable from empty strings. Client libraries should return multi bulk replies that are about ordered elements like list ranges as lists, and bulk replies about sets as hashes or Sets if the implementation language has a Set type. +
diff --git a/doc/SaddCommand.html b/doc/SaddCommand.html index ed3258ca..400d4187 100644 --- a/doc/SaddCommand.html +++ b/doc/SaddCommand.html @@ -31,7 +31,6 @@

Return value

Integer reply, specifically:

 1 if the new element was added
 0 if the new element was already a member of the set
--2 if the key contains a non set value

See also

diff --git a/doc/ScardCommand.html b/doc/ScardCommand.html index d85be9db..c6539745 100644 --- a/doc/ScardCommand.html +++ b/doc/ScardCommand.html @@ -27,10 +27,9 @@

SCARD _key_

-Time complexity O(1)
Return the set cardinality (number of elements). If the key does notexist 0 is returned, like for empty sets. If the key does not holda set value -1 is returned. Client libraries should raise an errorwhen -1 is returned instead to pass the value to the caller.
+Time complexity O(1)
Return the set cardinality (number of elements). If the key does notexist 0 is returned, like for empty sets.

Return value

Integer reply, specifically:

-the cardinality (number of elements) of the set as an integer `>=` 0 if the operation succeeded
--2 if the specified key does not hold a set value
+the cardinality (number of elements) of the set as an integer.

See also

diff --git a/doc/SismemberCommand.html b/doc/SismemberCommand.html index 63516d02..0b321637 100644 --- a/doc/SismemberCommand.html +++ b/doc/SismemberCommand.html @@ -27,11 +27,10 @@

SISMEMBER _key_ _member_

-Time complexity O(1)
Return 1 if member is a member of the set stored at key, otherwise0 is returned. On error a negative value is returned. Client librariesshould raise an error when a negative value is returned instead to passthe value to the caller.
+Time complexity O(1)
Return 1 if member is a member of the set stored at key, otherwise0 is returned.

Return value

Integer reply, specifically:

 1 if the element is a member of the set
 0 if the element is not a member of the set OR if the key does not exist
--2 if the key does not hold a set value

See also

diff --git a/doc/SremCommand.html b/doc/SremCommand.html index 6219e92c..a16961de 100644 --- a/doc/SremCommand.html +++ b/doc/SremCommand.html @@ -31,7 +31,6 @@

Return value

Integer reply, specifically:

 1 if the new element was removed
 0 if the new element was not a member of the set
--2 if the key does not hold a set value

See also

diff --git a/doc/TypeCommand.html b/doc/TypeCommand.html index 9311d324..3d30a991 100644 --- a/doc/TypeCommand.html +++ b/doc/TypeCommand.html @@ -28,7 +28,7 @@

TYPE _key_

Time complexity: O(1)
Return the type of the value stored at key in form of astring. The type can be one of "none", "string", "list", "set"."none" is returned if the key does not exist.
-

Return value

Single line reply, specifically:

+
Return value
Status code reply, specifically:

 "none" if the key does not exist
 "string" if the key contains a String value
 "list" if the key contains a List value
diff --git a/doc/UnstableSource.html b/doc/UnstableSource.html
index 805f7f34..90afdfa3 100644
--- a/doc/UnstableSource.html
+++ b/doc/UnstableSource.html
@@ -29,6 +29,7 @@
                     
Get the latest Redis source code
Unstable code

 The development version of Redis is hosted here at Github, have fun cloning the source code with Git. If you are not familar with Git just use the download button to get a tarball.
Stable code

 Warning: the development source code is only intended for people that want to develop Redis or absolutely need the latest features still not available on the stable releases. You may have a better experience with the latest stable tarball.
+