NodeKeysApi

Type Members

abstract type HashKey

The type of Redis hash keys or hash key patterns used in methods representing Redis commands that work on hashes (HashesApi).
The type of Redis hash keys or hash key patterns used in methods representing Redis commands that work on hashes (HashesApi).

Definition Classes
ApiSubset
abstract type Key

The type of Redis keys or key patterns used in methods representing Redis commands.
The type of Redis keys or key patterns used in methods representing Redis commands. For example, if Key = String then get returns Result[Opt[String]]. This type is used only for toplevel Redis keys, hash keys have their own type, HashKey.

Definition Classes
ApiSubset
abstract type Result[A]

The type constructor into which a result of each command is wrapped.
The type constructor into which a result of each command is wrapped. For example if Result is Future, then incr returns Future[Long].

Definition Classes
ApiSubset
abstract type Value

The type of Redis values used in methods representing Redis commands.
The type of Redis values used in methods representing Redis commands. "Value" is the data that might be stored directly under a Redis key (e.g. using set) but also a value of hash field, list element, set member, sorted set member, geo set member or element inserted into hyper-log-log structure. There are no separate types specified for every of those use cases because only one of them can be used in a single command (for example, there is no Redis command that works on both list elements and set members at the same time).

Definition Classes
ApiSubset

Abstract Value Members

abstract def execute[A](command: RedisCommand[A]): Result[A]

Definition Classes
ApiSubset
implicit abstract def hashKeyCodec: RedisDataCodec[HashKey]

Attributes
protected
Definition Classes
ApiSubset
implicit abstract def keyCodec: RedisDataCodec[Key]

Attributes
protected
Definition Classes
ApiSubset
implicit abstract def valueCodec: RedisDataCodec[Value]

Attributes
protected
Definition Classes
ApiSubset

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def del(keys: Iterable[Key]): Result[Int]

Executes DEL or simply returns 0 if keys is empty, without sending the command to Redis
Executes DEL or simply returns 0 if keys is empty, without sending the command to Redis

Definition Classes
KeyedKeysApi
def del(key: Key, keys: Key*): Result[Int]

Executes DEL
Executes DEL

Definition Classes
KeyedKeysApi
def del(key: Key): Result[Boolean]

Executes DEL
Executes DEL

Definition Classes
KeyedKeysApi
def dump(key: Key): Result[commons.Opt[Dumped]]

Executes DUMP
Executes DUMP

Definition Classes
KeyedKeysApi
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exists(keys: Iterable[Key]): Result[Int]

Executes EXISTS or simply returns 0 when keys is empty, without sending the command to Redis
Executes EXISTS or simply returns 0 when keys is empty, without sending the command to Redis

Definition Classes
KeyedKeysApi
def exists(key: Key, keys: Key*): Result[Int]

Executes EXISTS
Executes EXISTS

Definition Classes
KeyedKeysApi
def exists(key: Key): Result[Boolean]

Executes EXISTS
Executes EXISTS

Definition Classes
KeyedKeysApi
def expire(key: Key, seconds: Long): Result[Boolean]

Executes EXPIRE
Executes EXPIRE

Definition Classes
KeyedKeysApi
def expireat(key: Key, timestamp: Long): Result[Boolean]

Executes EXPIREAT
Executes EXPIREAT

Definition Classes
KeyedKeysApi
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit def headOps[T](head: T): HeadOps[T]

Attributes
protected
Definition Classes
ApiSubset
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def iterableTailOps[T](tail: Iterable[T]): IterableTailOps[T]

Attributes
protected
Definition Classes
ApiSubset
implicit def iteratorTailOps[T](tail: Iterator[T]): IteratorTailOps[T]

Attributes
protected
Definition Classes
ApiSubset
def keys(pattern: Key): Result[commons.BSet[Key]]

Executes KEYS
def migrate(keys: Iterable[Key], address: NodeAddress, destinationDb: Int, timeout: Long, copy: Boolean = false, replace: Boolean = false): Result[Boolean]

