You can use geo-distance query to specify a circular geographical area that is defined by a central point and radius as a query condition. Tablestore returns the rows where the value of a field falls within the circular geographical area.
Parameters
Parameter | Description |
---|---|
fieldName | The name of the column. Set the query type to Geopoint. |
centerPoint | The coordinate pair of the central point. The coordinate pair consists of latitude
and longitude values.
This parameter value must be in the format of |
distanceInMeter | The radius of the circle centered on the specified location. Type: DOUBLE. Unit: meter. |
getTotalCount | Specifies whether to return the total number of rows that match the query conditions.
By default, this parameter is set to false, which indicates that the total number
of rows that match the query conditions is not returned.
Query performance is affected when this parameter is set to true. |
query | The query statement for the search index. Set the query type to GeoDistanceQuery. |
tableName | The name of the table. |
indexName | The name of the search index. |
columnsToGet | Specifies whether to return all columns of each matched row. You can configure returnAll
and columns for this parameter.
By default, returnAll is set to false, which indicates that not all columns are returned. If returnAll is set to false, you can use columns to specify the columns to return. If you do not specify the columns to return, only the primary key columns are returned. If returnAll is set to true, all columns are returned. |
Examples
Search the table for rows where the value of Col_GeoPoint falls within a specified distance from a specified central point.
public static void geoDistanceQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
GeoDistanceQuery geoDistanceQuery = new GeoDistanceQuery(); // Set the query type to GeoDistanceQuery.
geoDistanceQuery.setFieldName("Col_GeoPoint");
geoDistanceQuery.setCenterPoint("5,5"); // Specify the coordinate pair for a central point.
geoDistanceQuery.setDistanceInMeter(10000); // You can set the distance from the central point to a value greater than or equal to 10,000. Unit: meter.
searchQuery.setQuery(geoDistanceQuery);
//searchQuery.setGetTotalCount(true); // Specify that the total number of matched rows is returned.
SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
// You can set the columnsToGet parameter to specify the columns to return or specify that all columns are returned. If you do not set this parameter, only the primary key columns are returned.
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); // Set ReturnAll to true to return all columns.
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); // Set Columns to return specified columns.
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); // Display the total number of matched rows instead of the number of returned rows.
System.out.println("Row: " + resp.getRows());
}