trait HashApi[F[+_]] extends AnyRef
- Alphabetic
- By Inheritance
- HashApi
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def hdel(key: Any, field: Any, fields: Any*)(implicit format: Format): F[Resp[Option[Long]]]
- abstract def hexists(key: Any, field: Any)(implicit format: Format): F[Resp[Boolean]]
- abstract def hget[A](key: Any, field: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[A]]]
- abstract def hgetall1[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
- abstract def hincrby(key: Any, field: Any, value: Long)(implicit format: Format): F[Resp[Option[Long]]]
- abstract def hincrbyfloat(key: Any, field: Any, value: Float)(implicit format: Format): F[Resp[Option[Float]]]
- abstract def hkeys[A](key: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[A]]]]
- abstract def hlen(key: Any)(implicit format: Format): F[Resp[Option[Long]]]
- abstract def hmget[K, V](key: Any, fields: K*)(implicit format: Format, parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
- abstract def hmset(key: Any, map: Iterable[Product2[Any, Any]])(implicit format: Format): F[Resp[Boolean]]
Sets the specified fields to their respective values in the hash stored at key.
Sets the specified fields to their respective values in the hash stored at key. This command overwrites any existing fields in the hash. If key does not exist, a new key holding a hash is created.
- map
from fields to values
- returns
True
if operation completed successfully,False
otherwise.
- See also
- abstract def hscan[A](key: Any, cursor: Int, pattern: Any = "*", count: Int = 10)(implicit format: Format, parse: Parse[A]): F[Resp[Option[(Option[Int], Option[List[Option[A]]])]]]
Incrementally iterate hash fields and associated values (since 2.8)
- abstract def hset1(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Option[Long]]]
Sets
field
in the hash stored atkey
tovalue
.Sets
field
in the hash stored atkey
tovalue
. Ifkey
does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.- returns
Some(0)
iffield
is a new field in the hash and value was set,Some(1)
iffield
already exists in the hash and the value was updated.
- See also
- abstract def hsetnx(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Boolean]]
Sets
field
in the hash stored atkey
tovalue
, only if field does not yet exist.Sets
field
in the hash stored atkey
tovalue
, only if field does not yet exist. If key does not exist, a new key holding a hash is created. If field already exists, this operation has no effect.- returns
True
iffield
is a new field in the hash and value was set. False iffield
exists in the hash and no operation was performed.
- See also
- abstract def hvals[A](key: Any)(implicit format: Format, parse: Parse[A]): F[Resp[Option[List[A]]]]
- abstract def hgetall[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): F[Resp[Option[Map[K, V]]]]
- Annotations
- @deprecated
- Deprecated
(Since version 3.2) Use the more idiomatic variant hgetall1, which has the returned Map behavior more consistent. See issue https://github.com/debasishg/scala-redis/issues/122
- abstract def hset(key: Any, field: Any, value: Any)(implicit format: Format): F[Resp[Boolean]]
Sets
field
in the hash stored atkey
tovalue
.Sets
field
in the hash stored atkey
tovalue
. Ifkey
does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.- returns
True
iffield
is a new field in the hash and value was set,False
iffield
already exists in the hash and the value was updated.
- Deprecated
return value semantics is inconsistent with effredis.HashOperations#hsetnx and effredis.HashOperations#hmset. Use effredis.HashOperations#hset1 instead
- See also
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (HashApi[F], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (HashApi[F]) => Boolean, msg: => Any): HashApi[F]
- def ensuring(cond: (HashApi[F]) => Boolean): HashApi[F]
- def ensuring(cond: Boolean, msg: => Any): HashApi[F]
- def ensuring(cond: Boolean): HashApi[F]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def →[B](y: B): (HashApi[F], B)
- Implicit
- This member is added by an implicit conversion from HashApi[F] toArrowAssoc[HashApi[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.