Executes MIGRATE or simply returns true when keys is empty, without sending the command to Redis
Executes MIGRATE or simply returns true when keys is empty, without sending the command to Redis

Definition Classes
KeyedKeysApi
def move(key: Key, db: Int): Result[Boolean]

Executes MOVE
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def objectEncoding(key: Key): Result[commons.Opt[Encoding]]

Executes OBJECT
Executes OBJECT

Definition Classes
KeyedKeysApi
def objectIdletime(key: Key): Result[commons.Opt[Long]]

Executes OBJECT
Executes OBJECT

Definition Classes
KeyedKeysApi
def objectRefcount(key: Key): Result[commons.Opt[Long]]

Executes OBJECT
Executes OBJECT

Definition Classes
KeyedKeysApi
def persist(key: Key): Result[Boolean]

Executes PERSIST
Executes PERSIST

Definition Classes
KeyedKeysApi
def pexpire(key: Key, milliseconds: Long): Result[Boolean]

Executes PEXPIRE
Executes PEXPIRE

Definition Classes
KeyedKeysApi
def pexpireat(key: Key, millisecondsTimestamp: Long): Result[Boolean]

Executes PEXPIREAT
Executes PEXPIREAT

Definition Classes
KeyedKeysApi
def pttl(key: Key): Result[commons.Opt[commons.Opt[Long]]]

Executes PTTL
Executes PTTL

Definition Classes
KeyedKeysApi
def randomkey: Result[commons.Opt[Key]]

Executes RANDOMKEY
def rename(key: Key, newkey: Key): Result[Unit]

Executes RENAME
Executes RENAME

Definition Classes
KeyedKeysApi
def renamenx(key: Key, newkey: Key): Result[Boolean]

Executes RENAMENX
Executes RENAMENX

Definition Classes
KeyedKeysApi
def restore(key: Key, ttl: Long, dumpedValue: Dumped, replace: Boolean = false): Result[Unit]

Executes RESTORE
Executes RESTORE

Definition Classes
KeyedKeysApi
def scan(cursor: Cursor, matchPattern: commons.OptArg[Key] = OptArg.Empty, count: commons.OptArg[Long] = OptArg.Empty): Result[(Cursor, Seq[Key])]

Executes SCAN
def sort(key: Key, by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Seq[Value]]

Executes SORT
Executes SORT

Definition Classes
KeyedKeysApi
def sortGet(key: Key, gets: Seq[SortPattern[Key, HashKey]], by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Seq[Seq[commons.Opt[Value]]]]

Executes SORT
Executes SORT

Definition Classes
KeyedKeysApi
def sortStore(key: Key, destination: Key, by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, gets: Seq[SortPattern[Key, HashKey]] = Nil, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Long]

Executes SORT
Executes SORT

Definition Classes
KeyedKeysApi
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def touch(keys: Iterable[Key]): Result[Int]

Executes TOUCH or simply returns 0 when keys is empty, without sending the command to Redis
Executes TOUCH or simply returns 0 when keys is empty, without sending the command to Redis

Definition Classes
KeyedKeysApi
def touch(key: Key, keys: Key*): Result[Int]

Executes TOUCH
Executes TOUCH

Definition Classes
KeyedKeysApi
def touch(key: Key): Result[Boolean]

Executes TOUCH
Executes TOUCH

Definition Classes
KeyedKeysApi
def ttl(key: Key): Result[commons.Opt[commons.Opt[Long]]]

Executes TTL
Executes TTL

Definition Classes
KeyedKeysApi
def type(key: Key): Result[RedisType]

Executes TYPE
Executes TYPE

Definition Classes
KeyedKeysApi
def unlink(keys: Iterable[Key]): Result[Int]

Executes UNLINK or simply returns 0 when keys is empty, without sending the command to Redis
Executes UNLINK or simply returns 0 when keys is empty, without sending the command to Redis

Definition Classes
KeyedKeysApi
def unlink(key: Key, keys: Key*): Result[Int]

Executes UNLINK
Executes UNLINK

