HashApi

Abstract Value Members

abstract def hdel(key: Any, field: Any, fields: Any*)(implicit format: Format): Option[Long]
abstract def hexists(key: Any, field: Any)(implicit format: Format): Boolean
abstract def hget[A](key: Any, field: Any)(implicit format: Format, parse: Parse[A]): Option[A]
abstract def hgetall1[K, V](key: Any)(implicit format: Format, parseK: Parse[K], parseV: Parse[V]): Option[Map[K, V]]
abstract def hincrby(key: Any, field: Any, value: Long)(implicit format: Format): Option[Long]
abstract def hincrbyfloat(key: Any, field: Any, value: Float)(implicit format: Format): Option[Float]
abstract def hkeys[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]
abstract def hlen(key: Any)(implicit format: Format): Option[Long]
abstract def hmget[K, V](key: Any, fields: K*)(implicit format: Format, parseV: Parse[V]): Option[Map[K, V]]
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
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.8)
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
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
abstract def hvals[A](key: Any)(implicit format: Format, parse: Parse[A]): Option[List[A]]
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
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package api

trait HashApi extends AnyRef

Abstract Value Members

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

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

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

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

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

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

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

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

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

abstract def hmset(key: Any, map: Iterable[Product2[Any, Any]])(implicit format: Format): Boolean

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

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

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

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

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

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped