redis4cats-effects
API
Generated with
redis4cats-effects/dev.profunktor.redis4cats/RedisCommands

RedisCommands

dev.profunktor.redis4cats.RedisCommands
See theRedisCommands companion object
trait RedisCommands[F[_], K, V] extends StringCommands[F, K, V], HashCommands[F, K, V], SetCommands[F, K, V], SortedSetCommands[F, K, V], ListCommands[F, K, V], GeoCommands[F, K, V], ConnectionCommands[F, K], ServerCommands[F, K], TransactionalCommands[F, K], PipelineCommands[F], ScriptCommands[F, K, V], KeyCommands[F, K], HyperLogLogCommands[F, K, V], BitCommands[F, K, V]

Attributes

Companion
object
Graph
Supertypes
trait BitCommands[F, K, V]
trait HyperLogLogCommands[F, K, V]
trait KeyCommands[F, K]
trait ScriptCommands[F, K, V]
trait Scripting[F, K, V]
trait PipelineCommands[F]
trait AutoFlush[F]
trait TransactionalCommands[F, K]
trait Pipelining[F]
trait HighLevelTx[F]
trait Watcher[F, K]
trait Transaction[F]
trait ServerCommands[F, K]
trait Diagnostic[F]
trait Flush[F, K]
trait ConnectionCommands[F, K]
trait Client[F, K]
trait Auth[F]
trait Ping[F]
trait GeoCommands[F, K, V]
trait GeoSetter[F, K, V]
trait GeoGetter[F, K, V]
trait ListCommands[F, K, V]
trait ListPushPop[F, K, V]
trait ListSetter[F, K, V]
trait ListGetter[F, K, V]
trait ListBlocking[F, K, V]
trait SortedSetCommands[F, K, V]
trait SortedSetSetter[F, K, V]
trait SortedSetGetter[F, K, V]
trait SetCommands[F, K, V]
trait SetDeletion[F, K, V]
trait SetSetter[F, K, V]
trait SetGetter[F, K, V]
trait HashCommands[F, K, V]
trait HashIncrement[F, K, V]
trait HashSetter[F, K, V]
trait HashGetter[F, K, V]
trait StringCommands[F, K, V]
trait Unsafe[F, K, V]
trait Increment[F, K, V]
trait Decrement[F, K, V]
trait MultiKey[F, K, V]
trait Setter[F, K, V]
trait Getter[F, K, V]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def liftK[G[_] : Log]: RedisCommands[G, K, V]
Implicitly added by LiftKOps

Inherited methods

def append(key: K, value: V): F[Unit]

Attributes

Inherited from:
Setter
def auth(username: String, password: CharSequence): F[Boolean]

Attributes

Inherited from:
Auth
def auth(password: CharSequence): F[Boolean]

Attributes

Inherited from:
Auth
def bitCount(key: K, start: Long, end: Long): F[Long]

Attributes

Inherited from:
BitCommands
def bitCount(key: K): F[Long]

Attributes

Inherited from:
BitCommands
def bitField(key: K, operations: BitCommandOperation*): F[List[Long]]

Attributes

Inherited from:
BitCommands
def bitOpAnd(destination: K, sources: K*): F[Unit]

Attributes

Inherited from:
BitCommands
def bitOpNot(destination: K, source: K): F[Unit]

Attributes

Inherited from:
BitCommands
def bitOpOr(destination: K, sources: K*): F[Unit]

Attributes

Inherited from:
BitCommands
def bitOpXor(destination: K, sources: K*): F[Unit]

Attributes

Inherited from:
BitCommands
def bitPos(key: K, state: Boolean, start: Long, end: Long): F[Long]

Attributes

Inherited from:
BitCommands
def bitPos(key: K, state: Boolean, start: Long): F[Long]

Attributes

Inherited from:
BitCommands
def bitPos(key: K, state: Boolean): F[Long]

Attributes

Inherited from:
BitCommands
def blPop(timeout: Duration, keys: NonEmptyList[K]): F[Option[(K, V)]]

Attributes

Inherited from:
ListBlocking
def brPop(timeout: Duration, keys: NonEmptyList[K]): F[Option[(K, V)]]

Attributes

Inherited from:
ListBlocking
def brPopLPush(timeout: Duration, source: K, destination: K): F[Option[V]]

Attributes

Inherited from:
ListBlocking
def bzPopMax(timeout: Duration, keys: NonEmptyList[K]): F[Option[(K, ScoreWithValue[V])]]

Attributes

Inherited from:
SortedSetGetter
def bzPopMin(timeout: Duration, keys: NonEmptyList[K]): F[Option[(K, ScoreWithValue[V])]]

