object Redis extends RedisKey with RedisHash with RedisList with RedisPubSub with RedisSet with RedisSortedSet with RedisStream with RedisString with RedisServer
An object that provides an aggregation of all the different Redis Apis. They can be equally accessed independently or from this object.
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) use the pure
monix.connect.redis.client.RedisConnection
- Source
- Redis.scala
- Alphabetic
- By Inheritance
- Redis
- RedisServer
- RedisString
- RedisStream
- RedisSortedSet
- RedisSet
- RedisPubSub
- RedisList
- RedisHash
- RedisKey
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def append[K, V](key: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Append a value to a key.
Append a value to a key.
- returns
The length of the string after the append operation.
- Definition Classes
- RedisString
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bgrewriteaof[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[String]
Asynchronously rewrite the append-only file.
Asynchronously rewrite the append-only file.
- returns
Always OK.
- Definition Classes
- RedisServer
- def bgsave[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[String]
Asynchronously save the dataset to disk.
Asynchronously save the dataset to disk.
- returns
Simple string reply
- Definition Classes
- RedisServer
- def bitcount[K, V](key: K, start: Long, end: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Count set bits in a string.
Count set bits in a string.
- returns
The number of bits set to 1.
- Definition Classes
- RedisString
- def bitcount[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Count set bits in a string.
Count set bits in a string.
- returns
The number of bits set to 1.
- Definition Classes
- RedisString
- def bitopAnd[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Perform bitwise AND between strings.
Perform bitwise AND between strings.
- returns
The size of the string stored in the destination key, that is equal to the size of the longest input string.
- Definition Classes
- RedisString
- def bitopNot[K, V](destination: K, source: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Perform bitwise NOT between strings.
Perform bitwise NOT between strings.
- returns
The size of the string stored in the destination key, that is equal to the size of the longest input string.
- Definition Classes
- RedisString
- def bitopOr[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Perform bitwise OR between strings.
Perform bitwise OR between strings.
- returns
The size of the string stored in the destination key, that is equal to the size of the longest input string.
- Definition Classes
- RedisString
- def bitopXor[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Perform bitwise XOR between strings.
Perform bitwise XOR between strings.
- returns
The size of the string stored in the destination key, that is equal to the size of the longest input string.
- Definition Classes
- RedisString
- def bitpos[K, V](key: K, state: Boolean, start: Long, end: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Find first bit set or clear in a string.
Find first bit set or clear in a string.
- returns
The command returns the position of the first bit set to 1 or 0 according to the request.
- Definition Classes
- RedisString
- def bitpos[K, V](key: K, state: Boolean, start: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Find first bit set or clear in a string.
Find first bit set or clear in a string.
- returns
The command returns the position of the first bit set to 1 or 0 according to the request.
- Definition Classes
- RedisString
- def bitpos[K, V](key: K, state: Boolean)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Find first bit set or clear in a string.
Find first bit set or clear in a string.
- returns
The command returns the position of the first bit set to 1 or 0 according to the request.
- Definition Classes
- RedisString
- def blpop[K, V](timeout: Long, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[KeyValue[K, V]]
Remove and get the first element in a list, or block until one is available.
Remove and get the first element in a list, or block until one is available.
- returns
A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.
- Definition Classes
- RedisList
- def brpop[K, V](timeout: Long, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[KeyValue[K, V]]
Remove and get the last element in a list, or block until one is available.
Remove and get the last element in a list, or block until one is available.
- returns
A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.
- Definition Classes
- RedisList
- def brpoplpush[K, V](timeout: Long, source: K, destination: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Pop a value from a list, push it to another list and return it; or block until one is available.
Pop a value from a list, push it to another list and return it; or block until one is available.
- returns
The element being popped from source and pushed to destination.
- Definition Classes
- RedisList
- def bzpopmax[K, V](timeout: Long, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[KeyValue[K, ScoredValue[V]]]
Removes and returns a member with the highest scores in the sorted set stored at one of the keys.
Removes and returns a member with the highest scores in the sorted set stored at one of the keys.
- returns
Multi-bulk containing the name of the key, the score and the popped member.
- Definition Classes
- RedisSortedSet
- def bzpopmin[K, V](timeout: Long, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[KeyValue[K, ScoredValue[V]]]
Removes and returns a member with the lowest scores in the sorted set stored at one of the keys.
Removes and returns a member with the lowest scores in the sorted set stored at one of the keys.
- returns
Multi-bulk containing the name of the key, the score and the popped member.
- Definition Classes
- RedisSortedSet
- def clientGetname[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[String]
Get the current connection name.
Get the current connection name.
- returns
The connection name, or a null bulk reply if no name is set.
- Definition Classes
- RedisServer
- def clientKill[K, V](addr: String)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Kill the connection of a client identified by ip:port.
Kill the connection of a client identified by ip:port.
- returns
OK if the connection exists and has been closed.
- Definition Classes
- RedisServer
- def clientList[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[String]
Get the list of client connections.
Get the list of client connections.
- returns
A unique string, formatted as follows: One client connection per line (separated by LF), each line is composed of a succession of property=value fields separated by a space character.
- Definition Classes
- RedisServer
- def clientSetname[K, V](name: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the current connection name.
Set the current connection name.
- returns
OK if the connection name was successfully set.
- Definition Classes
- RedisServer
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def commandCount[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get total number of Redis commands.
Get total number of Redis commands.
- returns
Number of total commands in this Redis server.
- Definition Classes
- RedisServer
- def configGet[K, V](parameter: String)(implicit connection: StatefulRedisConnection[K, V]): Task[Map[String, String]]
Get the value of a configuration parameter.
Get the value of a configuration parameter.
- returns
Bulk string reply
- Definition Classes
- RedisServer
- def configResetstat[K, V](implicit connection: StatefulRedisConnection[K, V]): Task[String]
Reset the stats returned by INFO.
Reset the stats returned by INFO.
- returns
Always OK.
- Definition Classes
- RedisServer
- def decr[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Decrement the integer value of a key by one.
Decrement the integer value of a key by one.
- returns
The value of key after the decrement
- Definition Classes
- RedisString
- def decrby[K, V](key: K, amount: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Decrement the integer value of a key by the given number.
Decrement the integer value of a key by the given number.
- returns
The value of key after the decrement.
- Definition Classes
- RedisString
- def del[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Delete one or more keys.
Delete one or more keys.
- returns
The number of keys that were removed.
- Definition Classes
- RedisKey
- def dump[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Array[Byte]]
Return a serialized version of the value stored at the specified key.
Return a serialized version of the value stored at the specified key.
- returns
The serialized value.
- Definition Classes
- RedisKey
- def echo[K, V](msg: V)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Echo the given string.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def exists[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Determine how many keys exist.
Determine how many keys exist.
- returns
Number of existing keys
- Definition Classes
- RedisKey
- def expire[K, V](key: K, seconds: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set a key's time to live in seconds.
Set a key's time to live in seconds.
- returns
True if the timeout was set. false if key does not exist or the timeout could not be set.
- Definition Classes
- RedisKey
- def expireat[K, V](key: K, timestamp: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
- Definition Classes
- RedisKey
- def expireat[K, V](key: K, timestamp: Date)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set the expiration for a key as a UNIX timestamp.
Set the expiration for a key as a UNIX timestamp.
- returns
True if the timeout was set. False if key does not exist or the timeout could not be set.
- Definition Classes
- RedisKey
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def flushallAsync[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Remove all keys from all databases.
Remove all keys from all databases.
- returns
Simple string reply
- Definition Classes
- RedisServer
- def flushdbAsync[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Remove all keys reactivehronously from the current database.
Remove all keys reactivehronously from the current database.
- returns
Single string reply
- Definition Classes
- RedisServer
- def get[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Get the value of a key.
Get the value of a key.
- returns
The value of key, or null when key does not exist.
- Definition Classes
- RedisString
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getbit[K, V](key: K, offset: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
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.
- returns
The bit value stored at offset.
- Definition Classes
- RedisString
- def getrange[K, V](key: K, start: Long, end: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Get a substring of the string stored at a key.
Get a substring of the string stored at a key.
- returns
Bulk string reply.
- Definition Classes
- RedisString
- def getset[K, V](key: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Set the string value of a key and return its old value.
Set the string value of a key and return its old value.
- returns
The old value stored at key, or null when key did not exist.
- Definition Classes
- RedisString
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hdel[K, V](key: K, fields: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Delete one or more hash fields.
Delete one or more hash fields.
- returns
Number of fields that were removed from the hash, not including specified but non existing fields.
- Definition Classes
- RedisHash
- def hexists[K, V](key: K, field: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Determine if a hash field exists.
Determine if a hash field exists.
- returns
True if the hash contains the field. False if the hash does not contain the field, or key does not exist. .
- Definition Classes
- RedisHash
- def hget[K, V](key: K, field: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Get the value of a hash field.
Get the value of a hash field.
- returns
The value associated with field, or null when field is not present in the hash or key does not exist. A failed task with NoSuchElementException will be returned when the underlying api returns an empty publisher. i.e: when the key did not exist.
- Definition Classes
- RedisHash
- def hgetall[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[KeyValue[K, V]]
Get all the fields and values in a hash.
Get all the fields and values in a hash.
- key
the key
- returns
Map of the fields and their values stored in the hash, or an empty list when key does not exist.
- Definition Classes
- RedisHash
- def hincrby[K, V](key: K, field: K, amount: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Increment the integer value of a hash field by the given number.
Increment the integer value of a hash field by the given number.
- returns
The value at field after the increment operation.
- Definition Classes
- RedisHash
- def hincrbyfloat[K, V](key: K, field: K, amount: Double)(implicit connection: StatefulRedisConnection[K, V]): Task[Double]
Increment the float value of a hash field by the given amount.
Increment the float value of a hash field by the given amount.
- returns
The value of field after the increment.
- Definition Classes
- RedisHash
- def hkeys[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[K]
Get all the fields in a hash.
Get all the fields in a hash.
- returns
The fields in the hash.
- Definition Classes
- RedisHash
- def hlen[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the number of fields in a hash.
Get the number of fields in a hash.
- returns
Number of fields in the hash, or 0 when key does not exist.
- Definition Classes
- RedisHash
- def hmget[K, V](key: K, fields: K*)(implicit connection: StatefulRedisConnection[K, V]): Observable[KeyValue[K, V]]
Get the values of all the given hash fields.
Get the values of all the given hash fields.
- returns
Values associated with the given fields.
- Definition Classes
- RedisHash
- def hmset[K, V](key: K, map: Map[K, V])(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set multiple hash fields to multiple values.
Set multiple hash fields to multiple values.
- returns
Simple string reply.
- Definition Classes
- RedisHash
- def hscan[K, V](key: K, scanCursor: ScanCursor)(implicit connection: StatefulRedisConnection[K, V]): Task[MapScanCursor[K, V]]
- Definition Classes
- RedisHash
- def hscan[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[MapScanCursor[K, V]]
Incrementally iterate hash fields and associated values.
Incrementally iterate hash fields and associated values.
- returns
Map scan cursor.
- Definition Classes
- RedisHash
- def hset[K, V](key: K, field: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set the string value of a hash field.
Set the string value of a hash field.
- returns
True if field is a new field in the hash and value was set. False if field already exists in the hash and the value was updated.
- Definition Classes
- RedisHash
- def hsetnx[K, V](key: K, field: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set the value of a hash field, only if the field does not exist.
Set the value of a hash field, only if the field does not exist.
- returns
True if field is a new field in the hash and value was set. False if field already exists in the hash and the value was updated.
- Definition Classes
- RedisHash
- def hstrlen[K, V](key: K, field: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the string length of the field value in a hash.
Get the string length of the field value in a hash.
- returns
Length of the field value, or 0 when field is not present in the hash or key does not exist at all.
- Definition Classes
- RedisHash
- def hvals[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Get all the values in a hash.
Get all the values in a hash.
- returns
Values in the hash, or an empty list when key does not exist.
- Definition Classes
- RedisHash
- def incr[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Increment the integer value of a key by one.
Increment the integer value of a key by one.
- returns
The value of key after the increment.
- Definition Classes
- RedisString
- def incrby[K, V](key: K, amount: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Increment the integer value of a key by the given amount.
Increment the integer value of a key by the given amount.
- returns
The value of key after the increment.
- Definition Classes
- RedisString
- def incrbyfloat[K, V](key: K, amount: Double)(implicit connection: StatefulRedisConnection[K, V]): Task[Double]
Increment the float value of a key by the given amount.
Increment the float value of a key by the given amount.
- returns
Double bulk string reply the value of key after the increment.
- Definition Classes
- RedisString
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keys[K, V](pattern: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[K]
Find all keys matching the given pattern.
Find all keys matching the given pattern.
- returns
Keys matching the pattern.
- Definition Classes
- RedisKey
- def lindex[K, V](key: K, index: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Get an element from a list by its index.
Get an element from a list by its index.
- returns
The requested element, or null when index is out of range.
- Definition Classes
- RedisList
- def linsert[K, V](key: K, before: Boolean, pivot: V, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Insert an element before or after another element in a list.
Insert an element before or after another element in a list.
- returns
The length of the list after the insert operation, or -1 when the value pivot was not found.
- Definition Classes
- RedisList
- def llen[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the length of a list.
Get the length of a list.
- returns
Long integer-reply the length of the list at { @code key}.
- Definition Classes
- RedisList
- def lpop[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Remove and get the first element in a list.
Remove and get the first element in a list.
- returns
The value of the first element, or null when key does not exist.
- Definition Classes
- RedisList
- def lpush[K, V](key: K, values: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Prepend one or multiple values to a list.
Prepend one or multiple values to a list.
- returns
The length of the list after the push operations.
- Definition Classes
- RedisList
- def lpushx[K, V](key: K, values: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Prepend values to a list, only if the list exists.
Prepend values to a list, only if the list exists.
- returns
The length of the list after the push operation.
- Definition Classes
- RedisList
- def lrange[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Get a range of elements from a list.
Get a range of elements from a list.
- returns
List of elements in the specified range.
- Definition Classes
- RedisList
- def lrem[K, V](key: K, count: Long, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove elements from a list.
Remove elements from a list.
- returns
The number of removed elements.
- Definition Classes
- RedisList
- def lset[K, V](key: K, index: Long, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the value of an element in a list by its index.
Set the value of an element in a list by its index.
- returns
The same inserted value
- Definition Classes
- RedisList
- def ltrim[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Trim a list to the specified range.
Trim a list to the specified range.
- returns
Simple string reply
- Definition Classes
- RedisList
- def mget[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Observable[KeyValue[K, V]]
Get the values of all the given keys.
Get the values of all the given keys.
- returns
Values at the specified keys.
- Definition Classes
- RedisString
- def migrate[K, V](host: String, port: Int, key: K, db: Int, timeout: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Atomically transfer a key from a Redis instance to another one.
Atomically transfer a key from a Redis instance to another one.
- returns
The command returns OK on success.
- Definition Classes
- RedisKey
- def move[K, V](key: K, db: Int)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Move a key to another database.
Move a key to another database.
- returns
True if the move operation succeeded, false if not.
- Definition Classes
- RedisKey
- def mset[K, V](map: Map[K, V])(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set multiple keys to multiple values.
Set multiple keys to multiple values.
- returns
Always OK since MSET can't fail.
- Definition Classes
- RedisString
- def msetnx[K, V](map: Map[K, V])(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set multiple keys to multiple values, only if none of the keys exist.
Set multiple keys to multiple values, only if none of the keys exist.
- returns
True if the all the keys were set. False if no key was set (at least one key already existed).
- Definition Classes
- RedisString
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def objectEncoding[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
returns the kind of internal representation used in order to store the value associated with a key.
returns the kind of internal representation used in order to store the value associated with a key.
- returns
String
- Definition Classes
- RedisKey
- def objectIdletime[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Returns the number of seconds since the object stored at the specified key is idle (not requested by read or write operations).
Returns the number of seconds since the object stored at the specified key is idle (not requested by read or write operations).
- returns
Number of seconds since the object stored at the specified key is idle.
- Definition Classes
- RedisKey
- def objectRefcount[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Returns the number of references of the value associated with the specified key.
Returns the number of references of the value associated with the specified key.
- returns
Long
- Definition Classes
- RedisKey
- def persist[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Remove the expiration from a key.
Remove the expiration from a key.
- returns
True if the timeout was removed. false if key does not exist or does not have an associated timeout.
- Definition Classes
- RedisKey
- def pexpire[K, V](key: K, milliseconds: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set a key's time to live in milliseconds.
Set a key's time to live in milliseconds.
- returns
True if the timeout was set. False if key does not exist or the timeout could not be set.
- Definition Classes
- RedisKey
- def pexpireat[K, V](key: K, timestamp: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
- Definition Classes
- RedisKey
- def pexpireat[K, V](key: K, timestamp: Date)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
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.
- returns
Boolean integer-reply specifically: { @literal true} if the timeout was set. { @literal false} if { @code key} does not exist or the timeout could not be set (see: { @code EXPIRE}).
- Definition Classes
- RedisKey
- def ping[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Ping the server.
- def psetex[K, V](key: K, milliseconds: Long, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the value and expiration in milliseconds of a key.
Set the value and expiration in milliseconds of a key.
- returns
String simple-string-reply
- Definition Classes
- RedisString
- def pttl[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the time to live for a key in milliseconds.
Get the time to live for a key in milliseconds.
- returns
Long integer-reply TTL in milliseconds, or a negative value in order to signal an error (see the description above).
- Definition Classes
- RedisKey
- def publish[K, V](channel: K, message: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Post a message to a channel.
Post a message to a channel.
- returns
The number of clients that received the message.
- Definition Classes
- RedisPubSub
- def pubsubChannels[K, V](channel: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[K]
Lists the currently *active channels*.
Lists the currently *active channels*.
- returns
The list of active channels, optionally matching the specified pattern.
- Definition Classes
- RedisPubSub
- def pubsubChannels[K, V](implicit connection: StatefulRedisConnection[K, V]): Observable[K]
Lists the currently *active channels*.
Lists the currently *active channels*.
- returns
List of active channels, optionally matching the specified pattern.
- Definition Classes
- RedisPubSub
- def pubsubNumpat[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Returns the number of subscriptions to patterns.
Returns the number of subscriptions to patterns.
- returns
The number of patterns all the clients are subscribed to.
- Definition Classes
- RedisPubSub
- def pubsubNumsub[K, V](channels: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Map[K, Long]]
Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
- returns
The list of channels and number of subscribers for every channel. In this case long remains as java.lang.Long and not as as scala.Long, since traversing the map to convert values would imply performance implications
- Definition Classes
- RedisPubSub
- def quit[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Instructs Redis to disconnect the connection.
Instructs Redis to disconnect the connection. Note that if auto-reconnect is enabled then Lettuce will auto-reconnect if the connection was disconnected. Use
io.lettuce.core.api.StatefulConnection#close
to close connections and release resources.- returns
String simple string reply always OK.
- Definition Classes
- RedisPubSub
- def randomkey[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[K]
Return a random key from the keyspace.
Return a random key from the keyspace.
- returns
The random key, or null when the database is empty.
- Definition Classes
- RedisKey
- def readOnly[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Switch connection to Read-Only mode when connecting to a cluster.
Switch connection to Read-Only mode when connecting to a cluster.
- returns
Simple string reply.
- Definition Classes
- RedisPubSub
- def readWrite[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Switch connection to Read-Write mode (default) when connecting to a cluster.
Switch connection to Read-Write mode (default) when connecting to a cluster.
- returns
Simple string reply.
- Definition Classes
- RedisPubSub
- def rename[K, V](key: K, newKey: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Rename a key.
Rename a key.
- returns
String simple-string-reply
- Definition Classes
- RedisKey
- def renamenx[K, V](key: K, newKey: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Rename a key, only if the new key does not exist.
Rename a key, only if the new key does not exist.
- returns
True if key was renamed to newkey. False if newkey already exists.
- Definition Classes
- RedisKey
- def restore[K, V](key: K, ttl: Long, value: Array[Byte])(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Create a key using the provided serialized value, previously obtained using DUMP.
Create a key using the provided serialized value, previously obtained using DUMP.
- returns
The command returns OK on success.
- Definition Classes
- RedisKey
- def role[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]
Return the role of the instance in the context of replication.
Return the role of the instance in the context of replication.
- returns
Object array-reply where the first element is one of master, slave, sentinel and the additional elements are role-specific.
- Definition Classes
- RedisPubSub
- def rpop[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Remove and get the last element in a list.
Remove and get the last element in a list.
- returns
The value of the last element, or null when key does not exist.
- Definition Classes
- RedisList
- def rpoplpush[K, V](source: K, destination: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Remove the last element in a list, append it to another list and return it.
Remove the last element in a list, append it to another list and return it.
- returns
The element being popped and pushed.
- Definition Classes
- RedisList
- def rpush[K, V](key: K, values: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Append one or multiple values to a list.
Append one or multiple values to a list.
- returns
The length of the list after the push operation.
- Definition Classes
- RedisList
- def rpushx[K, V](key: K, values: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Append values to a list, only if the list exists.
Append values to a list, only if the list exists.
- returns
The length of the list after the push operation.
- Definition Classes
- RedisList
- def sadd[K, V](key: K, members: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Add one or more members to a set.
Add one or more members to a set.
- returns
The number of elements that were added to the set, not including all the elements already present into the set.
- Definition Classes
- RedisSet
- def scan[K, V](scanCursor: ScanCursor)(implicit connection: StatefulRedisConnection[K, V]): Task[KeyScanCursor[K]]
- Definition Classes
- RedisKey
- def scan[K, V]()(implicit connection: StatefulRedisConnection[K, V]): Task[KeyScanCursor[K]]
Incrementally iterate the keys space.
Incrementally iterate the keys space.
- returns
Scan cursor.
- Definition Classes
- RedisKey
- def scard[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the number of members in a set.
Get the number of members in a set.
- returns
The cardinality (number of elements) of the set, or { @literal false} if { @code key} does not exist.
- Definition Classes
- RedisSet
- def sdiff[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Subtract multiple sets.
Subtract multiple sets.
- returns
A list with members of the resulting set.
- Definition Classes
- RedisSet
- def sdiffstore[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Subtract multiple sets and store the resulting set in a key.
Subtract multiple sets and store the resulting set in a key.
- returns
The number of elements in the resulting set.
- Definition Classes
- RedisSet
- def set[K, V](key: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the string value of a key.
Set the string value of a key.
- returns
OK if SET was executed correctly.
- Definition Classes
- RedisString
- def setbit[K, V](key: K, offset: Long, value: Int)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
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.
- returns
The original bit value stored at offset.
- Definition Classes
- RedisString
- def setex[K, V](key: K, seconds: Long, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the value and expiration of a key.
Set the value and expiration of a key.
- returns
Simple string reply.
- Definition Classes
- RedisString
- def setnx[K, V](key: K, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Set the value of a key, only if the key does not exist.
Set the value of a key, only if the key does not exist.
- returns
True if the key was set. False if the key was not set
- Definition Classes
- RedisString
- def setrange[K, V](key: K, offset: Long, value: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Overwrite part of a string at key starting at the specified offset.
Overwrite part of a string at key starting at the specified offset.
- returns
The length of the string after it was modified by the command.
- Definition Classes
- RedisString
- def sinter[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Intersect multiple sets.
Intersect multiple sets.
- returns
A list with members of the resulting set.
- Definition Classes
- RedisSet
- def sinterstore[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Intersect multiple sets and store the resulting set in a key.
Intersect multiple sets and store the resulting set in a key.
- returns
The number of elements in the resulting set.
- Definition Classes
- RedisSet
- def sismember[K, V](key: K, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Determine if a given value is a member of a set.
Determine if a given value is a member of a set.
- returns
True if the element is a member of the set. False if the element is not a member of the set, or if key does not exist.
- Definition Classes
- RedisSet
- def smembers[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Get all the members in a set.
Get all the members in a set.
- returns
All elements of the set.
- Definition Classes
- RedisSet
- def smove[K, V](source: K, destination: K, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Move a member from one set to another.
Move a member from one set to another.
- returns
True if the element is moved. False if the element is not a member of source and no operation was performed.
- Definition Classes
- RedisSet
- def sort[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Sort the elements in a list, set or sorted set.
Sort the elements in a list, set or sorted set.
- returns
Sorted elements.
- Definition Classes
- RedisKey
- def spop[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Remove and return one or multiple random members from a set.
Remove and return one or multiple random members from a set.
- returns
The removed element, or null when key does not exist.
- Definition Classes
- RedisSet
- def spop[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Remove and return a random member from a set.
Remove and return a random member from a set.
- returns
The removed element, or null when key does not exist.
- Definition Classes
- RedisSet
- def srandmember[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Get one or multiple random members from a set.
Get one or multiple random members from a set.
- returns
The elements without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.
- Definition Classes
- RedisSet
- def srandmember[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[V]
Get one random member from a set.
Get one random member from a set.
- returns
Without the additional count argument the command returns a Bulk Reply with the randomly selected element, or null when key does not exist.
- Definition Classes
- RedisSet
- def srem[K, V](key: K, members: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove one or more members from a set.
Remove one or more members from a set.
- returns
Long hat represents the number of members that were removed from the set, not including non existing members.
- Definition Classes
- RedisSet
- def sscan[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[ValueScanCursor[V]]
Incrementally iterate Set elements.
Incrementally iterate Set elements.
- returns
Scan cursor.
- Definition Classes
- RedisSet
- def strlen[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the length of the value stored in a key.
Get the length of the value stored in a key.
- returns
The length of the string at key, or 0 when key does not exist.
- Definition Classes
- RedisString
- def sunion[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Add multiple sets.
Add multiple sets.
- returns
The members of the resulting set.
- Definition Classes
- RedisSet
- def sunionstore[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Add multiple sets and store the resulting set in a key.
Add multiple sets and store the resulting set in a key.
- returns
Long that represents the number of elements in the resulting set.
- Definition Classes
- RedisSet
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def touch[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Touch one or more keys.
Touch one or more keys. Touch sets the last accessed time for a key. Non-exsitent keys wont get created.
- returns
The number of found keys.
- Definition Classes
- RedisKey
- def ttl[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the time to live for a key.
Get the time to live for a key.
- returns
TTL in seconds, or a negative value in order to signal an error (see the description above).
- Definition Classes
- RedisKey
- def type[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Determine the type stored at key.
Determine the type stored at key.
- returns
Type of key, or none when key does not exist.
- Definition Classes
- RedisKey
- def unlink[K, V](keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Unlink one or more keys (non blocking DEL).
Unlink one or more keys (non blocking DEL).
- returns
The number of keys that were removed.
- Definition Classes
- RedisKey
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def waitForReplication[K, V](replicas: Int, timeout: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Wait for replication.
- def xack[K, V](key: K, group: K, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Acknowledge one or more messages as processed.
Acknowledge one or more messages as processed.
- returns
simple-reply the lenght of acknowledged messages.
- Definition Classes
- RedisStream
- def xadd[K, V](key: K, body: Map[K, V])(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Append a message to the stream key.
- def xclaim[K, V](key: K, consumer: Consumer[K], minIdleTime: Long, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
Gets ownership of one or multiple messages in the Pending Entries List of a given stream consumer group.
- returns
simple-reply the { @link StreamMessage}
- Definition Classes
- RedisStream
- def xdel[K, V](key: K, messageIds: String*)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Removes the specified entries from the stream.
Removes the specified entries from the stream. Returns the number of items deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
- returns
simple-reply number of removed entries.
- Definition Classes
- RedisStream
- def xgroupCreate[K, V](streamOffset: StreamOffset[K], group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Create a consumer group.
Create a consumer group.
- returns
simple-reply { @literal true} if successful.
- Definition Classes
- RedisStream
- def xgroupDelconsumer[K, V](key: K, consumer: Consumer[K])(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Delete a consumer from a consumer group.
Delete a consumer from a consumer group.
- returns
simple-reply { @literal true} if successful.
- Definition Classes
- RedisStream
- def xgroupDestroy[K, V](key: K, group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Boolean]
Destroy a consumer group.
Destroy a consumer group.
- returns
simple-reply { @literal true} if successful.
- Definition Classes
- RedisStream
- def xgroupSetid[K, V](streamOffset: StreamOffset[K], group: K)(implicit connection: StatefulRedisConnection[K, V]): Task[String]
Set the current group id.
- def xlen[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the length of a steam.
Get the length of a steam.
- returns
simple-reply the lenght of the stream.
- Definition Classes
- RedisStream
- def xpending[K, V](key: K, consumer: Consumer[K], range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]
Read pending messages from a stream within a specific Range.
Read pending messages from a stream within a specific Range.
- returns
List<Object> array-reply list with members of the resulting stream.
- Definition Classes
- RedisStream
- def xpending[K, V](key: K, group: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]
Read pending messages from a stream within a specific Range.
Read pending messages from a stream within a specific Range.
- returns
List<Object> array-reply list with members of the resulting stream.
- Definition Classes
- RedisStream
- def xpending[K, V](key: K, group: K)(implicit connection: StatefulRedisConnection[K, V]): Observable[Any]
Read pending messages from a stream for a group.
Read pending messages from a stream for a group.
- returns
List<Object> array-reply list pending entries.
- Definition Classes
- RedisStream
- def xrange[K, V](key: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from a stream within a specific Range applying a Limit.
Read messages from a stream within a specific Range applying a Limit.
- returns
Members of the resulting stream.
- Definition Classes
- RedisStream
- def xrange[K, V](key: K, range: Range[String])(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from a stream within a specific Range.
Read messages from a stream within a specific Range.
- returns
Members of the resulting stream.
- Definition Classes
- RedisStream
- def xread[K, V](streams: StreamOffset[K]*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from one or more StreamOffsets.
Read messages from one or more StreamOffsets.
- returns
Members of the resulting stream.
- Definition Classes
- RedisStream
- def xreadgroup[K, V](consumer: Consumer[K], streams: StreamOffset[K]*)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from one or more StreamOffsets using a consumer group.
Read messages from one or more StreamOffsets using a consumer group.
- returns
List<StreamMessage> array-reply list with members of the resulting stream.
- Definition Classes
- RedisStream
- def xrevrange[K, V](key: K, range: Range[String], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from a stream within a specific Range applying a Limit in reverse order.
Read messages from a stream within a specific Range applying a Limit in reverse order.
- returns
Meembers of the resulting stream.
- Definition Classes
- RedisStream
- def xrevrange[K, V](key: K, range: Range[String])(implicit connection: StatefulRedisConnection[K, V]): Observable[StreamMessage[K, V]]
Read messages from a stream within a specific Range in reverse order.
Read messages from a stream within a specific Range in reverse order.
- returns
Members of the resulting stream.
- Definition Classes
- RedisStream
- def xtrim[K, V](key: K, approximateTrimming: Boolean, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Trims the stream to count elements.
- def xtrim[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Trims the stream to count elements.
- def zadd[K, V](key: K, scoredValues: ScoredValue[V]*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Add one or more members to a sorted set, or update its score if it already exists.
Add one or more members to a sorted set, or update its score if it already exists.
- returns
Long integer-reply specifically: The number of elements added to the sorted sets, not including elements already existing for which the score was updated.
- Definition Classes
- RedisSortedSet
- def zadd[K, V](key: K, score: Double, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Add one or more members to a sorted set, or update its score if it already exists.
Add one or more members to a sorted set, or update its score if it already exists.
- returns
Long integer-reply specifically: The number of elements added to the sorted sets, not including elements already existing for which the score was updated.
- Definition Classes
- RedisSortedSet
- def zaddincr[K, V](key: K, score: Double, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Double]
Add one or more members to a sorted set, or update its score if it already exists applying the INCR option.
Add one or more members to a sorted set, or update its score if it already exists applying the INCR option. ZADD acts like ZINCRBY.
- returns
The total number of elements changed
- Definition Classes
- RedisSortedSet
- def zcard[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Get the number of members in a sorted set.
Get the number of members in a sorted set.
- returns
Long integer-reply specifically: The number of elements added to the sorted sets, not including elements already existing for which the score was updated.
- Definition Classes
- RedisSortedSet
- def zcount[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Count the members in a sorted set with scores within the given Range.
Count the members in a sorted set with scores within the given Range.
- returns
The number of elements of the sorted set, or false if key does not exist.
- Definition Classes
- RedisSortedSet
- def zincrby[K, V](key: K, amount: Double, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Double]
Increment the score of a member in a sorted set.
Increment the score of a member in a sorted set.
- returns
The new score of member, represented as string.
- Definition Classes
- RedisSortedSet
- def zinterstore[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Intersect multiple sorted sets and store the resulting sorted set in a new key.
Intersect multiple sorted sets and store the resulting sorted set in a new key.
- returns
The number of elements in the resulting sorted set at destination.
- Definition Classes
- RedisSortedSet
- def zlexcount[K, V](key: K, range: Range[_ <: V])(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Count the number of members in a sorted set between a given lexicographical range.
Count the number of members in a sorted set between a given lexicographical range.
- returns
The number of elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zpopmax[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Removes and returns up to count members with the highest scores in the sorted set stored at key.
Removes and returns up to count members with the highest scores in the sorted set stored at key.
- returns
Scored values of popped scores and elements.
- Definition Classes
- RedisSortedSet
- def zpopmax[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[ScoredValue[V]]
Removes and returns up to count members with the highest scores in the sorted set stored at key.
Removes and returns up to count members with the highest scores in the sorted set stored at key.
- returns
Scored value of the removed element.
- Definition Classes
- RedisSortedSet
- def zpopmin[K, V](key: K, count: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
- returns
Scored values of the popped scores and elements.
- Definition Classes
- RedisSortedSet
- def zpopmin[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[ScoredValue[V]]
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
Removes and returns up to count members with the lowest scores in the sorted set stored at key.
- returns
Scored value the removed element.
- Definition Classes
- RedisSortedSet
- def zrange[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by index.
Return a range of members in a sorted set, by index.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrangeWithScores[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with scores in a sorted set, by index.
Return a range of members with scores in a sorted set, by index.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrangebylex[K, V](key: K, range: Range[_ <: V], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by lexicographical range.
Return a range of members in a sorted set, by lexicographical range.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrangebylex[K, V](key: K, range: Range[_ <: V])(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by lexicographical range.
Return a range of members in a sorted set, by lexicographical range.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrangebyscore[K, V](key: K, range: Range[_ <: Number], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by score.
Return a range of members in a sorted set, by score.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrangebyscore[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by score.
Return a range of members in a sorted set, by score.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrangebyscoreWithScores[K, V](key: K, range: Range[_ <: Number], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with score in a sorted set, by score.
Return a range of members with score in a sorted set, by score.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrangebyscoreWithScores[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with score in a sorted set, by score.
Return a range of members with score in a sorted set, by score.
- returns
Scored values in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrank[K, V](key: K, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Determine the index of a member in a sorted set.
Determine the index of a member in a sorted set.
- returns
The rank of member. If member does not exist in the sorted set or key does not exist.
- Definition Classes
- RedisSortedSet
- def zrem[K, V](key: K, members: V*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove one or more members from a sorted set.
Remove one or more members from a sorted set.
- returns
The number of members removed from the sorted set, not including non existing members.
- Definition Classes
- RedisSortedSet
- def zremrangebylex[K, V](key: K, range: Range[_ <: V])(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove all members in a sorted set between the given lexicographical range.
Remove all members in a sorted set between the given lexicographical range.
- returns
The number of elements removed.
- Definition Classes
- RedisSortedSet
- def zremrangebyrank[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove all members in a sorted set within the given indexes.
Remove all members in a sorted set within the given indexes.
- returns
The number of elements removed.
- Definition Classes
- RedisSortedSet
- def zremrangebyscore[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Remove all members in a sorted set within the given scores.
Remove all members in a sorted set within the given scores.
- returns
The number of elements removed.
- Definition Classes
- RedisSortedSet
- def zrevrange[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by index, with scores ordered from high to low.
Return a range of members in a sorted set, by index, with scores ordered from high to low.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrevrangeWithScores[K, V](key: K, start: Long, stop: Long)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with scores in a sorted set, by index, with scores ordered from high to low.
Return a range of members with scores in a sorted set, by index, with scores ordered from high to low.
- returns
Elements in the specified range.
- Definition Classes
- RedisSortedSet
- def zrevrangebylex[K, V](key: K, range: Range[_ <: V], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by lexicographical range ordered from high to low.
Return a range of members in a sorted set, by lexicographical range ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrangebylex[K, V](key: K, range: Range[_ <: V])(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by lexicographical range ordered from high to low.
Return a range of members in a sorted set, by lexicographical range ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrangebyscore[K, V](key: K, range: Range[_ <: Number], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by score, with scores ordered from high to low.
Return a range of members in a sorted set, by score, with scores ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrangebyscore[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Observable[V]
Return a range of members in a sorted set, by score, with scores ordered from high to low.
Return a range of members in a sorted set, by score, with scores ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrangebyscoreWithScores[K, V](key: K, range: Range[_ <: Number], limit: Limit)(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with scores in a sorted set, by score, with scores ordered from high to low.
Return a range of members with scores in a sorted set, by score, with scores ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrangebyscoreWithScores[K, V](key: K, range: Range[_ <: Number])(implicit connection: StatefulRedisConnection[K, V]): Observable[ScoredValue[V]]
Return a range of members with scores in a sorted set, by score, with scores ordered from high to low.
Return a range of members with scores in a sorted set, by score, with scores ordered from high to low.
- returns
Elements in the specified score range.
- Definition Classes
- RedisSortedSet
- def zrevrank[K, V](key: K, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Determine the index of a member in a sorted set, with scores ordered from high to low.
Determine the index of a member in a sorted set, with scores ordered from high to low.
- returns
The rank of member. If member does not exist in the sorted set or key does not exist.
- Definition Classes
- RedisSortedSet
- def zscan[K, V](key: K)(implicit connection: StatefulRedisConnection[K, V]): Task[ScoredValueScanCursor[V]]
Incrementally iterate sorted sets elements and associated scores.
Incrementally iterate sorted sets elements and associated scores.
- returns
Scan cursor.
- Definition Classes
- RedisSortedSet
- def zscore[K, V](key: K, member: V)(implicit connection: StatefulRedisConnection[K, V]): Task[Double]
Get the score associated with the given member in a sorted set.
Get the score associated with the given member in a sorted set.
- returns
The score of member represented as string.
- Definition Classes
- RedisSortedSet
- def zunionstore[K, V](destination: K, keys: K*)(implicit connection: StatefulRedisConnection[K, V]): Task[Long]
Add multiple sorted sets and store the resulting sorted set in a new key.
Add multiple sorted sets and store the resulting sorted set in a new key.
- returns
The number of elements in the resulting sorted set at destination.
- Definition Classes
- RedisSortedSet