Packages

trait BaseApi[F[+_]] extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
BaseOperations, RedisClient, RedisCommand
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseApi
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def auth(secret: Any)(implicit format: Format): F[Resp[Boolean]]

    auths with the server.

  2. abstract def dbsize: F[Resp[Option[Long]]]

    returns the size of the db.

  3. abstract def del(key: Any, keys: Any*)(implicit format: Format): F[Resp[Option[Long]]]

    deletes the specified keys.

  4. abstract def echo(message: Any)(implicit format: Format): F[Resp[Option[String]]]
  5. abstract def exists(key: Any)(implicit format: Format): F[Resp[Boolean]]

    test if the specified key exists.

  6. abstract def expire(key: Any, ttl: Int)(implicit format: Format): F[Resp[Boolean]]

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

  7. abstract def expireat(key: Any, timestamp: Long)(implicit format: Format): F[Resp[Boolean]]

    sets the expire time for the specified key.

  8. abstract def flushall: F[Resp[Boolean]]

    removes data from all the DB's.

  9. abstract def flushdb: F[Resp[Boolean]]

    removes all the DB data.

  10. abstract def getConfig(key: Any = "*")(implicit format: Format): F[Resp[Option[Map[String, Option[String]]]]]

    CONFIG GET

  11. abstract def getType(key: Any)(implicit format: Format): F[Resp[Option[String]]]

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

  12. abstract def keys[A](pattern: Any = "*")(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[A]]]]]

    returns all the keys matching the glob-style pattern.

  13. abstract def move(key: Any, db: Int)(implicit format: Format): F[Resp[Boolean]]

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

  14. abstract def persist(key: Any)(implicit format: Format): F[Resp[Boolean]]

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

  15. abstract def pexpire(key: Any, ttlInMillis: Int)(implicit format: Format): F[Resp[Boolean]]

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

  16. abstract def pexpireat(key: Any, timestampInMillis: Long)(implicit format: Format): F[Resp[Boolean]]

    sets the expire timestamp in millis for the specified key.

  17. abstract def ping: F[Resp[Option[String]]]

    ping

  18. abstract def pttl(key: Any)(implicit format: Format): F[Resp[Option[Long]]]

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

  19. abstract def quit: F[Resp[Boolean]]

    exits the server.

  20. abstract def randomkey[A](implicit parse: Parse[A]): F[Resp[Option[A]]]

    returns a randomly selected key from the currently selected DB.

  21. abstract def rename(oldkey: Any, newkey: Any)(implicit format: Format): F[Resp[Boolean]]

    atomically renames the key oldkey to newkey.

  22. abstract def renamenx(oldkey: Any, newkey: Any)(implicit format: Format): F[Resp[Boolean]]

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

  23. abstract def scan[A](cursor: Int, pattern: Any = "*", count: Int = 10)(implicit format: Format, parse: Parse[A]): F[Resp[Option[(Option[Int], Option[List[Option[A]]])]]]

    Incrementally iterate the keys space (since 2.8)

  24. abstract def select(index: Int): F[Resp[Boolean]]

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

  25. abstract def setConfig(key: Any, value: Any)(implicit format: Format): F[Resp[Option[String]]]

    CONFIG SET

  26. abstract def sort[A](key: String, limit: Option[(Int, Int)] = None, desc: Boolean = false, alpha: Boolean = false, by: Option[String] = None, get: List[String] = Nil)(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[A]]]]]

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

  27. abstract def sortNStore[A](key: String, limit: Option[(Int, Int)] = None, desc: Boolean = false, alpha: Boolean = false, by: Option[String] = None, get: List[String] = Nil, storeAt: String)(implicit format: Format, parse: Parse[A]): F[Resp[Option[Long]]]

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

  28. abstract def time[A](implicit format: Format, parse: Parse[A]): F[Resp[Option[List[Option[A]]]]]

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

  29. abstract def ttl(key: Any)(implicit format: Format): F[Resp[Option[Long]]]

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

  30. abstract def unwatch(): F[Resp[Boolean]]

    Flushes all the previously watched keys for a transaction

  31. abstract def watch(key: Any, keys: Any*)(implicit format: Format): F[Resp[Boolean]]

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toany2stringadd[BaseApi[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BaseApi[F], B)
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toArrowAssoc[BaseApi[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (BaseApi[F]) => Boolean, msg: => Any): BaseApi[F]
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toEnsuring[BaseApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (BaseApi[F]) => Boolean): BaseApi[F]
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toEnsuring[BaseApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): BaseApi[F]
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toEnsuring[BaseApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): BaseApi[F]
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toEnsuring[BaseApi[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toStringFormat[BaseApi[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val pong: Option[String]
    Attributes
    protected
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def →[B](y: B): (BaseApi[F], B)
    Implicit
    This member is added by an implicit conversion from BaseApi[F] toArrowAssoc[BaseApi[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBaseApi[F] to any2stringadd[BaseApi[F]]

Inherited by implicit conversion StringFormat fromBaseApi[F] to StringFormat[BaseApi[F]]

Inherited by implicit conversion Ensuring fromBaseApi[F] to Ensuring[BaseApi[F]]

Inherited by implicit conversion ArrowAssoc fromBaseApi[F] to ArrowAssoc[BaseApi[F]]

Ungrouped