Attributes

Inherited from:
SortedSetGetter
def dbsize: F[Long]

Attributes

Inherited from:
Diagnostic
def decr(key: K): F[Long]

Attributes

Inherited from:
Decrement
def decrBy(key: K, amount: Long): F[Long]

Attributes

Inherited from:
Decrement
def del(key: K*): F[Long]

Attributes

Inherited from:
KeyCommands
def digest(script: String): F[String]

Attributes

Inherited from:
Scripting
def disableAutoFlush: F[Unit]

Attributes

Inherited from:
AutoFlush
def discard: F[Unit]

Attributes

Inherited from:
Transaction
def enableAutoFlush: F[Unit]

Attributes

Inherited from:
AutoFlush
def eval(script: String, output: ScriptOutputType[V], keys: List[K], values: List[V]): F[R]

Attributes

Inherited from:
Scripting
def eval(script: String, output: ScriptOutputType[V], keys: List[K]): F[R]

Attributes

Inherited from:
Scripting
def eval(script: String, output: ScriptOutputType[V]): F[R]

Attributes

Inherited from:
Scripting
def evalSha(digest: String, output: ScriptOutputType[V], keys: List[K], values: List[V]): F[R]

Attributes

Inherited from:
Scripting
def evalSha(digest: String, output: ScriptOutputType[V], keys: List[K]): F[R]

Attributes

Inherited from:
Scripting
def evalSha(digest: String, output: ScriptOutputType[V]): F[R]

Attributes

Inherited from:
Scripting
def exec: F[Unit]

Attributes

Inherited from:
Transaction
def exists(key: K*): F[Boolean]

Attributes

Inherited from:
KeyCommands
def expire(key: K, expiresIn: FiniteDuration): F[Boolean]

Attributes

Inherited from:
KeyCommands
def expireAt(key: K, at: Instant): F[Boolean]

Attributes

Inherited from:
KeyCommands
def flushAll: F[Unit]

Attributes

Inherited from:
Flush
def flushCommands: F[Unit]

Attributes

Inherited from:
AutoFlush
def geoAdd(key: K, geoValues: GeoLocation[V]*): F[Unit]

Attributes

Inherited from:
GeoSetter
def geoDist(key: K, from: V, to: V, unit: Unit): F[Double]

Attributes

Inherited from:
GeoGetter
def geoHash(key: K, values: V*): F[List[Option[String]]]

Attributes

Inherited from:
GeoGetter
def geoPos(key: K, values: V*): F[List[GeoCoordinate]]

Attributes

Inherited from:
GeoGetter
def geoRadius(key: K, geoRadius: GeoRadius, unit: Unit, storage: GeoRadiusDistStorage[K]): F[Unit]

Attributes

Inherited from:
GeoSetter
def geoRadius(key: K, geoRadius: GeoRadius, unit: Unit, storage: GeoRadiusKeyStorage[K]): F[Unit]

Attributes

Inherited from:
GeoSetter
def geoRadius(key: K, geoRadius: GeoRadius, unit: Unit, args: GeoArgs): F[List[GeoRadiusResult[V]]]

Attributes

Inherited from:
GeoGetter
def geoRadius(key: K, geoRadius: GeoRadius, unit: Unit): F[Set[V]]

Attributes

Inherited from:
GeoGetter
def geoRadiusByMember(key: K, value: V, dist: Distance, unit: Unit, storage: GeoRadiusDistStorage[K]): F[Unit]

Attributes

Inherited from:
GeoSetter
def geoRadiusByMember(key: K, value: V, dist: Distance, unit: Unit, storage: GeoRadiusKeyStorage[K]): F[Unit]

Attributes

Inherited from:
GeoSetter
def geoRadiusByMember(key: K, value: V, dist: Distance, unit: Unit, args: GeoArgs): F[List[GeoRadiusResult[V]]]

Attributes

Inherited from:
GeoGetter
def geoRadiusByMember(key: K, value: V, dist: Distance, unit: Unit): F[Set[V]]

Attributes

Inherited from:
GeoGetter
def get(key: K): F[Option[V]]

Attributes

Inherited from:
Getter
def getBit(key: K, offset: Long): F[Option[Long]]

Attributes

Inherited from:
BitCommands
def getClientId(): F[Long]

Attributes

Inherited from:
Client
def getClientName(): F[Option[K]]

Attributes

Inherited from:
Client
def getEx(key: K, getExArg: GetExArg): F[Option[V]]

Attributes

