Run a Geospatial Search Query with the REST API and curl/HTTP

how-to

Search for geospatial data in your Couchbase Server database with a compatible Search index, the REST API and curl/HTTP.

For more information about how the Search Service scores documents in search results, see Scoring for Search Queries.

Prerequisites

You have the Search Service enabled on a node in your database. For more information about how to deploy a new node and Services on your database, see Manage Nodes and Clusters.
You have a bucket with scopes and collections in your database. For more information about how to create a bucket, see Create a Bucket.
You have documents in your database that contain geospatial data.

For more information about the supported data types, see geopoint or geoshape.
Your user account has the Search Admin role for the bucket where you want to create the Search index.

If you only want to run a search, you only need the Search Reader role.
You installed the Couchbase command-line tool (CLI).
You have the hostname or IP address for the node in your database where you’re running the Search Service. For more information about where to find the IP address for your node, see List Cluster Nodes.

Procedure

To run a geospatial Search query, create a Search index with a geospatial type mapping.

Then, run a Search query from the Couchbase Server Web Console.

Create a Search Index with a Geospatial Type Mapping

To create the Search index with a geospatial type mapping:

Create a Search Index with the REST API and curl/HTTP with the following JSON payload, replacing all placeholder values that start with a $:

{
    "type": "fulltext-index",
    "name": "$INDEX_NAME",
    "sourceType": "gocbcore",
    "sourceName": "$BUCKET_NAME",
    "planParams": {
      "maxPartitionsPerPIndex": 1024,
      "indexPartitions": 1
    },
    "params": {
      "doc_config": {
        "docid_prefix_delim": "",
        "docid_regexp": "",
        "mode": "scope.collection.type_field",
        "type_field": "type"
      },
      "mapping": {
        "analysis": {},
        "default_analyzer": "standard",
        "default_datetime_parser": "dateTimeOptional",
        "default_field": "_all",
        "default_mapping": {
          "dynamic": true,
          "enabled": false
        },
        "default_type": "_default",
        "docvalues_dynamic": false,
        "index_dynamic": true,
        "store_dynamic": false,
        "type_field": "_type",
        "types": {
          "$SCOPE_NAME.$COLLECTION_NAME": {
            "dynamic": true,
            "enabled": true,
            "properties": {
              "$FIELD_NAME": {
                "dynamic": false,
                "enabled": true,
                "fields": [
                  {
                    "include_in_all": true,
                    "index": true,
                    "name": "$FIELD_NAME",
                    //Replace with "geoshape" if your field contains GeoJSON data, instead.
                    "type": "geopoint" 
                  }
                ]
              }
            }
          }
        }
      },
      "store": {
        "indexType": "scorch",
        "segmentVersion": 15,
        "spatialPlugin": "s2"
      }
    },
    "sourceParams": {}
  }

Run a Geospatial Search Query

To run a Search query against the Search index:

In your command-line tool, enter a curl command with the XPOST verb.
Set your header content to include "Content-Type: application/json".
Enter your username, password, and the Search Service endpoint on port 8094 with the name of the index you want to query:
```
curl -s -XPUT -H "Content-Type: application/json" \
    -u ${CB_USERNAME}:${CB_PASSWORD} http://${CB_HOSTNAME}:8094/api/bucket/${BUCKET-NAME}/scope/${SCOPE-NAME}/index/${INDEX-NAME}/query -d \
```
To use SSL, use the https protocol in the Search Service endpoint URL and port 18094.
Enter the JSON payload for your query.

Example: Geopoint Query

For example, the following query searches a geospatial field, geo, for any locations within a 100 mile radius of the coordinates -2.235143, 53.482358 with a Distance/Radius-Based Geopoint Query:

curl -s -XPUT -H "Content-Type: application/json" \
    -u ${CB_USERNAME}:${CB_PASSWORD} http://${CB_HOSTNAME}:8094/api/bucket/${BUCKET-NAME}/scope/${SCOPE-NAME}/index/${INDEX-NAME}/query 
    -d '{
      "from": 0,
      "size": 10,
      "query": {
        "location": {
          "lon": -2.235143,
          "lat": 53.482358
        },
          "distance": "100mi",
          "field": "geo"
        },
      "sort": [
        {
          "by": "geo_distance",
          "field": "geo",
          "unit": "mi",
          "location": {
          "lon": -2.235143,
          "lat": 53.482358
          }
        }
      ]
    }'

Example: GeoJSON Query

For example, the following query searches a geospatial field, geojson, for any locations within a defined shape with a Polygon GeoJSON Query:

curl -s -XPUT -H "Content-Type: application/json" \
    -u ${CB_USERNAME}:${CB_PASSWORD} http://${CB_HOSTNAME}:8094/api/bucket/${BUCKET-NAME}/scope/${SCOPE-NAME}/index/${INDEX-NAME}/query 
    -d '{
        "query": {
            "field": "geojson",
            "geometry": {
                "shape": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                        [
                            0.47482593026924746,
                            51.31232878073189
                        ],
                        [
                            0.6143265647863245,
                            51.31232878073189
                        ],
                        [
                            0.6143265647863245,
                            51.384000374770466
                        ],
                        [
                            0.47482593026924746,
                            51.384000374770466
                        ],
                        [
                            0.47482593026924746,
                            51.31232878073189
                        ]
                        ]
                    ]
                },
                "relation": "within"
            }
        }
    }

Next Steps

You can customize your Search index to improve search results and performance.

You can also:

Change the JSON payload for your Search index.
Change the JSON payload for your Search query.

If you want to add autocomplete to your database’s search, see Use Autocomplete with the Search Service.