Definition Classes
KeyedKeysApi
def unlink(key: Key): Result[Boolean]

Executes UNLINK
Executes UNLINK

Definition Classes
KeyedKeysApi
def wait(numslaves: Int, timeout: Long): Result[Long]

Executes WAIT
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package commands

trait NodeKeysApi extends KeyedKeysApi with ApiSubset

Type Members

abstract type HashKey

abstract type Key

abstract type Result[A]

abstract type Value

Abstract Value Members

abstract def execute[A](command: RedisCommand[A]): Result[A]

implicit abstract def hashKeyCodec: RedisDataCodec[HashKey]

implicit abstract def keyCodec: RedisDataCodec[Key]

implicit abstract def valueCodec: RedisDataCodec[Value]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def del(keys: Iterable[Key]): Result[Int]

def del(key: Key, keys: Key*): Result[Int]

def del(key: Key): Result[Boolean]

def dump(key: Key): Result[commons.Opt[Dumped]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(keys: Iterable[Key]): Result[Int]

def exists(key: Key, keys: Key*): Result[Int]

def exists(key: Key): Result[Boolean]

def expire(key: Key, seconds: Long): Result[Boolean]

def expireat(key: Key, timestamp: Long): Result[Boolean]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

implicit def headOps[T](head: T): HeadOps[T]

final def isInstanceOf[T0]: Boolean

implicit def iterableTailOps[T](tail: Iterable[T]): IterableTailOps[T]

implicit def iteratorTailOps[T](tail: Iterator[T]): IteratorTailOps[T]

def keys(pattern: Key): Result[commons.BSet[Key]]

def migrate(keys: Iterable[Key], address: NodeAddress, destinationDb: Int, timeout: Long, copy: Boolean = false, replace: Boolean = false): Result[Boolean]

def move(key: Key, db: Int): Result[Boolean]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def objectEncoding(key: Key): Result[commons.Opt[Encoding]]

def objectIdletime(key: Key): Result[commons.Opt[Long]]

def objectRefcount(key: Key): Result[commons.Opt[Long]]

def persist(key: Key): Result[Boolean]

def pexpire(key: Key, milliseconds: Long): Result[Boolean]

def pexpireat(key: Key, millisecondsTimestamp: Long): Result[Boolean]

def pttl(key: Key): Result[commons.Opt[commons.Opt[Long]]]

def randomkey: Result[commons.Opt[Key]]

def rename(key: Key, newkey: Key): Result[Unit]

def renamenx(key: Key, newkey: Key): Result[Boolean]

def restore(key: Key, ttl: Long, dumpedValue: Dumped, replace: Boolean = false): Result[Unit]

def scan(cursor: Cursor, matchPattern: commons.OptArg[Key] = OptArg.Empty, count: commons.OptArg[Long] = OptArg.Empty): Result[(Cursor, Seq[Key])]

def sort(key: Key, by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Seq[Value]]

def sortGet(key: Key, gets: Seq[SortPattern[Key, HashKey]], by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Seq[Seq[commons.Opt[Value]]]]

def sortStore(key: Key, destination: Key, by: commons.OptArg[SortPattern[Key, HashKey]] = OptArg.Empty, limit: commons.OptArg[SortLimit] = OptArg.Empty, gets: Seq[SortPattern[Key, HashKey]] = Nil, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty, alpha: Boolean = false): Result[Long]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def touch(keys: Iterable[Key]): Result[Int]

def touch(key: Key, keys: Key*): Result[Int]

def touch(key: Key): Result[Boolean]

def ttl(key: Key): Result[commons.Opt[commons.Opt[Long]]]

def type(key: Key): Result[RedisType]

def unlink(keys: Iterable[Key]): Result[Int]

def unlink(key: Key, keys: Key*): Result[Int]

def unlink(key: Key): Result[Boolean]

def wait(numslaves: Int, timeout: Long): Result[Long]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from KeyedKeysApi

Inherited from ApiSubset

Inherited from AnyRef

Inherited from Any

Ungrouped