Inherited from:
Getter
def getRange(key: K, start: Long, end: Long): F[Option[V]]

Attributes

Inherited from:
Getter
def getSet(key: K, value: V): F[Option[V]]

Attributes

Inherited from:
Setter
def hDel(key: K, field: K, fields: K*): F[Long]

Attributes

Inherited from:
HashCommands
def hExists(key: K, field: K): F[Boolean]

Attributes

Inherited from:
HashCommands
def hGet(key: K, field: K): F[Option[V]]

Attributes

Inherited from:
HashGetter
def hGetAll(key: K): F[Map[K, V]]

Attributes

Inherited from:
HashGetter
def hIncrBy(key: K, field: K, amount: Long): F[Long]

Attributes

Inherited from:
HashIncrement
def hIncrByFloat(key: K, field: K, amount: Double): F[Double]

Attributes

Inherited from:
HashIncrement
def hKeys(key: K): F[List[K]]

Attributes

Inherited from:
HashGetter
def hLen(key: K): F[Option[Long]]

Attributes

Inherited from:
HashGetter
def hSet(key: K, fieldValues: Map[K, V]): F[Long]

Attributes

Inherited from:
HashSetter
def hSet(key: K, field: K, value: V): F[Boolean]

Attributes

Inherited from:
HashSetter
def hSetNx(key: K, field: K, value: V): F[Boolean]

Attributes

Inherited from:
HashSetter
def hStrLen(key: K, field: K): F[Option[Long]]

Attributes

Inherited from:
HashGetter
def hVals(key: K): F[List[V]]

Attributes

Inherited from:
HashGetter
def hmGet(key: K, field: K, fields: K*): F[Map[K, V]]

Attributes

Inherited from:
HashGetter
def incr(key: K): F[Long]

Attributes

Inherited from:
Increment
def incrBy(key: K, amount: Long): F[Long]

Attributes

Inherited from:
Increment
def incrByFloat(key: K, amount: Double): F[Double]

Attributes

Inherited from:
Increment
def info(section: String): F[Map[String, String]]

Attributes

Inherited from:
Diagnostic
def info: F[Map[String, String]]

Attributes

Inherited from:
Diagnostic
def keys(key: K): F[List[K]]

Attributes

Inherited from:
Flush
def lIndex(key: K, index: Long): F[Option[V]]

Attributes

Inherited from:
ListGetter
def lInsertAfter(key: K, pivot: V, value: V): F[Long]

Attributes

Inherited from:
ListSetter
def lInsertBefore(key: K, pivot: V, value: V): F[Long]

Attributes

Inherited from:
ListSetter
def lLen(key: K): F[Option[Long]]

Attributes

Inherited from:
ListGetter
def lPop(key: K): F[Option[V]]

Attributes

Inherited from:
ListPushPop
def lPush(key: K, values: V*): F[Long]

Attributes

Inherited from:
ListPushPop
def lPushX(key: K, values: V*): F[Long]

Attributes

Inherited from:
ListPushPop
def lRange(key: K, start: Long, stop: Long): F[List[V]]

Attributes

Inherited from:
ListGetter
def lRem(key: K, count: Long, value: V): F[Long]

Attributes

Inherited from:
ListSetter
def lSet(key: K, index: Long, value: V): F[Unit]

Attributes

Inherited from:
ListSetter
def lTrim(key: K, start: Long, stop: Long): F[Unit]

Attributes

Inherited from:
ListSetter
def lastSave: F[Instant]

Attributes

Inherited from:
Diagnostic
def mGet(keys: Set[K]): F[Map[K, V]]

Attributes

Inherited from:
MultiKey
def mSet(keyValues: Map[K, V]): F[Unit]

Attributes

Inherited from:
MultiKey
def mSetNx(keyValues: Map[K, V]): F[Boolean]

Attributes

Inherited from:
MultiKey
def multi: F[Unit]

Attributes

Inherited from:
Transaction
def objectIdletime(key: K): F[Option[FiniteDuration]]

Attributes

Inherited from:
KeyCommands
def pfAdd(key: K, values: V*): F[Long]

Attributes

Inherited from:
HyperLogLogCommands
def pfCount(key: K): F[Long]

Attributes

Inherited from:
HyperLogLogCommands
def pfMerge(outputKey: K, inputKeys: K*): F[Unit]

Attributes

Inherited from:
HyperLogLogCommands
def ping: F[String]

Attributes

Inherited from:
Ping
def pipeline[A](fs: TxStore[F, String, A] => List[F[Unit]]): F[Map[String, A]]

Attributes

Inherited from:
Pipelining
def pipeline_(fs: List[F[Unit]]): F[Unit]

