GeoApi

Abstract Value Members

abstract def geoadd(key: Any, members: Iterable[Product3[Any, Any, Any]]): Option[Int]

Add the given members in the key geo sorted set
Add the given members in the key geo sorted set
key
The geo sorted set
members
The members to be added. Format is (longitude, latitude, member)
returns
The number of elements added to the index. Repeated elements are not added.
abstract def geodist(key: Any, m1: Any, m2: Any, unit: Option[Any]): Option[String]
abstract def geohash[A](key: Any, members: Iterable[Any])(implicit format: Format, parse: Parse[A]): Option[List[Option[A]]]

Get the geohash for each member in the key geo index.
Get the geohash for each member in the key geo index.
A
key
members
format
parse
returns
The geohash of each queried member.
abstract def geopos[A](key: Any, members: Iterable[Any])(implicit format: Format, parse: Parse[A]): Option[List[Option[List[Option[A]]]]]

Retrieve the position of the members in the key geo sorted set.
Retrieve the position of the members in the key geo sorted set. Note that if a member is not part of the set, None will be returned for this element.
A
key
members
format
parse
returns
the coordinates of the input members in the same order.
abstract def georadius(key: Any, longitude: Any, latitude: Any, radius: Any, unit: Any, withCoord: Boolean, withDist: Boolean, withHash: Boolean, count: Option[Int], sort: Option[Any], store: Option[Any], storeDist: Option[Any]): Option[List[Option[GeoRadiusMember]]]

Search for members around an origin point in the key geo sorted set
Search for members around an origin point in the key geo sorted set
key
The geo index we are searching in
longitude
The base longitude for distance computation
latitude
The base latitude for distance computation
radius
The radius of the circle we want to search in
unit
The unit of the radius. Can be m (meters), km (kilometers), mi (miles), ft (feet)
withCoord
If true, the coordinate of the found members will be returned in the result
withDist
If true, the distance between the origin and the found members will be returned in the result
withHash
If true, the hash of the found members will be returned in the result
count
Max number of expected results
sort
The sorting strategy. If empty, order is not guaranteed. Can be ASC (ascending) or DESC (descending)
store
The Redis store we want to write the result in
storeDist
The redis storedist we want to write the result in
returns
The found members as GeoRadiusMember instances
abstract def georadiusbymember[A](key: Any, member: Any, radius: Any, unit: Any, withCoord: Boolean, withDist: Boolean, withHash: Boolean, count: Option[Int], sort: Option[Any], store: Option[Any], storeDist: Option[Any])(implicit format: Format, parse: Parse[A]): Option[List[Option[GeoRadiusMember]]]

Search for members around a specific memberin the key geo sorted set
Search for members around a specific memberin the key geo sorted set
key
The geo index we are searching in
member
The member we are searching around
radius
The radius of the circle we want to search in
unit
The unit of the radius. Can be m (meters), km (kilometers), mi (miles), ft (feet)
withCoord
If true, the coordinate of the found members will be returned in the result
withDist
If true, the distance between the origin and the found members will be returned in the result
withHash
If true, the hash of the found members will be returned in the result
count
Max number of expected results
sort
The sorting strategy. If empty, order is not guaranteed. Can be ASC (ascending) or DESC (descending)
store
The Redis store we want to write the result in
storeDist
The redis storedist we want to write the result in
returns
The found members as GeoRadiusMember instances

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@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
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@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( ... )
final def wait(arg0: Long): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

trait GeoApi extends AnyRef

Abstract Value Members

abstract def geoadd(key: Any, members: Iterable[Product3[Any, Any, Any]]): Option[Int]

abstract def geodist(key: Any, m1: Any, m2: Any, unit: Option[Any]): Option[String]

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

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

abstract def georadius(key: Any, longitude: Any, latitude: Any, radius: Any, unit: Any, withCoord: Boolean, withDist: Boolean, withHash: Boolean, count: Option[Int], sort: Option[Any], store: Option[Any], storeDist: Option[Any]): Option[List[Option[GeoRadiusMember]]]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped