vibe.d beta banner
get vibe.d
0.9.0

Asynchronous I/O that doesn’t get in your way, written in D

Struct RedisDatabase

Accesses the contents of a Redis database

struct RedisDatabase ;

Properties

NameTypeDescription
client[get] inout(RedisClient)The Redis client with which the database is accessed.
index[get] longIndex of the database.

Methods

NameDescription
append (key, suffix) Append a value to a key
blpop (key, seconds) BLPOP is a blocking list pop primitive. It is the blocking version of LPOP because it blocks the connection when there are no elements to pop from any of the given lists.
dbSize () Return the number of keys in the selected database
decr (key, value) Decrement the integer value of a key by one
del (keys) Delete a key
deleteAll () Deletes all keys of the database.
eval (lua_code, keys, args) Execute a Lua script server side
evalSHA (sha, keys, args) Evaluates a script cached on the server side by its SHA1 digest. Scripts are cached on the server side using the scriptLoad function.
exists (key) Determine if a key exists
expire (key, seconds) Set a key's time to live in seconds
expire (key, timeout) Set a key's time to live with D notation. E.g. 5.minutes for 60 * 5 seconds.
expireAt (key, timestamp) Set the expiration for a key as a UNIX timestamp
get (key) Get the value of a key
getBit (key, offset) Returns the bit value at offset in the string value stored at key
getRange (key, start, end) Get a substring of the string stored at a key
getSet (key, value) Set the string value of a key and return its old value
hdel (key, fields) Delete one or more hash fields
hexists (key, field) Determine if a hash field exists
hget (key, field) Get the value of a hash field.
hgetAll (key) Get all the fields and values in a hash
hincr (key, field, value) Increment the integer value of a hash field
hincr (key, field, value) Increment the real number value of a hash field
hkeys (key) Get all the fields in a hash
hlen (key) Get the number of fields in a hash
hmget () Get the values of all the given hash fields
hmset (key, args) Set multiple hash fields to multiple values
hset (key, field, value) Set multiple hash fields to multiple values
hsetNX (key, field, value) Set the value of a hash field, only if the field does not exist
hvals (key) Get all the values in a hash
incr (key, value) Increment the integer value of a key
incr (key, value) Increment the real number value of a key
keys (pattern) Find all keys matching the given glob-style pattern (Supported wildcards: *, ?, [ABC])
lindex (key, index) Get an element from a list by its index
linsertAfter (key, pivot, value) Insert value in the list stored at key after the reference value pivot.
linsertBefore (key, pivot, value) Insert value in the list stored at key before the reference value pivot.
llen (key) Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.
lpop (key) Removes and returns the first element of the list stored at key.
lpush (key, args) Insert all the specified values at the head of the list stored at key.
lpushX (key, value) Inserts value at the head of the list stored at key, only if key already exists and holds a list.
lrange (key, start, stop) Returns the specified elements of the list stored at key.
lrem (key, count, value) Removes the first count occurrences of elements equal to value from the list stored at key.
lset (key, index, value) Sets the list element at index to value.
ltrim (key, start, stop) Trim an existing list so that it will contain only the specified range of elements specified. Equivalent to range = range[start .. stop+1]
mget (keys) Get the values of all the given keys
move (key, db) Move a key to another database
mset (args) Set multiple keys to multiple values
msetNX (args) Set multiple keys to multiple values, only if none of the keys exist
persist (key) Remove the expiration from a key
pfadd (key, args) Adds one or more Keys to a HyperLogLog data structure .
pfcount (keys) Returns the approximated cardinality computed by the HyperLogLog data structure stored at the specified key.
pfmerge (destkey, args) Merge multiple HyperLogLog values into a new one.
pttl (key) Get the time to live for a key in milliseconds
publish (channel, message) Publishes a message to all clients subscribed at the channel
pubsub () Inspect the state of the Pub/Sub subsystem
randomKey () Return a random key from the keyspace
rename (key, newkey) Rename a key
renameNX (key, newkey) Rename a key, only if the new key does not exist
request (command, args) Run the specified command and arguments in the Redis database server
rpop (key) Removes and returns the last element of the list stored at key.
rpoplpush (key, destination) Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
rpush (key, args) Insert all the specified values at the tail of the list stored at key.
rpushX (key, value) Inserts value at the tail of the list stored at key, only if key already exists and holds a list.
sadd (key, args) Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.
scard (key) Returns the set cardinality (number of elements) of the set stored at key.
scriptLoad (lua_code) Load a script into the scripts cache, without executing it. Run it using evalSHA.
sdiff () Returns the members of the set resulting from the difference between the first set and all the successive sets.
sdiffStore (destination, keys) This command is equal to SDIFF, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
set (key, value) Set the string value of a key
setBit (key, offset, value) Sets or clears the bit at offset in the string value stored at key
setEX (key, seconds, value) Set the value and expiration of a key
setNX (key, value) Set the value of a key, only if the key does not exist
setNX (key, value, expire_time) Set the value of a key, only if the key does not exist, and also set the specified expire time using D notation, e.g. 5.minutes for 5 minutes.
setRange (key, offset, value) Overwrite part of a string at key starting at the specified offset
setXX (key, value) Set the value of a key, only if the key already exists
setXX (key, value, expire_time) Set the value of a key, only if the key already exists, and also set the specified expire time using D notation, e.g. 5.minutes for 5 minutes.
sinter (keys) Returns the members of the set resulting from the intersection of all the given sets.
sinterStore (destination, keys) This command is equal to SINTER, but instead of returning the resulting set, it is stored in destination. If destination already exists, it is overwritten.
sisMember (key, member) Returns if member is a member of the set stored at key.
smembers (key) Returns all the members of the set value stored at key.
smove (source, destination, member) Move member from the set at source to the set at destination. This operation is atomic. In every given moment the element will appear to be a member of source or destination for other clients.
spop (key) Removes and returns a random element from the set value stored at key.
srandMember (key) Returns a random element from the set stored at key.
srandMember (key, count) returns count random elements from the set stored at key
srem (key, args) Remove the specified members from the set stored at key.
strlen (key) Get the length of the value stored in a key
sunion () Returns the members of the set resulting from the union of all the given sets.
sunionStore (keys) This command is equal to SUNION, but instead of returning the resulting set, it is stored in destination.
ttl (key) Get the time to live for a key
type (key) Determine the type stored at key (string, list, set, zset and hash.)
zadd (key, args) Add one or more members to a sorted set, or update its score if it already exists
zcard (key) Returns the sorted set cardinality (number of elements) of the sorted set stored at key.
zcount (key, min, max) Returns the number of elements in the sorted set at key with a score between min and max
zincrby (key, value, member) Increments the score of member in the sorted set stored at key by increment.
zrange (key, start, end, with_scores) Returns the specified range of elements in the sorted set stored at key.
zrangeByLex (key, min, max, offset, count) When all the elements in a sorted set are inserted with the same score, in order to force lexicographical ordering, this command returns all the elements in the sorted set at key with a value between min and max.
zrangeByScore (key, start, end, with_scores) Returns all the elements in the sorted set at key with a score between start and end inclusively
zrangeByScore (key, start, end, offset, count, with_scores) Computes an internal list of elements in the sorted set at key with a score between start and end inclusively, and returns a range subselection similar to results[offset .. offset+count]
zrank (key, member) Returns the rank of member in the sorted set stored at key, with the scores ordered from low to high.
zrem (key, members) Removes the specified members from the sorted set stored at key.
zremRangeByRank (key, start, stop) Removes all elements in the sorted set stored at key with rank between start and stop.
zremRangeByScore (key, min, max) Removes all elements in the sorted set stored at key with a score between min and max (inclusive).
zrevRange (key, start, end, with_scores) Returns the specified range of elements in the sorted set stored at key.
zrevRangeByScore (key, min, max, with_scores) Returns all the elements in the sorted set at key with a score between max and min (including elements with score equal to max or min).
zrevRangeByScore (key, min, max, offset, count, with_scores) Computes an internal list of elements in the sorted set at key with a score between max and min, and returns a window of elements selected in a way equivalent to results[offset .. offset + count]
zrevRank (key, member) Returns the rank of member in the sorted set stored at key, with the scores ordered from high to low.
zscore (key, member) Returns the score of member in the sorted set at key.
Authors

Jan Krüger, Sönke Ludwig, Michael Eisendle, Etienne Cimon

Copyright

© 2012-2016 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.