Attributes

Inherited from:
Pipelining
def pttl(key: K): F[Option[FiniteDuration]]

Attributes

Inherited from:
KeyCommands
def rPop(key: K): F[Option[V]]

Attributes

Inherited from:
ListPushPop
def rPopLPush(source: K, destination: K): F[Option[V]]

Attributes

Inherited from:
ListPushPop
def rPush(key: K, values: V*): F[Long]

Attributes

Inherited from:
ListPushPop
def rPushX(key: K, values: V*): F[Long]

Attributes

Inherited from:
ListPushPop
def sAdd(key: K, values: V*): F[Long]

Attributes

Inherited from:
SetSetter
def sCard(key: K): F[Long]

Attributes

Inherited from:
SetGetter
def sDiff(keys: K*): F[Set[V]]

Attributes

Inherited from:
SetGetter
def sDiffStore(destination: K, keys: K*): F[Long]

Attributes

Inherited from:
SetSetter
def sInter(keys: K*): F[Set[V]]

Attributes

Inherited from:
SetGetter
def sInterStore(destination: K, keys: K*): F[Long]

Attributes

Inherited from:
SetSetter
def sIsMember(key: K, value: V): F[Boolean]

Attributes

Inherited from:
SetCommands
def sMembers(key: K): F[Set[V]]

Attributes

Inherited from:
SetGetter
def sMisMember(key: K, values: V*): F[List[Boolean]]

Attributes

Inherited from:
SetCommands
def sMove(source: K, destination: K, value: V): F[Boolean]

Attributes

Inherited from:
SetSetter
def sPop(key: K, count: Long): F[Set[V]]

Attributes

Inherited from:
SetDeletion
def sPop(key: K): F[Option[V]]

Attributes

Inherited from:
SetDeletion
def sRandMember(key: K, count: Long): F[List[V]]

Attributes

Inherited from:
SetGetter
def sRandMember(key: K): F[Option[V]]

Attributes

Inherited from:
SetGetter
def sRem(key: K, values: V*): F[Long]

Attributes

Inherited from:
SetDeletion
def sUnion(keys: K*): F[Set[V]]

Attributes

Inherited from:
SetGetter
def sUnionStore(destination: K, keys: K*): F[Unit]

Attributes

Inherited from:
SetGetter
def scan(previous: KeyScanCursor[K], scanArgs: ScanArgs): F[KeyScanCursor[K]]

Attributes

Inherited from:
KeyCommands
def scan(scanArgs: ScanArgs): F[KeyScanCursor[K]]

Attributes

Inherited from:
KeyCommands
def scan(previous: KeyScanCursor[K]): F[KeyScanCursor[K]]

Attributes

Inherited from:
KeyCommands
def scan: F[KeyScanCursor[K]]

Attributes

Inherited from:
KeyCommands
def scriptExists(digests: String*): F[List[Boolean]]

Attributes

Inherited from:
Scripting
def scriptFlush: F[Unit]

Attributes

Inherited from:
Scripting
def scriptLoad(script: Array[Byte]): F[String]

Attributes

Inherited from:
Scripting
def scriptLoad(script: String): F[String]

Attributes

Inherited from:
Scripting
def select(index: Int): F[Unit]

Attributes

Inherited from:
Ping
def set(key: K, value: V, setArgs: SetArgs): F[Boolean]

Attributes

Inherited from:
Setter
def set(key: K, value: V): F[Unit]

Attributes

Inherited from:
Setter
def setBit(key: K, offset: Long, value: Int): F[Long]

Attributes

Inherited from:
BitCommands
def setClientName(name: K): F[Boolean]

Attributes

Inherited from:
Client
def setEx(key: K, value: V, expiresIn: FiniteDuration): F[Unit]

Attributes

Inherited from:
Setter
def setNx(key: K, value: V): F[Boolean]

Attributes

Inherited from:
Setter
def setRange(key: K, value: V, offset: Long): F[Unit]

Attributes

Inherited from:
Setter
def slowLogLen: F[Long]

Attributes

Inherited from:
Diagnostic
def strLen(key: K): F[Option[Long]]

Attributes

Inherited from:
Getter
def transact[A](fs: TxStore[F, String, A] => List[F[Unit]]): F[Map[String, A]]

Attributes

Inherited from:
HighLevelTx
def transact_(fs: List[F[Unit]]): F[Unit]

Attributes

Inherited from:
HighLevelTx
def ttl(key: K): F[Option[FiniteDuration]]

Attributes

