Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Geospatial Queries

      +
      Geospatial queries return documents that contain location in either legacy Geopoint format or standard GeoJSON structures.

      Geopoint (type geopoint)

      Legacy or Geopoint documents which specify a geographical location.

      For these queries the Search service lets users index the single dimensional geopoint/location fields and perform various bounding queries like point-distance, bounded-rectangle and bounded-polygon against the indexed geopoint field.

      For higher level shapes and structures refer to GeoJSON below.

      GeoJSON (type geojson)

      Couchbase Server 7.1.2

      For these queries the Search service supports higher dimensional spatial structures that enable the users to approximate a large variety of real life shapes like a postal or jurisdictional region boundaries, a route for a delivery vehicle or an airline career or the boundaries of various water bodies like a river, lake, stream etc..

      GeoJSON is a geospatial data interchange format based on JavaScript Object Notation (JSON). It defines several types of JSON objects and the manner in which they are combined to represent data about geographic features, their properties, and their spatial extents. GeoJSON uses a geographic coordinate reference system, World Geodetic System 1984, and units of decimal degrees.

      Internally the Search service supports the GeoJSON spatial data formats on spherical geodesics via S2 cells. Furthermore the Search service adheres to the GeoJSON standard RFC 7946 allows users to address query use cases like:

      • Finding all the documents with any GeoJSON shapes that contains the spatial field of the query shape.

      • Finding all the documents with any GeoJSON shapes that are within the spatial field of the query shape.

      • Finding all the documents with any GeoJSON shapes that intersects the spatial field of the query shape.

      The supported GeoJSON shapes in the Search service are:

      • Point (equivalent to a legacy Geopoint)

      • LineString

      • Polygon (equivalent to a legacy Polygon)

      • MultiPoint

      • MultiLineString

      • MultiPolygon

      • GeometryCollection

      In addition to the above shapes, Search also supports a couple of additional custom shapes to make the spatial approximations easier for users to utilize. The two extra shapes supported are:

      • Circle (equivalent to a legacy Radius)

      • Envelope (equivalent to a legacy Rectangle)