Class

com.redis.cluster

RedisCluster

Related Doc: package cluster

Permalink

class RedisCluster extends RedisClusterOps with WithHashRing[IdentifiableRedisClientPool] with BaseOps with NodeOps with StringOps with ListOps with SetOps with SortedSetOps with EvalOps with HashOps

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedisCluster
  2. HashOps
  3. HashApi
  4. EvalOps
  5. EvalApi
  6. SortedSetOps
  7. SortedSetApi
  8. SetOps
  9. SetApi
  10. ListOps
  11. ListApi
  12. StringOps
  13. StringApi
  14. NodeOps
  15. NodeApi
  16. BaseOps
  17. BaseApi
  18. WithHashRing
  19. RedisClusterOps
  20. AutoCloseable
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RedisCluster(hosts: List[ClusterNode], keyTag: Option[KeyTag])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val POINTS_PER_SERVER: Int

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterOps
  5. def addServer(server: ClusterNode): Try[Unit]

    Permalink

    add server to internal pool

    add server to internal pool

    Definition Classes
    RedisClusterRedisClusterOps
  6. def append(key: Any, value: Any)(implicit format: Format): Option[Long]

    Permalink

    appends the key value with the specified value.

    appends the key value with the specified value.

    Definition Classes
    StringOpsStringApi
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def auth(secret: Any)(implicit format: Format): Boolean

    Permalink

    auths with the server.

    auths with the server.

    Definition Classes
    BaseOpsBaseApi
  9. def bgrewriteaof: Boolean

    Permalink
    Definition Classes
    NodeOpsNodeApi
  10. def bgsave: Boolean

    Permalink

    save the DB in the background.

    save the DB in the background.

    Definition Classes
    NodeOpsNodeApi
  11. def bitcount(key: Any, range: Option[(Int, Int)])(implicit format: Format): Option[Int]

    Permalink

    Count the number of set bits in the given key within the optional range

    Count the number of set bits in the given key within the optional range

    Definition Classes
    StringOpsStringApi
  12. def bitop(op: String, destKey: Any, srcKeys: Any*)(implicit format: Format): Option[Int]

    Permalink

    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.

    Definition Classes
    StringOpsStringApi
  13. def blpop[K, V](timeoutInSeconds: Int, key: K, keys: K*)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[(K, V)]

    Permalink
    Definition Classes
    ListOpsListApi
  14. def brpop[K, V](timeoutInSeconds: Int, key: K, keys: K*)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[(K, V)]

    Permalink
    Definition Classes
    ListOpsListApi
  15. def brpoplpush[A](srcKey: Any, dstKey: Any, timeoutInSeconds: Int)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink
    Definition Classes
    ListOpsListApi
  16. def bzpopmax[K, V](timeoutInSeconds: Int, key: K, keys: K*)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[(K, V, Double)]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  17. def bzpopmin[K, V](timeoutInSeconds: Int, key: K, keys: K*)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[(K, V, Double)]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  18. val clients: List[IdentifiableRedisClientPool]

    Permalink
    Attributes
    protected[com.redis.cluster]
  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  20. def close(): Unit

    Permalink
    Definition Classes
    RedisCluster → AutoCloseable
  21. def dbsize: Option[Long]

    Permalink

    returns the size of the db.

    returns the size of the db.

    Definition Classes
    BaseOpsBaseApi
  22. def decr(key: Any)(implicit format: Format): Option[Long]

    Permalink

    decrements the specified key by 1

    decrements the specified key by 1

    Definition Classes
    StringOpsStringApi
  23. def decrby(key: Any, increment: Long)(implicit format: Format): Option[Long]

    Permalink

    decrements the specified key by increment

    decrements the specified key by increment

    Definition Classes
    StringOpsStringApi
  24. def del(key: Any, keys: Any*)(implicit format: Format): Option[Long]

    Permalink

    deletes the specified keys.

    deletes the specified keys.

    Definition Classes
    BaseOpsBaseApi
  25. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  27. def evalBulk[A](luaCode: String, keys: List[Any], args: List[Any])(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  28. def evalInt(luaCode: String, keys: List[Any], args: List[Any]): Option[Int]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  29. def evalMultiBulk[A](luaCode: String, keys: List[Any], args: List[Any])(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    evaluates lua code on the server.

    evaluates lua code on the server.

    Definition Classes
    EvalOpsEvalApi
  30. def evalMultiSHA[A](shahash: String, keys: List[Any], args: List[Any])(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  31. def evalSHA[A](shahash: String, keys: List[Any], args: List[Any])(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  32. def evalSHABulk[A](shahash: String, keys: List[Any], args: List[Any])(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  33. def exists(key: Any)(implicit format: Format): Boolean

    Permalink

    test if the specified key exists.

    test if the specified key exists.

    Definition Classes
    BaseOpsBaseApi
  34. def expire(key: Any, ttl: Int)(implicit format: Format): Boolean

    Permalink

    sets the expire time (in sec.) for the specified key.

    sets the expire time (in sec.) for the specified key.

    Definition Classes
    BaseOpsBaseApi
  35. def expireat(key: Any, timestamp: Long)(implicit format: Format): Boolean

    Permalink

    sets the expire time for the specified key.

    sets the expire time for the specified key.

    Definition Classes
    BaseOpsBaseApi
  36. def flushall: Boolean

    Permalink

    removes data from all the DB's.

    removes data from all the DB's.

    Definition Classes
    BaseOpsBaseApi
  37. def flushdb: Boolean

    Permalink

    removes all the DB data.

    removes all the DB data.

    Definition Classes
    BaseOpsBaseApi
  38. def get[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    gets the value for the specified key.

    gets the value for the specified key.

    Definition Classes
    StringOpsStringApi
  39. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  40. def getConfig(key: Any)(implicit format: Format): Option[Map[String, Option[String]]]

    Permalink

    CONFIG GET

    CONFIG GET

    Definition Classes
    BaseOpsBaseApi
  41. def getType(key: Any)(implicit format: Format): Option[String]

    Permalink

    returns the type of the value stored at key in form of a string.

    returns the type of the value stored at key in form of a string.

    Definition Classes
    BaseOpsBaseApi
  42. def getbit(key: Any, offset: Int)(implicit format: Format): Option[Int]

    Permalink

    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

    Definition Classes
    StringOpsStringApi
  43. def getrange[A](key: Any, start: Int, end: Int)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive).

    Returns the substring of the string value stored at key, determined by the offsets start and end (both are inclusive).

    Definition Classes
    StringOpsStringApi
  44. def getset[A](key: Any, value: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    is an atomic set this value and return the old value command.

    is an atomic set this value and return the old value command.

    Definition Classes
    StringOpsStringApi
  45. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  46. def hdel(key: Any, field: Any, fields: Any*)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    HashOpsHashApi
  47. def hexists(key: Any, field: Any)(implicit format: Format): Boolean

    Permalink
    Definition Classes
    HashOpsHashApi
  48. def hget[A](key: Any, field: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink
    Definition Classes
    HashOpsHashApi
  49. def hgetall[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[Map[K, V]]

    Permalink
    Definition Classes
    HashOpsHashApi
  50. def hgetall1[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[Map[K, V]]

    Permalink
    Definition Classes
    HashOpsHashApi
  51. def hincrby(key: Any, field: Any, value: Long)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    HashOpsHashApi
  52. def hincrbyfloat(key: Any, field: Any, value: Float)(implicit format: Format): Option[Float]

    Permalink
    Definition Classes
    HashOpsHashApi
  53. def hkeys[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]

    Permalink
    Definition Classes
    HashOpsHashApi
  54. def hlen(key: Any)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    HashOpsHashApi
  55. def hmget[K, V](key: Any, fields: K*)(implicit format: Format, parseV: Parse[V]): Option[Map[K, V]]

    Permalink
    Definition Classes
    HashOpsHashApi
  56. def hmset(key: Any, map: Iterable[Product2[Any, Any]])(implicit format: Format): Boolean

    Permalink

    Sets the specified fields to their respective values in the hash stored at key.

    Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.

    map

    from fields to values

    returns

    True if operation completed successfully, False otherwise.

    Definition Classes
    HashOpsHashApi
    See also

    HMSET documentation

  57. val hosts: List[ClusterNode]

    Permalink
    Attributes
    protected
  58. val hr: HashRing[IdentifiableRedisClientPool]

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterWithHashRing
  59. def hscan[A](key: Any, cursor: Int, pattern: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[(Option[Int], Option[List[Option[A]]])]

    Permalink

    Incrementally iterate hash fields and associated values (since 2.8)

    Incrementally iterate hash fields and associated values (since 2.8)

    Definition Classes
    HashOpsHashApi
  60. def hset1(key: Any, field: Any, value: Any)(implicit format: Format): Option[Long]

    Permalink

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    returns

    Some(0) if field is a new field in the hash and value was set, Some(1) if field already exists in the hash and the value was updated.

    Definition Classes
    HashOpsHashApi
    See also

    HSET documentation

  61. def hsetnx(key: Any, field: Any, value: Any)(implicit format: Format): Boolean

    Permalink

    Sets field in the hash stored at key to value, only if field does not yet exist.

    Sets field in the hash stored at key to value, only if field does not yet exist. If key does not exist, a new key holding a hash is created. If field already exists, this operation has no effect.

    returns

    True if field is a new field in the hash and value was set. False if field exists in the hash and no operation was performed.

    Definition Classes
    HashOpsHashApi
    See also

    HSETNX documentation

  62. def hvals[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]

    Permalink
    Definition Classes
    HashOpsHashApi
  63. def inSameNode[T](keys: Any*)(body: (RedisClient) ⇒ T)(implicit format: Format): T

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterOps
  64. def incr(key: Any)(implicit format: Format): Option[Long]

    Permalink

    increments the specified key by 1

    increments the specified key by 1

    Definition Classes
    StringOpsStringApi
  65. def incrby(key: Any, increment: Long)(implicit format: Format): Option[Long]

    Permalink

    increments the specified key by increment

    increments the specified key by increment

    Definition Classes
    StringOpsStringApi
  66. def incrbyfloat(key: Any, increment: Float)(implicit format: Format): Option[Float]

    Permalink
    Definition Classes
    StringOpsStringApi
  67. def info: Option[String]

    Permalink

    The info command returns different information and statistics about the server.

    The info command returns different information and statistics about the server.

    Definition Classes
    NodeOpsNodeApi
  68. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  69. val keyTag: Option[KeyTag]

    Permalink
    Attributes
    protected
    Definition Classes
    RedisClusterRedisClusterOps
  70. def keys[A](pattern: Any)(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    returns all the keys matching the glob-style pattern.

    returns all the keys matching the glob-style pattern.

    Definition Classes
    BaseOpsBaseApi
  71. def lastsave: Option[Long]

    Permalink

    return the UNIX TIME of the last DB SAVE executed with success.

    return the UNIX TIME of the last DB SAVE executed with success.

    Definition Classes
    NodeOpsNodeApi
  72. def lindex[A](key: Any, index: Int)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    return the especified element of the list stored at the specified key.

    return the especified element of the list stored at the specified key. Negative indexes are supported, for example -1 is the last element, -2 the penultimate and so on.

    Definition Classes
    ListOpsListApi
  73. def listServers: List[ClusterNode]

    Permalink

    list all running servers

    list all running servers

    Definition Classes
    RedisClusterRedisClusterOps
  74. def llen(key: Any)(implicit format: Format): Option[Long]

    Permalink

    return the length of the list stored at the specified key.

    return the length of the list stored at the specified key. If the key does not exist zero is returned (the same behaviour as for empty lists). If the value stored at key is not a list an error is returned.

    Definition Classes
    ListOpsListApi
  75. def lpop[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    atomically return and remove the first (LPOP) or last (RPOP) element of the list

    atomically return and remove the first (LPOP) or last (RPOP) element of the list

    Definition Classes
    ListOpsListApi
  76. def lpush(key: Any, value: Any, values: Any*)(implicit format: Format): Option[Long]

    Permalink

    add values to the head of the list stored at key (Variadic: >= 2.4)

    add values to the head of the list stored at key (Variadic: >= 2.4)

    Definition Classes
    ListOpsListApi
  77. def lpushx(key: Any, value: Any)(implicit format: Format): Option[Long]

    Permalink

    add value to the head of the list stored at key (Variadic: >= 2.4)

    add value to the head of the list stored at key (Variadic: >= 2.4)

    Definition Classes
    ListOpsListApi
  78. def lrange[A](key: Any, start: Int, end: Int)(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    return the specified elements of the list stored at the specified key.

    return the specified elements of the list stored at the specified key. Start and end are zero-based indexes.

    Definition Classes
    ListOpsListApi
  79. def lrem(key: Any, count: Int, value: Any)(implicit format: Format): Option[Long]

    Permalink

    Remove the first count occurrences of the value element from the list.

    Remove the first count occurrences of the value element from the list.

    Definition Classes
    ListOpsListApi
  80. def lset(key: Any, index: Int, value: Any)(implicit format: Format): Boolean

    Permalink

    set the list element at index with the new value.

    set the list element at index with the new value. Out of range indexes will generate an error

    Definition Classes
    ListOpsListApi
  81. def ltrim(key: Any, start: Int, end: Int)(implicit format: Format): Boolean

    Permalink

    Trim an existing list so that it will contain only the specified range of elements specified.

    Trim an existing list so that it will contain only the specified range of elements specified.

    Definition Classes
    ListOpsListApi
  82. def mget[A](key: Any, keys: Any*)(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    get the values of all the specified keys.

    get the values of all the specified keys.

    Definition Classes
    StringOpsStringApi
  83. def monitor: Boolean

    Permalink

    is a debugging command that outputs the whole sequence of commands received by the Redis server.

    is a debugging command that outputs the whole sequence of commands received by the Redis server.

    Definition Classes
    NodeOpsNodeApi
  84. def move(key: Any, db: Int)(implicit format: Format): Boolean

    Permalink

    Move the specified key from the currently selected DB to the specified destination DB.

    Move the specified key from the currently selected DB to the specified destination DB.

    Definition Classes
    BaseOpsBaseApi
  85. def mset(kvs: (Any, Any)*)(implicit format: Format): Boolean

    Permalink

    set the respective key value pairs.

    set the respective key value pairs. Overwrite value if key exists

    Definition Classes
    StringOpsStringApi
  86. def msetnx(kvs: (Any, Any)*)(implicit format: Format): Boolean

    Permalink

    set the respective key value pairs.

    set the respective key value pairs. Noop if any key exists

    Definition Classes
    StringOpsStringApi
  87. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  88. def nodeForKey(key: Any)(implicit format: Format): IdentifiableRedisClientPool

    Permalink

    get node for the key

    get node for the key

    Definition Classes
    RedisClusterRedisClusterOps
  89. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  90. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  91. def onAllConns[T](body: (RedisClient) ⇒ T): Iterable[T]

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterRedisClusterOps
  92. def oneCommonAnswerOr[A](r: Iterable[A])(moreResultHandler: (Iterable[A]) ⇒ Option[A]): Option[A]

    Permalink
    Attributes
    protected
    Definition Classes
    EvalOps
  93. def persist(key: Any)(implicit format: Format): Boolean

    Permalink

    Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).

    Remove the existing timeout on key, turning the key from volatile (a key with an expire set) to persistent (a key that will never expire as no timeout is associated).

    Definition Classes
    BaseOpsBaseApi
  94. def pexpire(key: Any, ttlInMillis: Int)(implicit format: Format): Boolean

    Permalink

    sets the expire time (in milli sec.) for the specified key.

    sets the expire time (in milli sec.) for the specified key.

    Definition Classes
    BaseOpsBaseApi
  95. def pexpireat(key: Any, timestampInMillis: Long)(implicit format: Format): Boolean

    Permalink

    sets the expire timestamp in millis for the specified key.

    sets the expire timestamp in millis for the specified key.

    Definition Classes
    BaseOpsBaseApi
  96. def ping: Option[String]

    Permalink

    ping

    ping

    Definition Classes
    BaseOpsBaseApi
  97. val pong: Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    BaseApi
  98. def processForKey[T](key: Any)(body: (RedisCommand) ⇒ T)(implicit format: Format): T

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterOps
  99. def processForKeys[T](keys: List[Any])(body: (List[Any]) ⇒ (RedisCommand) ⇒ T)(implicit format: Format): Iterable[T]

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterOps
  100. def psetex(key: Any, expiryInMillis: Long, value: Any)(implicit format: Format): Boolean

    Permalink
    Definition Classes
    StringOpsStringApi
  101. def pttl(key: Any)(implicit format: Format): Option[Long]

    Permalink

    returns the remaining time to live of a key that has a timeout in millis

    returns the remaining time to live of a key that has a timeout in millis

    Definition Classes
    BaseOpsBaseApi
  102. def quit: Boolean

    Permalink

    exits the server.

    exits the server.

    Definition Classes
    BaseOpsBaseApi
  103. val r: Random

    Permalink
    Attributes
    protected
    Definition Classes
    RedisClusterOps
  104. def randomNode(): RedisClientPool

    Permalink
    Attributes
    protected[com.redis.cluster]
    Definition Classes
    RedisClusterRedisClusterOps
  105. def randomkey[A](implicit parse: Parse[A]): Option[A]

    Permalink

    returns a randomly selected key from the currently selected DB.

    returns a randomly selected key from the currently selected DB.

    Definition Classes
    BaseOpsBaseApi
  106. def removeServer(nodename: String): Unit

    Permalink

    remove a server

    remove a server

    Definition Classes
    RedisClusterRedisClusterOps
  107. def rename(oldkey: Any, newkey: Any)(implicit format: Format): Boolean

    Permalink

    atomically renames the key oldkey to newkey.

    atomically renames the key oldkey to newkey.

    Definition Classes
    BaseOpsBaseApi
  108. def renamenx(oldkey: Any, newkey: Any)(implicit format: Format): Boolean

    Permalink

    rename oldkey into newkey but fails if the destination key newkey already exists.

    rename oldkey into newkey but fails if the destination key newkey already exists.

    Definition Classes
    BaseOpsBaseApi
  109. def replaceServer(server: ClusterNode): Unit

    Permalink

    replace a server very useful when you want to replace a server in test mode to one in production mode

    replace a server very useful when you want to replace a server in test mode to one in production mode

    Use Case: Suppose I have a big list of key/value pairs which are replicated in 2 Redis servers - one having test values for every key and the other having production values for the same set of keys. In a cluster using replaceServer I can switch between test mode and production mode without disturbing the hash ring. This gives an additional level of abstraction on the node name decoupling it from the node address.

    Definition Classes
    RedisClusterRedisClusterOps
  110. def rpop[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    atomically return and remove the first (LPOP) or last (RPOP) element of the list

    atomically return and remove the first (LPOP) or last (RPOP) element of the list

    Definition Classes
    ListOpsListApi
  111. def rpoplpush[A](srcKey: Any, dstKey: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    Remove the first count occurrences of the value element from the list.

    Remove the first count occurrences of the value element from the list.

    Definition Classes
    ListOpsListApi
  112. def rpush(key: Any, value: Any, values: Any*)(implicit format: Format): Option[Long]

    Permalink

    add values to the tail of the list stored at key (Variadic: >= 2.4)

    add values to the tail of the list stored at key (Variadic: >= 2.4)

    Definition Classes
    ListOpsListApi
  113. def rpushx(key: Any, value: Any)(implicit format: Format): Option[Long]

    Permalink

    add value to the tail of the list stored at key (Variadic: >= 2.4)

    add value to the tail of the list stored at key (Variadic: >= 2.4)

    Definition Classes
    ListOpsListApi
  114. def sadd(key: Any, value: Any, values: Any*)(implicit format: Format): Option[Long]

    Permalink

    Add the specified members to the set value stored at key.

    Add the specified members to the set value stored at key. (VARIADIC: >= 2.4)

    Definition Classes
    SetOpsSetApi
  115. def save: Boolean

    Permalink

    save the DB on disk now.

    save the DB on disk now.

    Definition Classes
    NodeOpsNodeApi
  116. def scan[A](cursor: Int, pattern: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[(Option[Int], Option[List[Option[A]]])]

    Permalink

    Incrementally iterate the keys space (since 2.8)

    Incrementally iterate the keys space (since 2.8)

    Definition Classes
    BaseOpsBaseApi
  117. def scard(key: Any)(implicit format: Format): Option[Long]

    Permalink

    Return the number of elements (the cardinality) of the Set at key.

    Return the number of elements (the cardinality) of the Set at key.

    Definition Classes
    SetOpsSetApi
  118. def scriptExists(shahash: String): Option[Int]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  119. def scriptFlush: Option[String]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  120. def scriptLoad(luaCode: String): Option[String]

    Permalink
    Definition Classes
    EvalOpsEvalApi
  121. def sdiff[A](key: Any, keys: Any*)(implicit format: Format, parse: Parse[A]): Option[Set[Option[A]]]

    Permalink

    Return the difference between the Set stored at key1 and all the Sets key2, ..., keyN.

    Return the difference between the Set stored at key1 and all the Sets key2, ..., keyN.

    Definition Classes
    SetOpsSetApi
  122. def sdiffstore(key: Any, keys: Any*)(implicit format: Format): Option[Long]

    Permalink

    Compute the difference between the Set key1 and all the Sets key2, ..., keyN, and store the resulting Set at dstkey.

    Compute the difference between the Set key1 and all the Sets key2, ..., keyN, and store the resulting Set at dstkey.

    Definition Classes
    SetOpsSetApi
  123. def select(index: Int): Boolean

    Permalink

    selects the DB to connect, defaults to 0 (zero).

    selects the DB to connect, defaults to 0 (zero).

    Definition Classes
    BaseOpsBaseApi
  124. def set(key: Any, value: Any, whenSet: SetBehaviour = Always, expire: Duration = null)(implicit format: Format): Boolean

    Permalink

    sets the key with the specified value.

    sets the key with the specified value. Starting with Redis 2.6.12 SET supports a set of options that modify its behavior:

    NX -- Only set the key if it does not already exist. XX -- Only set the key if it already exist. PX milliseconds -- Set the specified expire time, in milliseconds.

    Definition Classes
    StringOpsStringApi
  125. def setConfig(key: Any, value: Any)(implicit format: Format): Option[String]

    Permalink

    CONFIG SET

    CONFIG SET

    Definition Classes
    BaseOpsBaseApi
  126. def setbit(key: Any, offset: Int, value: Any)(implicit format: Format): Option[Int]

    Permalink

    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

    Definition Classes
    StringOpsStringApi
  127. def setex(key: Any, expiry: Long, value: Any)(implicit format: Format): Boolean

    Permalink
    Definition Classes
    StringOpsStringApi
  128. def setnx(key: Any, value: Any)(implicit format: Format): Boolean

    Permalink

    sets the value for the specified key, only if the key is not there.

    sets the value for the specified key, only if the key is not there.

    Definition Classes
    StringOpsStringApi
  129. def setrange(key: Any, offset: Int, value: Any)(implicit format: Format): Option[Long]

    Permalink

    SETRANGE key offset value Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value.

    SETRANGE key offset value Overwrites part of the string stored at key, starting at the specified offset, for the entire length of value.

    Definition Classes
    StringOpsStringApi
  130. def shutdown: Boolean

    Permalink

    Stop all the clients, save the DB, then quit the server.

    Stop all the clients, save the DB, then quit the server.

    Definition Classes
    NodeOpsNodeApi
  131. def sinter[A](key: Any, keys: Any*)(implicit format: Format, parse: Parse[A]): Option[Set[Option[A]]]

    Permalink

    Return the intersection between the Sets stored at key1, key2, ..., keyN.

    Return the intersection between the Sets stored at key1, key2, ..., keyN.

    Definition Classes
    SetOpsSetApi
  132. def sinterstore(key: Any, keys: Any*)(implicit format: Format): Option[Long]

    Permalink

    Compute the intersection between the Sets stored at key1, key2, ..., keyN, and store the resulting Set at dstkey.

    Compute the intersection between the Sets stored at key1, key2, ..., keyN, and store the resulting Set at dstkey. SINTERSTORE returns the size of the intersection, unlike what the documentation says refer http://code.google.com/p/redis/issues/detail?id=121

    Definition Classes
    SetOpsSetApi
  133. def sismember(key: Any, value: Any)(implicit format: Format): Boolean

    Permalink

    Test if the specified value is a member of the Set at key.

    Test if the specified value is a member of the Set at key.

    Definition Classes
    SetOpsSetApi
  134. def slaveof(options: Any): Boolean

    Permalink

    The SLAVEOF command can change the replication settings of a slave on the fly.

    The SLAVEOF command can change the replication settings of a slave on the fly.

    Definition Classes
    NodeOpsNodeApi
  135. def smembers[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[Set[Option[A]]]

    Permalink

    Return all the members of the Set value at key.

    Return all the members of the Set value at key.

    Definition Classes
    SetOpsSetApi
  136. def smove(sourceKey: Any, destKey: Any, value: Any)(implicit format: Format): Option[Long]

    Permalink

    Move the specified member from one Set to another atomically.

    Move the specified member from one Set to another atomically.

    Definition Classes
    SetOpsSetApi
  137. def sort[A](key: String, limit: Option[(Int, Int)], desc: Boolean, alpha: Boolean, by: Option[String], get: List[String])(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    sort keys in a set, and optionally pull values for them

    sort keys in a set, and optionally pull values for them

    Definition Classes
    BaseOpsBaseApi
  138. def sortNStore[A](key: String, limit: Option[(Int, Int)], desc: Boolean, alpha: Boolean, by: Option[String], get: List[String], storeAt: String)(implicit format: Format, parse: Parse[A]): Option[Long]

    Permalink

    sort keys in a set, and stores result in the supplied key

    sort keys in a set, and stores result in the supplied key

    Definition Classes
    BaseOpsBaseApi
  139. def spop[A](key: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[Set[Option[A]]]

    Permalink

    Remove and return multiple random elements (pop) from the Set value at key since (3.2).

    Remove and return multiple random elements (pop) from the Set value at key since (3.2).

    Definition Classes
    SetOpsSetApi
  140. def spop[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    Remove and return (pop) a random element from the Set value at key.

    Remove and return (pop) a random element from the Set value at key.

    Definition Classes
    SetOpsSetApi
  141. def srandmember[A](key: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    Return multiple random elements from a Set (since 2.6)

    Return multiple random elements from a Set (since 2.6)

    Definition Classes
    SetOpsSetApi
  142. def srandmember[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[A]

    Permalink

    Return a random element from a Set

    Return a random element from a Set

    Definition Classes
    SetOpsSetApi
  143. def srem(key: Any, value: Any, values: Any*)(implicit format: Format): Option[Long]

    Permalink

    Remove the specified members from the set value stored at key.

    Remove the specified members from the set value stored at key. (VARIADIC: >= 2.4)

    Definition Classes
    SetOpsSetApi
  144. def sscan[A](key: Any, cursor: Int, pattern: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[(Option[Int], Option[List[Option[A]]])]

    Permalink

    Incrementally iterate Set elements (since 2.8)

    Incrementally iterate Set elements (since 2.8)

    Definition Classes
    SetOpsSetApi
  145. def strlen(key: Any)(implicit format: Format): Option[Long]

    Permalink

    gets the length of the value associated with the key

    gets the length of the value associated with the key

    Definition Classes
    StringOpsStringApi
  146. def sunion[A](key: Any, keys: Any*)(implicit format: Format, parse: Parse[A]): Option[Set[Option[A]]]

    Permalink

    Return the union between the Sets stored at key1, key2, ..., keyN.

    Return the union between the Sets stored at key1, key2, ..., keyN.

    Definition Classes
    SetOpsSetApi
  147. def sunionstore(key: Any, keys: Any*)(implicit format: Format): Option[Long]

    Permalink

    Compute the union between the Sets stored at key1, key2, ..., keyN, and store the resulting Set at dstkey.

    Compute the union between the Sets stored at key1, key2, ..., keyN, and store the resulting Set at dstkey. SUNIONSTORE returns the size of the union, unlike what the documentation says refer http://code.google.com/p/redis/issues/detail?id=121

    Definition Classes
    SetOpsSetApi
  148. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  149. def time[A](implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

    Permalink

    returns the current server time as a two items lists: a Unix timestamp and the amount of microseconds already elapsed in the current second.

    returns the current server time as a two items lists: a Unix timestamp and the amount of microseconds already elapsed in the current second.

    Definition Classes
    BaseOpsBaseApi
  150. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  151. def ttl(key: Any)(implicit format: Format): Option[Long]

    Permalink

    returns the remaining time to live of a key that has a timeout

    returns the remaining time to live of a key that has a timeout

    Definition Classes
    BaseOpsBaseApi
  152. def unwatch(): Boolean

    Permalink

    Flushes all the previously watched keys for a transaction

    Flushes all the previously watched keys for a transaction

    Definition Classes
    BaseOpsBaseApi
  153. def vexists(key: Any, keys: Any*)(implicit format: Format): Option[Long]

    Permalink

    returns the total number of keys existing.

    returns the total number of keys existing. (since 3.0.3)

    Definition Classes
    BaseOpsBaseApi
  154. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  155. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. def watch(key: Any, keys: Any*)(implicit format: Format): Boolean

    Permalink

    Marks the given keys to be watched for conditional execution of a transaction.

    Marks the given keys to be watched for conditional execution of a transaction.

    Definition Classes
    BaseOpsBaseApi
  158. def zadd(key: Any, score: Double, member: Any, scoreVals: (Double, Any)*)(implicit format: Format): Option[Long]

    Permalink

    Add the specified members having the specified score to the sorted set stored at key.

    Add the specified members having the specified score to the sorted set stored at key. (Variadic: >= 2.4)

    Definition Classes
    SortedSetOpsSortedSetApi
  159. def zcard(key: Any)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  160. def zcount(key: Any, min: Double = Double.NegativeInfinity, max: Double = Double.PositiveInfinity, minInclusive: Boolean = true, maxInclusive: Boolean = true)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  161. def zincrby(key: Any, incr: Double, member: Any)(implicit format: Format): Option[Double]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  162. def zinterstore(dstKey: Any, keys: Iterable[Any], aggregate: Aggregate = SUM)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  163. def zinterstoreWeighted(dstKey: Any, kws: Iterable[Product2[Any, Double]], aggregate: Aggregate = SUM)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  164. def zpopmax[A](key: Any, count: Int = 1)(implicit format: Format, parse: Parse[A]): Option[List[(A, Double)]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  165. def zpopmin[A](key: Any, count: Int = 1)(implicit format: Format, parse: Parse[A]): Option[List[(A, Double)]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  166. def zrange[A](key: Any, start: Int = 0, end: Int = 1, sortAs: SortOrder)(implicit format: Format, parse: Parse[A]): Option[List[A]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  167. def zrangeWithScore[A](key: Any, start: Int = 0, end: Int = 1, sortAs: SortOrder = ASC)(implicit format: Format, parse: Parse[A]): Option[List[(A, Double)]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  168. def zrangebylex[A](key: Any, min: String, max: String, limit: Option[(Int, Int)])(implicit format: Format, parse: Parse[A]): Option[List[A]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  169. def zrangebyscore[A](key: Any, min: Double = Double.NegativeInfinity, minInclusive: Boolean = true, max: Double = Double.PositiveInfinity, maxInclusive: Boolean = true, limit: Option[(Int, Int)], sortAs: SortOrder = ASC)(implicit format: Format, parse: Parse[A]): Option[List[A]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  170. def zrangebyscoreWithScore[A](key: Any, min: Double = Double.NegativeInfinity, minInclusive: Boolean = true, max: Double = Double.PositiveInfinity, maxInclusive: Boolean = true, limit: Option[(Int, Int)], sortAs: SortOrder = ASC)(implicit format: Format, parse: Parse[A]): Option[List[(A, Double)]]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  171. def zrank(key: Any, member: Any, reverse: Boolean = false)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  172. def zrem(key: Any, member: Any, members: Any*)(implicit format: Format): Option[Long]

    Permalink

    Remove the specified members from the sorted set value stored at key.

    Remove the specified members from the sorted set value stored at key. (Variadic: >= 2.4)

    Definition Classes
    SortedSetOpsSortedSetApi
  173. def zremrangebyrank(key: Any, start: Int = 0, end: Int = 1)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  174. def zremrangebyscore(key: Any, start: Double = Double.NegativeInfinity, end: Double = Double.PositiveInfinity)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  175. def zscan[A](key: Any, cursor: Int, pattern: Any, count: Int)(implicit format: Format, parse: Parse[A]): Option[(Option[Int], Option[List[Option[A]]])]

    Permalink

    Incrementally iterate sorted sets elements and associated scores (since 2.8)

    Incrementally iterate sorted sets elements and associated scores (since 2.8)

    Definition Classes
    SortedSetOpsSortedSetApi
  176. def zscore(key: Any, element: Any)(implicit format: Format): Option[Double]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  177. def zunionstore(dstKey: Any, keys: Iterable[Any], aggregate: Aggregate = SUM)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi
  178. def zunionstoreWeighted(dstKey: Any, kws: Iterable[Product2[Any, Double]], aggregate: Aggregate = SUM)(implicit format: Format): Option[Long]

    Permalink
    Definition Classes
    SortedSetOpsSortedSetApi

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def hset(key: Any, field: Any, value: Any)(implicit format: Format): Boolean

    Permalink

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    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
    HashOpsHashApi
    Deprecated

    return value semantics is inconsistent with com.redis.HashOperations#hsetnx and com.redis.HashOperations#hmset. Use com.redis.HashOperations#hset1 instead

    See also

    HSET documentation

  3. def set(key: Any, value: Any, onlyIfExists: Boolean, time: SecondsOrMillis): Boolean

    Permalink
    Definition Classes
    StringApi
    Annotations
    @deprecated
    Deprecated

    (Since version 3.10) Use implementation with scala.concurrent.duration.Duration and SetBehaviour

Inherited from HashOps

Inherited from HashApi

Inherited from EvalOps

Inherited from EvalApi

Inherited from SortedSetOps

Inherited from SortedSetApi

Inherited from SetOps

Inherited from SetApi

Inherited from ListOps

Inherited from ListApi

Inherited from StringOps

Inherited from StringApi

Inherited from NodeOps

Inherited from NodeApi

Inherited from BaseOps

Inherited from BaseApi

Inherited from RedisClusterOps

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped