GeoApi

Type Members

abstract type HashKey

The type of Redis hash keys or hash key patterns used in methods representing Redis commands that work on hashes (HashesApi).
The type of Redis hash keys or hash key patterns used in methods representing Redis commands that work on hashes (HashesApi).

Definition Classes
ApiSubset
abstract type Key

The type of Redis keys or key patterns used in methods representing Redis commands.
The type of Redis keys or key patterns used in methods representing Redis commands. For example, if Key = String then get returns Result[Opt[String]]. This type is used only for toplevel Redis keys, hash keys have their own type, HashKey.

Definition Classes
ApiSubset
abstract type Result[A]

The type constructor into which a result of each command is wrapped.
The type constructor into which a result of each command is wrapped. For example if Result is Future, then incr returns Future[Long].

Definition Classes
ApiSubset
abstract type Value

The type of Redis values used in methods representing Redis commands.
The type of Redis values used in methods representing Redis commands. "Value" is the data that might be stored directly under a Redis key (e.g. using set) but also a value of hash field, list element, set member, sorted set member, geo set member or element inserted into hyper-log-log structure. There are no separate types specified for every of those use cases because only one of them can be used in a single command (for example, there is no Redis command that works on both list elements and set members at the same time).

Definition Classes
ApiSubset

Abstract Value Members

abstract def execute[A](command: RedisCommand[A]): Result[A]

Definition Classes
ApiSubset
implicit abstract def hashKeyCodec: RedisDataCodec[HashKey]

Attributes
protected
Definition Classes
ApiSubset
implicit abstract def keyCodec: RedisDataCodec[Key]

Attributes
protected
Definition Classes
ApiSubset
implicit abstract def valueCodec: RedisDataCodec[Value]

Attributes
protected
Definition Classes
ApiSubset

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] )
def geoadd(key: Key, items: Iterable[(Value, GeoPoint)]): Result[Int]

Executes GEOADD or simply returns 0 when items is empty, without sending the command Redis
def geoadd(key: Key, item: (Value, GeoPoint), items: (Value, GeoPoint)*): Result[Int]

Executes GEOADD
def geoadd(key: Key, member: Value, point: GeoPoint): Result[Boolean]

Executes GEOADD
def geodist(key: Key, member1: Value, member2: Value, unit: GeoUnit = GeoUnit.M): Result[commons.Opt[Double]]

Executes GEODIST
def geohash(key: Key, members: Iterable[Value]): Result[Seq[commons.Opt[GeoHash]]]

Executes GEOHASH NOTE: members CAN be empty (Redis accepts it)
def geohash(key: Key, members: Value*): Result[Seq[commons.Opt[GeoHash]]]

Executes GEOHASH
def geopos(key: Key, members: Iterable[Value]): Result[Seq[commons.Opt[GeoPoint]]]

Executes GEOPOS NOTE: members CAN be empty (Redis accepts it)
def geopos(key: Key, members: Value*): Result[Seq[commons.Opt[GeoPoint]]]

Executes GEOPOS
def georadius[A <: GeoradiusAttrs](key: Key, point: GeoPoint, radius: Double, unit: GeoUnit, attributes: A = GeoradiusAttrs.None, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[Seq[georadius.A.Attributed[Value]]]

Executes GEORADIUS
def georadiusStore(key: Key, point: GeoPoint, radius: Double, unit: GeoUnit, storeKey: Key, storeDist: Boolean = false, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[commons.Opt[Long]]

Executes GEORADIUS
def georadiusbymember[A <: GeoradiusAttrs](key: Key, member: Value, radius: Double, unit: GeoUnit, attributes: A = GeoradiusAttrs.None, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[Seq[georadiusbymember.A.Attributed[Value]]]

Executes GEORADIUSBYMEMBER
def georadiusbymemberStore(key: Key, member: Value, radius: Double, unit: GeoUnit, storeKey: Key, storeDist: Boolean = false, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[commons.Opt[Long]]

Executes GEORADIUSBYMEMBER
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit def headOps[T](head: T): HeadOps[T]

Attributes
protected
Definition Classes
ApiSubset
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def iterableTailOps[T](tail: Iterable[T]): IterableTailOps[T]

Attributes
protected
Definition Classes
ApiSubset
implicit def iteratorTailOps[T](tail: Iterator[T]): IteratorTailOps[T]

Attributes
protected
Definition Classes
ApiSubset
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 commands

trait GeoApi extends ApiSubset

Type Members

abstract type HashKey

abstract type Key

abstract type Result[A]

abstract type Value

Abstract Value Members

abstract def execute[A](command: RedisCommand[A]): Result[A]

implicit abstract def hashKeyCodec: RedisDataCodec[HashKey]

implicit abstract def keyCodec: RedisDataCodec[Key]

implicit abstract def valueCodec: RedisDataCodec[Value]

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

def geoadd(key: Key, items: Iterable[(Value, GeoPoint)]): Result[Int]

def geoadd(key: Key, item: (Value, GeoPoint), items: (Value, GeoPoint)*): Result[Int]

def geoadd(key: Key, member: Value, point: GeoPoint): Result[Boolean]

def geodist(key: Key, member1: Value, member2: Value, unit: GeoUnit = GeoUnit.M): Result[commons.Opt[Double]]

def geohash(key: Key, members: Iterable[Value]): Result[Seq[commons.Opt[GeoHash]]]

def geohash(key: Key, members: Value*): Result[Seq[commons.Opt[GeoHash]]]

def geopos(key: Key, members: Iterable[Value]): Result[Seq[commons.Opt[GeoPoint]]]

def geopos(key: Key, members: Value*): Result[Seq[commons.Opt[GeoPoint]]]

def georadius[A <: GeoradiusAttrs](key: Key, point: GeoPoint, radius: Double, unit: GeoUnit, attributes: A = GeoradiusAttrs.None, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[Seq[georadius.A.Attributed[Value]]]

def georadiusStore(key: Key, point: GeoPoint, radius: Double, unit: GeoUnit, storeKey: Key, storeDist: Boolean = false, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[commons.Opt[Long]]

def georadiusbymember[A <: GeoradiusAttrs](key: Key, member: Value, radius: Double, unit: GeoUnit, attributes: A = GeoradiusAttrs.None, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[Seq[georadiusbymember.A.Attributed[Value]]]

def georadiusbymemberStore(key: Key, member: Value, radius: Double, unit: GeoUnit, storeKey: Key, storeDist: Boolean = false, count: commons.OptArg[Long] = OptArg.Empty, sortOrder: commons.OptArg[SortOrder] = OptArg.Empty): Result[commons.Opt[Long]]

final def getClass(): Class[_]

def hashCode(): Int

implicit def headOps[T](head: T): HeadOps[T]

final def isInstanceOf[T0]: Boolean

implicit def iterableTailOps[T](tail: Iterable[T]): IterableTailOps[T]

implicit def iteratorTailOps[T](tail: Iterator[T]): IteratorTailOps[T]

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 ApiSubset

Inherited from AnyRef

Inherited from Any

Ungrouped