com.redis.api

HashApi

trait HashApi extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
HashOperations, HashOps, PipelineClient, RedisClient, RedisCluster, RedisCommand
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HashApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def hdel(key: Any, field: Any, fields: Any*)(implicit format: Format): Option[Long]

  2. abstract def hexists(key: Any, field: Any)(implicit format: Format): Boolean

  3. abstract def hget[A](key: Any, field: Any)(implicit format: Format, parse: Parse[A]): Option[A]

  4. abstract def hgetall1[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[Map[K, V]]

  5. abstract def hincrby(key: Any, field: Any, value: Long)(implicit format: Format): Option[Long]

  6. abstract def hincrbyfloat(key: Any, field: Any, value: Float)(implicit format: Format): Option[Float]

  7. abstract def hkeys[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]

  8. abstract def hlen(key: Any)(implicit format: Format): Option[Long]

  9. abstract def hmget[K, V](key: Any, fields: K*)(implicit format: Format, parseV: Parse[V]): Option[Map[K, V]]

  10. abstract def hmset(key: Any, map: Iterable[Product2[Any, Any]])(implicit format: Format): 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

    HMSET documentation

  11. abstract def hscan[A](key: Any, cursor: Int, pattern: Any = "*", count: Int = 10)(implicit format: Format, parse: Parse[A]): Option[(Option[Int], Option[List[Option[A]]])]

    Incrementally iterate hash fields and associated values (since 2.

    Incrementally iterate hash fields and associated values (since 2.8)

  12. abstract def hset1(key: Any, field: Any, value: Any)(implicit format: Format): Option[Long]

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    returns

    Some(0) if field is a new field in the hash and value was set, Some(1) if field already exists in the hash and the value was updated.

    See also

    HSET documentation

  13. abstract def hsetnx(key: Any, field: Any, value: Any)(implicit format: Format): Boolean

    Sets field in the hash stored at key to value, only if field does not yet exist.

    Sets field in the hash stored at key to value, 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 if field is a new field in the hash and value was set. False if field exists in the hash and no operation was performed.

    See also

    HSETNX documentation

  14. abstract def hvals[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]

  15. abstract def hgetall[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): 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

  16. abstract def hset(key: Any, field: Any, value: Any)(implicit format: Format): Boolean

    Sets field in the hash stored at key to value.

    Sets field in the hash stored at key to value. If key does not exist, a new key holding a hash is created. If field already exists in the hash, it is overwritten.

    returns

    True if field is a new field in the hash and value was set, False if field already exists in the hash and the value was updated.

    Deprecated

    return value semantics is inconsistent with com.redis.HashOperations#hsetnx and com.redis.HashOperations#hmset. Use com.redis.HashOperations#hset1 instead

    See also

    HSET documentation

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped