Geo-bounding box query

更新时间:
复制 MD 格式

A geo-bounding box query allows you to specify a rectangular geographical area as a query condition. Tablestore returns the rows in which the value of the specified field falls within the rectangular geographical area.

API operations

You can set the query type to GeoBoundingBoxQuery in the Search or ParallelScan operation to perform geo-bounding box queries.

Parameters

Parameter

Description

fieldName

The name of the column that you want to query. The value of this parameter is of the GEOPOINT data type.

topLeft

The coordinate pair of the upper-left corner of the rectangular geographic area.

bottomRight

The coordinate pair of the lower-right corner of the rectangular geographic area. A rectangular geographic area can be specified by using an upper-left corner and a lower-right corner.

The format is latitude,longitude. Valid values of latitude: [-90,+90]. Valid values of longitude: [-180,+180]. Example: 35.8,-45.91.

query

The query statement for the search index. Set this parameter to GeoBoundingBoxQuery.

getTotalCount

Specifies whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which specifies that the total number of rows that meet the query conditions is not returned.

If you set this parameter to true, the query performance is compromised.

tableName

The name of the data table.

indexName

The name of the search index.

columnsToGet

Specifies whether to return all columns of each row that meets the query conditions. You can specify the returnAll and columns fields for this parameter.

The default value of the returnAll field is false, which specifies that not all columns are returned. In this case, you can use the columns field to specify the columns that you want to return. If you do not specify the columns that you want to return, only the primary key columns are returned.

If you set the returnAll field to true, all columns are returned.

Methods

You can perform geo-bounding box queries by using the Tablestore console, Tablestore CLI, and Tablestore SDKs. Before perform geo-bounding box queries, make sure that the following prerequisites are met:

Use the Tablestore console

  1. Go to the Index Management tab.

    1. Log on to the Table Store console.

    2. In the top navigation bar, select a resource group and a region.

    3. On the Overview page, click the instance name or click Instance Management in the Actions column.

    4. On the Instance Details tab, in the Data Table List tab, click the data table name or click Index Management in the Actions column.

  2. On the Index Management tab, find the target Search Index and click Search in the Actions column.

  3. In the Search dialog box, configure the query.

    1. By default, all columns are returned. To return specific columns, turn off Retrieve All Columns and enter the column names, separated by commas.

      Note

      By default, Table Store returns the primary key columns of the data table.

    2. Select a logical operator: And, Or, or Not.

      If you select And, the query returns data that meets all specified conditions. If you select Or, the query returns data that meets at least one of the specified conditions. If you select Not, the query returns data that does not meet the specified conditions.

    3. Select an index field of the Geopoint type and click Add.

    4. Set the query type for the index field to GeoBoundingBoxQuery, and then enter the coordinates for the top-left and bottom-right corners of the rectangle.

    5. By default, sorting is disabled. To sort the results by a specific field, turn on Enable Sorting, add the sort field, and configure the sort order.

    6. By default, aggregation is disabled. To perform statistical aggregation on a specific field, turn on Enable Aggregation, add the field for aggregation, and configure the aggregation settings.

  4. Click OK.

    The query results are displayed on the Index Management tab.

Use the Tablestore CLI

You can use the Tablestore CLI to run the search command to query data by using search indexes. For more information, see Search index.

  1. Run the search command to use the search_index search index to query data and return all indexed columns of each row that meets the query conditions.

    search -n search_index --return_all_indexed
  2. The following sample code shows how to enter the query conditions as prompted by the system:

    {
        "Offset": -1,
        "Limit": 10,
        "Collapse": null,
        "Sort": null,
        "GetTotalCount": true,
        "Token": null,
        "Query": {
            "Name": "GeoBoundingBoxQuery",
            "Query": {
                "FieldName": "col_geopoint",
                "TopLeft": "10,0",
                "BottomRight": "0,10"
            }
        }
    }

Use Tablestore SDKs

You can perform geo-bounding box queries by using Tablestore SDK for Java, Tablestore SDK for Go, Tablestore SDK for Python, Tablestore SDK for Node.js, Tablestore SDK for .NET and Tablestore SDK for PHP. In the following example, Tablestore SDK for Java is used to describe how to perform geo-bounding box queries.

The following sample code provides an example on how to query rows in which the value of the Col_GeoPoint column falls within the rectangular geographic area defined by the "10,0" upper-left corner and the "0,10" lower-right corner:

public static void geoBoundingBoxQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    GeoBoundingBoxQuery geoBoundingBoxQuery = new GeoBoundingBoxQuery(); // Use GeoBoundingBoxQuery. 
    geoBoundingBoxQuery.setFieldName("Col_GeoPoint"); // Specify the name of the column that you want to query. 
    geoBoundingBoxQuery.setTopLeft("10,0"); // Specify the coordinates of the upper-left corner of the rectangular geographic area. 
    geoBoundingBoxQuery.setBottomRight("0,10"); // Specify the coordinates of the lower-right corner of the rectangular geographic area. 
    searchQuery.setQuery(geoBoundingBoxQuery);
    //searchQuery.setGetTotalCount(true); // Set the GetTotalCount parameter to true to return the total number of rows that meet the query conditions. 

    SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
    // You can use the columnsToGet parameter to specify the columns that you want to return or specify that all columns are returned. If you do not specify this parameter, only the primary key columns are returned. 
    //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
    //columnsToGet.setReturnAll(true); // Specify that all columns are returned. 
    //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); // Specify the columns that you want to return. 
    //searchRequest.setColumnsToGet(columnsToGet);

    SearchResponse resp = client.search(searchRequest);
    //System.out.println("TotalCount: " + resp.getTotalCount()); // Display the total number of rows that meet the query conditions instead of the number of rows that are returned. 
    System.out.println("Row: " + resp.getRows());
}

Billing

In VCU mode (formerly reserved mode), Search Index queries consume VCU compute resources. In CU mode (formerly pay-as-you-go mode), they consume read throughput. For more information, see Search Index metering and billing.

FAQ

References