Browse Source

ndb_redis: redis_cmd variadic function documentation.

Vicente Hernando 13 years ago
parent
commit
1010594cf1
1 changed files with 17 additions and 2 deletions
  1. 17 2
      modules/ndb_redis/doc/ndb_redis_admin.xml

+ 17 - 2
modules/ndb_redis/doc/ndb_redis_admin.xml

@@ -100,14 +100,19 @@ modparam("ndb_redis", "server", "name=srvY;unix=/tmp/redis.sock;db=3")
 	<title>Functions</title>
 	<section>
 	    <title>
-		<function moreinfo="none">redis_cmd(srvname, command, replyid)</function>
+		<function moreinfo="none">redis_cmd(srvname, command, ..., replyid)</function>
 	    </title>
 	    <para>
 			Send a command to REDIS server identified by srvname. The reply will
-			be stored in a local continer identified by replyid. All the
+			be stored in a local container identified by replyid. All the
 			parameters can be strings with pseudo-variables that are evaluated
 			at runtime.
 		</para>
+		<para>
+			Minimum required arguments are srvname, command and replyid. Command argument
+			can be separated into several ones using %s token. (See examples)
+			Total number of arguments cannot exceed six.
+		</para>
 		<para>
 			The reply can be accessed via pseudo-variable $redis(key). The key
 			can be: type - type of the reply (as in hiredis.h); value - the value
@@ -154,6 +159,16 @@ redis_cmd("srvN", "SET ruri $ru", "r");
 # get a value
 redis_cmd("srvN", "GET foo", "r");
 
+# same command separated into two arguments:
+redis_cmd("srvN", "GET %s", "foo", "r");
+
+# if we have a key with spaces within it:
+redis_cmd("srvN", "GET %s", "foo bar", "r");
+
+# several values substitution:
+redis_cmd("srvN", "HMGET %s %s %s", "key1", "field1", "field2", "r");
+
+
 # array example
 if(redis_cmd("srvN", "HMGET foo_key field1 field3", "r")) {
     xlog("array size: $redis(r=>size)\n");