Packages

final class KeyCommands[K, V] extends AnyRef

Exposes the set of redis key commands available.

Source
KeyCommands.scala
See also

Key commands reference.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyCommands
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def del(keys: K*): Task[Long]

    Delete one or more keys.

    Delete one or more keys.

    returns

    The number of keys that were removed.

    See also

    DEL.

  7. def dump(key: K): 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.

    See also

    DUMP.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def exists(key: K): Task[Boolean]
  11. def exists(keys: List[K]): Task[Long]

    Determine how many keys exist.

    Determine how many keys exist.

    returns

    Number of existing keys

    See also

    EXISTS.

  12. def expire(key: K, timeout: FiniteDuration): Task[Boolean]

    Set a key's time to live with a precision of milliseconds.

    Set a key's time to live with a precision of milliseconds.

    returns

    true if the timeout was set. false if key does not exist or the timeout could not be set.

    See also

    EXPIRE.

  13. def expireAt(key: K, date: Date): Task[Boolean]
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def keyType(key: K): Task[Option[String]]

    Determine the type stored at key.

    Determine the type stored at key.

    returns

    Type of key, or none when key does not exist.

  19. def keys(pattern: K): Observable[K]

    Find all keys matching the given pattern.

    Find all keys matching the given pattern.

    returns

    Keys matching the pattern.

    See also

    KEYS.

  20. def move(key: K, db: Int): Task[Boolean]

    Move a key to another database.

    Move a key to another database.

    returns

    True if the move operation succeeded, false if not.

    See also

    MOVE.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def objectEncoding(key: K): Task[Option[String]]

    Shows the kind of internal representation used in order to store the value associated with a key.

    Shows the kind of internal representation used in order to store the value associated with a key.

    returns

    if exists, returns a String representing the object encoding.

  25. def objectIdleTime(key: K): Task[Option[FiniteDuration]]

    Time since the object stored at the specified key is idle (not requested by read or write operations).

  26. def objectRefCount(key: K): Task[Long]

    todo test Number of references of the value associated with the specified key.

    todo test Number of references of the value associated with the specified key. *

  27. def persist(key: K): Task[Boolean]

    Removes the expiration from a key.

    Removes 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.

    See also

    PERSIST.

  28. def pttl(key: K): Task[FiniteDuration]

    Get the time to live for a key.

    Get the time to live for a key.

    returns

    It is a variant of the Redis PTTL, but instead of an integer representing milliseconds, it returns aFiniteDuration. A negative value -2 if the key does not exists, or on unexpected error.

    See also

    PTTL.

  29. def randomKey(): Task[Option[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.

    See also

    RANDOMKEY.

  30. def rename(key: K, newKey: K): Task[Unit]

    Rename a key.

    Rename a key.

    See also

    RENAME.

  31. def renameNx(key: K, newKey: K): 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.

    See also

    RENAMENX.

  32. def restore(key: K, ttl: FiniteDuration, value: Array[Byte]): Task[Unit]

    Create a key using the provided serialized value, previously obtained using DUMP.

    Create a key using the provided serialized value, previously obtained using DUMP.

    See also

    RESTORE.

  33. def sort(key: K): 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.

    See also

    SORT.

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def touch(keys: K*): 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.

    See also

    TOUCH.

  37. def unLink(keys: K*): 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.

    See also

    UNLINK.

  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped