Package io.quarkus.redis.datasource.geo

Class GeoRadiusStoreArgs<K>

java.lang.Object
io.quarkus.redis.datasource.geo.GeoRadiusStoreArgs<K>
All Implemented Interfaces:
RedisCommandExtraArguments
public class GeoRadiusStoreArgs<K> extends Object implements RedisCommandExtraArguments

  • Constructor Details

    • GeoRadiusStoreArgs

      public GeoRadiusStoreArgs()

  • Method Details

    • ascending

      public GeoRadiusStoreArgs<K> ascending()
      Use ASC order (from small to large).
      Returns:
      the current GeoRadiusStoreArgs

    • descending

      public GeoRadiusStoreArgs<K> descending()
      Use DESC order (from large to small).
      Returns:
      the current GeoRadiusStoreArgs

    • withDistance

      public GeoRadiusStoreArgs<K> withDistance()
      Also return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.
      Returns:
      the current GeoRadiusStoreArgs

    • withCoordinates

      public GeoRadiusStoreArgs<K> withCoordinates()
      Also return the longitude,latitude coordinates of the matching items.
      Returns:
      the current GeoRadiusStoreArgs

    • withHash

      public GeoRadiusStoreArgs<K> withHash()
      Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.
      Returns:
      the current GeoRadiusStoreArgs

    • count

      public GeoRadiusStoreArgs<K> count(long count)
      By default, all the matching items are returned. It is possible to limit the results to the first N matching items by using the COUNT &lt;count&gt; option.
      Parameters:
      count - the count value
      Returns:
      the current GeoRadiusStoreArgs

    • any

      public GeoRadiusStoreArgs<K> any()
      When ANY is provided the command will return as soon as enough matches are found, so the results may not be the ones closest to the specified point, but on the other hand, the effort invested by the server is significantly lower. Using ANY requires count to be set.
      Returns:
      the current GeoRadiusStoreArgs

    • storeKey

      public GeoRadiusStoreArgs<K> storeKey(K storeKey)
      Store the items in a sorted set populated with their geospatial information.
      Parameters:
      storeKey - the storeKey value
      Returns:
      the current GeoRadiusStoreArgs

    • storeDistKey

      public GeoRadiusStoreArgs<K> storeDistKey(K storeDistKey)
      Store the items in a sorted set populated with their distance from the center as a floating point number, in the same unit specified in the radius.
      Parameters:
      storeDistKey - the storeDistKey value
      Returns:
      the current GeoRadiusStoreArgs

    • toArgs

      public List<Object> toArgs(Codec codec)
      Specified by:
      toArgs in interface RedisCommandExtraArguments
      Parameters:
      codec - an optional encoder to encode some of the values
      Returns:
      the list of arguments.

    • hasDistance

      public boolean hasDistance()

    • hasHash

      public boolean hasHash()

    • hasCoordinates

      public boolean hasCoordinates()