Type Members

1.  sealed trait AclCategory extends AnyRef

   A Redis ACL command category (the closed set understood by the driver).

2.  sealed abstract class AclError extends RuntimeException

   Failure raised while encoding ACL arguments or decoding ACL replies.

3.  final case class AclSelector(commands: String, keys: String, channels: String) extends Product with Serializable

   A command/key/channel selector attached to an ACL user (Redis 7+), as returned by ACL GETUSER.

4.  sealed trait AclSetUserRule extends AnyRef

   A single rule passed to ACL SETUSER, applied in the order given.

   A single rule passed to ACL SETUSER, applied in the order given. Mirrors Lettuce's AclSetuserArgs.

5.  final case class AclUser(flags: List[String], passwords: List[String], commands: String, keys: String, channels: String, selectors: List[AclSelector]) extends Product with Serializable

   An ACL user as returned by ACL GETUSER.

   An ACL user as returned by ACL GETUSER. The commands, keys and channels fields hold the rule strings exactly as Redis reports them (e.g. "-@all +get", "~app:*", "&*").

6.  final case class CopyArgs(destinationDb: Option[Long], replace: Option[Boolean]) extends Product with Serializable
7.  final case class Distance(value: Double) extends AnyVal with Product with Serializable
8.  sealed trait ExpireExistenceArg extends AnyRef
9.  sealed trait FlushMode extends AnyRef
10.  sealed trait FunctionRestoreMode extends AnyRef
11.  final case class GeoCoordinate(x: Double, y: Double) extends Product with Serializable
12.  final case class GeoHash(value: Long) extends AnyVal with Product with Serializable
13.  final case class GeoLocation[V](lon: Longitude, lat: Latitude, value: V) extends Product with Serializable
14.  final case class GeoRadius(lon: Longitude, lat: Latitude, dist: Distance) extends Product with Serializable
15.  final case class GeoRadiusDistStorage[K](key: K, count: Long, sort: Sort) extends Product with Serializable
16.  final case class GeoRadiusKeyStorage[K](key: K, count: Long, sort: Sort) extends Product with Serializable
17.  final case class GeoRadiusResult[V](value: V, dist: Distance, hash: GeoHash, coordinate: GeoCoordinate) extends Product with Serializable
18.  sealed trait GetExArg extends AnyRef
19.  sealed trait HGetExArgs extends AnyRef
20.  sealed abstract class KeyScanArgs extends AnyRef
21.  final case class Latitude(value: Double) extends AnyVal with Product with Serializable
22.  final case class Longitude(value: Double) extends AnyVal with Product with Serializable
23.  final case class MessageId(value: String) extends AnyVal with Product with Serializable
24.  final case class RangeLimit(offset: Long, count: Long) extends Product with Serializable
25.  final case class RawCommand(value: String) extends AnyVal with Product with Serializable

    A raw Redis command name for use in ACL SETUSER rules (e.g.

    A raw Redis command name for use in ACL SETUSER rules (e.g. RawCommand("get")).

    The set of Redis commands is open (modules and new versions add commands), so it is modelled as an explicit string rather than a closed enum. Names unknown to the driver surface as AclError.UnknownCommand when the rule is applied, rather than throwing.

26.  sealed abstract class RedisType extends AnyRef
27.  final case class RestoreArgs(ttl: Option[Long] = None, replace: Option[Boolean] = None, absttl: Option[Boolean] = None, idleTime: Option[Long] = None) extends Product with Serializable
28.  case class ScanArgs(match: Option[String], count: Option[Long]) extends Product with Serializable
29.  final case class Score(value: Double) extends AnyVal with Product with Serializable
30.  final case class ScoreWithValue[V](score: Score, value: V) extends Product with Serializable
31.  sealed trait ScriptOutputType[V] extends AnyRef
32.  sealed trait SetArg extends AnyRef
33.  case class SetArgs(existence: Option[Existence], ttl: Option[Ttl]) extends Product with Serializable
34.  final case class StreamConsumer[K](group: K, consumer: K) extends Product with Serializable

    Identifies a consumer within a consumer group (the <group> <consumer> pair shared by XREADGROUP, XCLAIM, XAUTOCLAIM and the XGROUP *CONSUMER commands).

35.  final case class StreamMessage[K, V](id: MessageId, key: K, body: Map[K, V]) extends Product with Serializable
36.  implicit final class TimePrecisionOps extends AnyVal
37.  final case class XAddArgs(nomkstream: Boolean = false, id: Option[String] = None, xTrimArgs: Option[XTrimArgs] = None) extends Product with Serializable
38.  final case class XAutoClaimArgs[K](consumer: StreamConsumer[K], minIdleTime: FiniteDuration, start: String = "0", count: Option[Long] = None, justId: Boolean = false) extends Product with Serializable

    Options for XAUTOCLAIM.

    Options for XAUTOCLAIM. start is the message id to start scanning the PEL from (defaults to 0).

39.  final case class XAutoClaimResult[K, V](nextId: MessageId, messages: List[StreamMessage[K, V]]) extends Product with Serializable

    Result of XAUTOCLAIM: the cursor to resume from plus the claimed messages.

40.  final case class XClaimArgs(minIdleTime: FiniteDuration, idle: Option[XClaimIdle] = None, retryCount: Option[Long] = None, force: Boolean = false, justId: Boolean = false) extends Product with Serializable

    Options for XCLAIM.

41.  sealed trait XClaimIdle extends Product with Serializable

    The idle time to set on entries claimed by XCLAIM (the IDLE/TIME options).

    The idle time to set on entries claimed by XCLAIM (the IDLE/TIME options). Both express the same thing — the time since the entry was last delivered — so they are modelled as alternatives rather than a pair that could be set together.

42.  final case class XGroupCreateArgs(mkStream: Boolean = false, entriesRead: Option[Long] = None) extends Product with Serializable

    Options for XGROUP CREATE.

43.  final case class XPendingMessage(id: MessageId, consumer: String, sinceLastDelivery: FiniteDuration, redeliveryCount: Long) extends Product with Serializable

    A single entry from the extended form of XPENDING.

44.  final case class XPendingSummary(count: Long, minId: Option[MessageId], maxId: Option[MessageId], consumers: Map[String, Long]) extends Product with Serializable

    Summary form of XPENDING <key> <group>.

45.  sealed abstract class XRangePoint extends Product with Serializable
46.  final case class XReadGroupArgs(count: Option[Long] = None, block: Option[Duration] = None, noack: Boolean = false) extends Product with Serializable

    Options for XREADGROUP.

    Options for XREADGROUP. noack skips adding the messages to the Pending Entries List.

47.  sealed trait XReadOffsets[K] extends Product with Serializable
48.  final case class XTrimArgs(strategy: Strategy, precision: Precision = XTrimArgs.Precision.Exact) extends Product with Serializable
49.  final case class ZRange[V](start: V, end: V) extends Product with Serializable