Inherited from:
KeyCommands
def unsafe[A](f: RedisClusterAsyncCommands[K, V] => RedisFuture[A]): F[A]

USE WITH CAUTION! It gives you access to the underlying Java API.

USE WITH CAUTION! It gives you access to the underlying Java API.

Useful whenever Redis4cats does not yet support the operation you're looking for.

Attributes

Inherited from:
Unsafe
def unsafeSync[A](f: RedisClusterAsyncCommands[K, V] => A): F[A]

USE WITH CAUTION! It gives you access to the underlying Java API.

USE WITH CAUTION! It gives you access to the underlying Java API.

Useful whenever Redis4cats does not yet support the operation you're looking for.

Attributes

Inherited from:
Unsafe
def unwatch: F[Unit]

Attributes

Inherited from:
Watcher
def watch(keys: K*): F[Unit]

Attributes

Inherited from:
Watcher
def zAdd(key: K, args: Option[ZAddArgs], values: ScoreWithValue[V]*): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zAddIncr(key: K, args: Option[ZAddArgs], value: ScoreWithValue[V]): F[Double]

Attributes

Inherited from:
SortedSetSetter
def zCard(key: K): F[Option[Long]]

Attributes

Inherited from:
SortedSetGetter
def zCount[T : Numeric](key: K, range: ZRange[T]): F[Option[Long]]

Attributes

Inherited from:
SortedSetGetter
def zDiff(keys: K*): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zDiffWithScores(keys: K*): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zIncrBy(key: K, member: V, amount: Double): F[Double]

Attributes

Inherited from:
SortedSetSetter
def zInter(args: Option[ZAggregateArgs], keys: K*): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zInterStore(destination: K, args: Option[ZStoreArgs], keys: K*): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zInterWithScores(args: Option[ZAggregateArgs], keys: K*): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zLexCount(key: K, range: ZRange[V]): F[Option[Long]]

Attributes

Inherited from:
SortedSetGetter
def zPopMax(key: K, count: Long): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zPopMin(key: K, count: Long): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zRange(key: K, start: Long, stop: Long): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRangeByLex(key: K, range: ZRange[V], limit: Option[RangeLimit]): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRangeByScore[T : Numeric](key: K, range: ZRange[T], limit: Option[RangeLimit]): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRangeByScoreWithScores[T : Numeric](key: K, range: ZRange[T], limit: Option[RangeLimit]): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zRangeWithScores(key: K, start: Long, stop: Long): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zRank(key: K, value: V): F[Option[Long]]

Attributes

Inherited from:
SortedSetGetter
def zRem(key: K, values: V*): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zRemRangeByLex(key: K, range: ZRange[V]): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zRemRangeByRank(key: K, start: Long, stop: Long): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zRemRangeByScore[T : Numeric](key: K, range: ZRange[T]): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zRevRange(key: K, start: Long, stop: Long): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRevRangeByLex(key: K, range: ZRange[V], limit: Option[RangeLimit]): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRevRangeByScore[T : Numeric](key: K, range: ZRange[T], limit: Option[RangeLimit]): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zRevRangeByScoreWithScores[T : Numeric](key: K, range: ZRange[T], limit: Option[RangeLimit]): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zRevRangeWithScores(key: K, start: Long, stop: Long): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter
def zRevRank(key: K, value: V): F[Option[Long]]

Attributes

Inherited from:
SortedSetGetter
def zScore(key: K, value: V): F[Option[Double]]

Attributes

Inherited from:
SortedSetGetter
def zUnion(args: Option[ZAggregateArgs], keys: K*): F[List[V]]

Attributes

Inherited from:
SortedSetGetter
def zUnionStore(destination: K, args: Option[ZStoreArgs], keys: K*): F[Long]

Attributes

Inherited from:
SortedSetSetter
def zUnionWithScores(args: Option[ZAggregateArgs], keys: K*): F[List[ScoreWithValue[V]]]

Attributes

Inherited from:
SortedSetGetter

Deprecated and Inherited methods

def hmSet(key: K, fieldValues: Map[K, V]): F[Unit]

Attributes

Deprecated
[Since version 1.0.1]
Inherited from:
HashSetter
def scan(cursor: Long, scanArgs: ScanArgs): F[KeyScanCursor[K]]

Attributes

Deprecated
[Since version 0.10.4]
Inherited from:
KeyCommands
def scan(cursor: Long): F[KeyScanCursor[K]]

Attributes

Deprecated
[Since version 0.10.4]
Inherited from:
KeyCommands

Concrete fields

val cmd: RedisCommands[F, K, V]
Implicitly added by LiftKOps
Generated with