RedisClient
Related Docs:
object RedisClient
| package redis
This is one of the aforementioned special commands.
This is one of the aforementioned special commands. Zadd takes a host of arguments versions >= 3.0.2, as noted in http://redis.io/commands/zadd Since this API *tries* to be redis version agnostic, it doesn't have them formally in its function definition, but they can be passed in at the beginning of the valuesAndArguments varargs parameter:
client.zadd("key", "XX", "CH" "1", "a"....
Also, since these flags can change the return type, can be a Long in some cases and a Double in others, a Double is returned to capture both cases.
Another command which takes optional arguments.
Another command which takes optional arguments. Tack on additional arguments into the keysAndArguments varargs. http://redis.io/commands/zinterstore
client.zinterstore(key, 2, keyA, keyB, "WEIGHTS", "1", "2", "AGGREGATE" "SUM")
This command can take a 'withscores' additional argument at the end.
This command can take a 'withscores' additional argument at the end. It changes what is included in the the results.
http://redis.io/commands/zrange
For now, this function is a bit raw, and a future change will have 2 versions of this function.
Additional arguments for this function are the limit/offset/count options.
Additional arguments for this function are the limit/offset/count options.
http://redis.io/commands/zrangebylex
Additional arguments for this function are the limit/offset/count options.
Additional arguments for this function are the limit/offset/count options.
http://redis.io/commands/zrangebyscore
This command can take a 'withscores' additional argument at the end.
This command can take a 'withscores' additional argument at the end. It changes what is included in the the results.
http://redis.io/commands/zrevrange
For now, this function is a bit raw, and a future change will have 2 versions of this function.
Additional arguments for this function are the limit/offset/count options.
Additional arguments for this function are the limit/offset/count options.
http://redis.io/commands/zrevrangebylex
Additional arguments for this function are the limit/offset/count options.
Additional arguments for this function are the limit/offset/count options.
http://redis.io/commands/zrevrangebyscore
Another command which takes optional arguments.
Another command which takes optional arguments. Tack on additional arguments into the keysAndArguments varargs. http://redis.io/commands/zunionstore
client.zunionstore(key, 2, keyA, keyB, "WEIGHTS", "1", "2", "AGGREGATE" "SUM")
This trait houses the Redis API. It contains implementations for most(not all) commands. In particular, this trait makes a best attempt at providing all implementations for: - Key commands - String commands - Hash commands - List commands - Set commands - Zset commands
Commands not implemented yet are
Just because these commands are not implemented, doesn't mean they cannot be used. The implementors of this trait provide a generic 'execute' command, which allows for the execution of arbitrary colossus.protocols.redis.Commandobjects. The calling code is responsible for handling the raw colossus.protocols.redis.Reply.
In some cases if a command can return an optional response(ie: a bulk reply or nil reply, like 'get'), 2 variants are provided. One which will return the data directly, and fail if its not there, and another which returns an Option. This is done to provide the user with some flexibility in how they query data. The point being, if you want to query and fail on non existence, you don't have to deal w/ an intermediate Option.
No camelcase? Yea..camelcasing redis commands looked and felt weird. MGet? mGet? mget? mSetNx? msetNX? etc. So, since all redis commands are uppercased(at least in the docs), I went with all lower case for the API. I just wanted something consistent looking. The only camelcasing is for the functions which return options ie: getOption.
This trait tries its best to be redis version agonstic. It doesn't know anything about the version of redis you are communicating with, so, for example, if an 'hstrlen' command is issued to a redis server that's < 3.2, you will get an Exception.
Some commands(mainly zset commands) have additional arguments which alter its behavior. Instead of trying to capture all the argument combinations the function provides a varargs ByteString so that the user can provide whatever trailing flags or options they want. Each command which has this behavior is noted in its docs.