Client
Related Docs:
object Client
| package redis
Appends value at the given key.
Appends value at the given key. If key doesn't exist, behavior is similar to SET command
length of string after append operation
Authorizes to db
Authorizes to db
Sets field value pair in the given btree sorted set key
Sets field value pair in the given btree sorted set key
1 if field is new, 0 if field was updated
Returns the btree sorted set cardinality for the given key
Returns the btree sorted set cardinality for the given key
Integer representing cardinality of btree sorted set, or 0 if key does not exist
Gets the value for the field from the given btree sorted set key
Gets the value for the field from the given btree sorted set key
Value if field exists
Gets all field value pairs for the given btree sorted order key from startField to endField
Gets all field value pairs for the given btree sorted order key from startField to endField
Sequence of field/value pairs
Deletes fields from the given btree sorted set key
Deletes fields from the given btree sorted set key
Number of fields deleted
Count the number of set bits (population counting) in a string.
Count the number of set bits (population counting) in a string.
optional index bytes starting from.
optional index bytes of the end.
The number of bits set to 1.
http://redis.io/commands/bitcount
Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.
operation type, one of AND/OR/XOR/NOT.
destination key.
source keys perform the operation between.
The size of the string stored in the destination key, that is equal to the size of the longest input string.
http://redis.io/commands/bitop
Decremts number stored at key by 1.
Decrements number stored at key by given amount.
Decrements number stored at key by given amount. If key doesn't exist, value is set to 0 before the operation
value after decrement. Error if key contains value of the wrong type
Removes keys
Serialize the value stored at key in a Redis-specific format and returns it to the user
Serialize the value stored at key in a Redis-specific format and returns it to the user
bytes, or none if the key did not exist
Checks if given key exists
Sets how long it will take the key to expire
Sets how long it will take the key to expire
boolean, true if it successfully set the ttl (time to live) on a valid key, false otherwise.
Same effect and semantic as "expire", but takes an absolute Unix timestamp
Same effect and semantic as "expire", but takes an absolute Unix timestamp
time-to-live as unix timestamp
boolean, true if it successfully set the ttl (time to live) on a valid key, false otherwise.
Deletes all keys in all databases
Deletes all keys in all databases
Deletes all keys in current DB
Deletes all keys in current DB
Gets the value associated with the given key
Gets the value associated with the given key
value, or none if key doesn't exist
Returns the bit value at offset in the string value stored at key.
Returns the bit value at offset in the string value stored at key.
the bit value stored at offset.
http://redis.io/commands/getbit
Gets the substring of the value associated with given key
Gets the substring of the value associated with given key
substring, or none if key doesn't exist
Atomically sets key to value and returns the old value stored at key.
Atomically sets key to value and returns the old value stored at key. Returns an error when key exists but does not hold a string value.
the old value stored at key wrapped in Some, or None when key did not exist.
http://redis.io/commands/getset
Deletes fields from given hash
Determine if a hash field exists
Determine if a hash field exists
true if key field exists, false otherwise
Gets field from hash
Gets all field value pairs for given hash
Gets all field value pairs for given hash
Sequence of field/value pairs
Increment a field by a value
Return all field names stored at key
Gets values for given fields in hash
Sets values for given fields in hash
Sets values for given fields in hash
hash key
map of field to value
http://redis.io/commands/hmset
Returns keys in given hash, starting at cursor
Returns keys in given hash, starting at cursor
cursor followed by matching keys
Sets field value pair in given hash
Sets field value pair in given hash
1 if field is new, 0 if field was updated
Sets field value pair in given hash only if the field does not yet exist
Sets field value pair in given hash only if the field does not yet exist
1 if field is new, 0 if no operation was performed
Gets the values of all fields in given hash
Gets the values of all fields in given hash
list of values, or empty list when key does not exist
Increments the number stored at key by one.
Increments the number stored at key by one.
the value of key after the increment.
http://redis.io/commands/incr
Increments the number stored at key by increment.
Increments the number stored at key by increment.
the value of key after the increment.
http://redis.io/commands/incrby
Returns information and statistics about the server
Returns information and statistics about the server
Optional parameter can be used to select a specific section of information
ChannelBuffer with collection of \r\n terminated lines if server has info on section
Returns all keys matching pattern
Gets the value of the element at the indexth position in the list.
Gets the value of the element at the indexth position in the list. If the key is a non-list element, an exception will be thrown.
an option of the value of the element at the indexth position in the list. Nothing if the index is out of range.
Inserts a value after another pivot value in the list.
Inserts a value after another pivot value in the list. If the key is a non-list element, an exception will be thrown.
an option of the new length of the list, or nothing if the pivot is not found, or the list is empty.
Inserts a value before another pivot value in the list.
Inserts a value before another pivot value in the list. If the key is a non-list element, an exception will be thrown.
an option of the new length of the list, or nothing if the pivot is not found, or the list is empty.
Gets the length of the list.
Gets the length of the list. If the key is a non-list element, an exception will be thrown.
the length of the list. Unassigned keys are considered empty lists, and return 0.
Pops a value off the front of the list.
Pops a value off the front of the list. If the key is a non-list element, an exception will be thrown.
an option of the value of the popped element, or nothing if the list is empty.
Pushes a value onto the front of the list.
Pushes a value onto the front of the list. If the key is a non-list element, an exception will be thrown.
the length of the list
Gets the values in the range supplied.
Gets the values in the range supplied. If the key is a non-list element, an exception will be thrown.
(inclusive)
(inclusive)
a list of the value
Removes count elements matching value from the list.
Removes count elements matching value from the list. If the key is a non-list element, an exception will be thrown.
the number of removed elements.
The sign of count describes whether it will remove them from the
back or the front of the list. If count is 0, it will remove all instances, value
Sets the indexth element to be value.
Sets the indexth element to be value. If the key is a non-list element, an exception will be thrown.
Removes all of the elements from the list except for those in the range.
Removes all of the elements from the list except for those in the range.
(inclusive)
(exclusive)
Returns the values of all specified keys.
Returns the values of all specified keys.
list of values at the specified keys.
http://redis.io/commands/mget
Sets the given keys to their respective values.
Sets the given keys to their respective values. MSET replaces existing values with new values, just as regular SET.
http://redis.io/commands/mset
Sets the given keys to their respective values.
Sets the given keys to their respective values. MSETNX will not perform any operation at all even if just a single key already exists.
1 if all keys were set, 0 if no keys were set.
http://redis.io/commands/msetnx
Move key from the currently selected database to the specified destination database.
Move key from the currently selected database to the specified destination database. When key already exists in the destination database, or it does not exist in the source database, it does nothing.
true if key was moved. false if key was not moved for any reason.
Set a key's time to live in milliseconds.
Set a key's time to live in milliseconds.
true if the timeout was set. false if key does not exist or the timeout could not be set.
http://redis.io/commands/pexpire
Set the expiration for a key as a UNIX timestamp specified in milliseconds.
Set the expiration for a key as a UNIX timestamp specified in milliseconds.
true if the timeout was set. false if key does not exist or the timeout could not be set (see: EXPIRE).
http://redis.io/commands/pexpireat
Works exactly like SETEX with the sole difference that the expire time is specified in milliseconds instead of seconds.
Works exactly like SETEX with the sole difference that the expire time is specified in milliseconds instead of seconds.
http://redis.io/commands/psetex
Get the time to live for a key in milliseconds.
Get the time to live for a key in milliseconds.
Time to live in milliseconds or None when key does not exist or does not have a timeout.
Adds elements to a HyperLogLog data structure.
Adds elements to a HyperLogLog data structure.
True if a bit was set in the HyperLogLog data structure
http://redis.io/commands/pfadd
Get the approximated cardinality of sets observed by the HyperLogLog at key(s)
Get the approximated cardinality of sets observed by the HyperLogLog at key(s)
Approximated number of unique elements
http://redis.io/commands/pfcount
Merge HyperLogLogs at srcKeys to create a new HyperLogLog at destKey
Merge HyperLogLogs at srcKeys to create a new HyperLogLog at destKey
http://redis.io/commands/pfmerge
Closes connection to Redis instance
Closes connection to Redis instance
Pops a value off the end of the list.
Pops a value off the end of the list. If the key is a non-list element, an exception will be thrown.
an option of the value of the popped element, or nothing if the list is empty.
Pushes a value onto the end of the list.
Pushes a value onto the end of the list. If the key is a non-list element, an exception will be thrown.
the length of the list
Releases underlying service object
Releases underlying service object
Adds elements to the set, according to the set property.
Adds elements to the set, according to the set property. Throws an exception if the key does not refer to a set.
the number of new members added to the set.
How many elements are in the set? Throws an exception if the key does not refer to a set.
How many elements are in the set? Throws an exception if the key does not refer to a set.
the number of elements in the set. Unassigned keys are considered empty sets.
Returns the members of the set resulting from the intersection of all the given sets.
Returns the members of the set resulting from the intersection of all the given sets.
Keys that do not exist are considered to be empty sets. With one of the keys being an empty set, the resulting set is also empty (since set intersection with an empty set always results in an empty set).
Throws an exception if the keys Seq is empty or if any of the keys
passed as params are empty.
list of keys to intersect
set of members from the resulting intersection
Is the member in the set? Throws an exception if the key does not refer to a set.
Is the member in the set? Throws an exception if the key does not refer to a set.
a boolean, true if it is in the set, false otherwise. Unassigned keys are considered empty sets.
Gets the members of the set.
Gets the members of the set. Throws an exception if the key does not refer to a set.
a list of the members
Removes an element randomly from the set, and returns it.
Removes an element randomly from the set, and returns it. Throws an exception if the key does not refer to a set.
the member, or nothing if the set is empty.
Returns a list of random entries from the set.
Returns a list of random entries from the set. If the count is positive, a set is returned, otherwise a list that may contain duplicates is returned.
a sequence with count random entries from the set
Removes the element from the set if it is in the set.
Removes the element from the set if it is in the set. Throws an exception if the key does not refer to a set.
an integer, the number of elements removed from the set, can be 0 if the key is unassigned.
Returns keys starting at cursor
Select DB with specified zero-based index
Select DB with specified zero-based index
Sets the given value to key.
Sets the given value to key. If a value already exists for the key, the value is overwritten with the new value
Sets or clears the bit at offset in the string value stored at key.
Sets or clears the bit at offset in the string value stored at key.
the original bit value stored at offset.
http://redis.io/commands/setbit
Set key to hold the string value and set key to timeout after a given number of seconds.
Set key to hold the string value and set key to timeout after a given number of seconds.
http://redis.io/commands/setex
Set key to hold the string value with the specified expire time in seconds only if the key does not already exist.
Set key to hold the string value with the specified expire time in seconds only if the key does not already exist.
true if the key was set, false if condition was not met.
http://redis.io.commands/set
Set key to hold the string value with the specified expire time in seconds only if the key already exist.
Set key to hold the string value with the specified expire time in seconds only if the key already exist.
true if the key was set, false if condition was not met.
http://redis.io.commands/set
Set key to hold string value if key does not exist.
Set key to hold string value if key does not exist. In that case, it is equal to SET. When key already holds a value, no operation is performed.
1 if the key was set, 0 if the key was not set.
http://redis.io/commands/setnx
Set key to hold the string value with the specified expire time in milliseconds.
Set key to hold the string value with the specified expire time in milliseconds.
http://redis.io.commands/set
Set key to hold the string value with the specified expire time in milliseconds only if the key does not already exist.
Set key to hold the string value with the specified expire time in milliseconds only if the key does not already exist.
true if the key was set, false if condition was not met.
http://redis.io.commands/set
Set key to hold the string value with the specified expire time in milliseconds only if the key already exist.
Set key to hold the string value with the specified expire time in milliseconds only if the key already exist.
true if the key was set, false if condition was not met.
http://redis.io.commands/set
Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value.
Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value.
the length of the string after it was modified.
http://redis.io/commands/setrange
Set key to hold the string value only if the key already exist.
Set key to hold the string value only if the key already exist.
true if the key was set, false if condition was not met.
http://redis.io.commands/set
returns the length of the string value stored at key.
returns the length of the string value stored at key.
the length of the string at key, or 0 when key does not exist.
http://redis.io/commands/strlen
Gets the ttl of the given key.
Gets the ttl of the given key.
Option containing either the ttl in seconds if the key exists and has a timeout, or else nothing.
Add a member with score to a sorted set
Add a member with score to a sorted set
Number of elements added to sorted set
Adds member, score pairs to sorted set
Adds member, score pairs to sorted set
sequence of (score, member) tuples
Number of elements added to sorted set
Adding multiple elements only works with redis 2.4 or later.
Returns sorted set cardinality of the sorted set at key
Returns sorted set cardinality of the sorted set at key
Integer representing cardinality of sorted set, or 0 if key does not exist
Gets number of elements in sorted set with score between min and max
Gets number of elements in sorted set with score between min and max
Number of elements between min and max in sorted set
Increment the member in sorted set key by amount.
Increment the member in sorted set key by amount. Returns an option, None if the member is not found, or the set is empty, or the new value. Throws an exception if the key refers to a structure that is not a sorted set.
the new value of the incremented member
Returns specified range of elements in sorted set at key.
Returns specified range of elements in sorted set at key. Elements are ordered from lowest to highest score.
ZRangeResults object containing item/score pairs
Gets member, score pairs from sorted set between min and max Results are limited by offset and count
Gets member, score pairs from sorted set between min and max Results are limited by offset and count
ZRangeResults object containing item/score pairs
Gets the rank of the member in the sorted set, or None if it doesn't exist, from low to high.
Gets the rank of the member in the sorted set, or None if it doesn't exist, from low to high.
the rank of the member
Removes specified member(s) from sorted set at key
Removes specified member(s) from sorted set at key
Number of members removed from sorted set
Removes members from sorted set by sort order, from start to stop, inclusive.
Removes members from sorted set by sort order, from start to stop, inclusive.
Number of members removed from sorted set.
Removes members from sorted set by score, from min to max, inclusive.
Removes members from sorted set by score, from min to max, inclusive.
Number of members removed from sorted set.
Returns specified range of elements in sorted set at key Elements are ordered from highest to lowest score
Returns specified range of elements in sorted set at key Elements are ordered from highest to lowest score
List of elements in specified range
Returns elements in sorted set at key with a score between max and min Elements are ordered from highest to lowest score Results are limited by offset and count
Returns elements in sorted set at key with a score between max and min Elements are ordered from highest to lowest score Results are limited by offset and count
ZRangeResults object containing item/score pairs
Gets the rank of member in the sorted set, or None if it doesn't exist, from high to low.
Gets the rank of member in the sorted set, or None if it doesn't exist, from high to low.
the rank of the member
Gets score of member in sorted set