Geo query includes geo-distance query, geo-bounding box query, and geo-polygon query.

Prerequisites

  • A Tablestore client is initialized. For more information, see Initialization.
  • A data table is created. Data is written to the table.
  • A search index is created for the data table. For more information, see Create search indexes.

Geo-distance query

You can use geo-distance query to specify a circular geographical area consisting of a central point and radius as a filtering condition in a query. Tablestore returns the rows in which the value of the Geopoint column is within the circular geographical area.

  • Parameters
    Parameter Description
    tableName The name of the data table.
    indexName The name of the search index.
    query The query statement for the search index. Set the query type to TableStore.QueryType.GEO_DISTANCE_QUERY.
    fieldName The name of the column. The type of the column values is 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 "latitude,longitude". Valid values of the latitude: [-90,90]. Valid values of longitude: [-180,180]. Example: “35.8,-45.91".

    distance The radius of the circular geographical area. The value of this parameter is of the DOUBLE data type. Unit: meter.
  • Examples

    The following code provides an example on how to obtain the rows in which the value of Col_GeoPoint falls within a circular geographical area.

    client.search({
        tableName: TABLE_NAME,
        indexName: INDEX_NAME,
        searchQuery: {
            offset: 0,
            limit: 10, // To query only the number of rows that meet the query conditions without returning specific data, you can set limit to 0. This way, Tablestore returns the number of rows that meet the query conditions without specific data from the table. 
            query: { // Set the query type to TableStore.QueryType.GEO_DISTANCE_QUERY. 
                queryType: TableStore.QueryType.GEO_DISTANCE_QUERY,
                query: {
                    fieldName: "Col_GeoPoint",
                    centerPoint: "1,1", // Specify the coordinate pair for a central point. 
                    distance: 10000 // You can set the radius of the circular geographical area to a value greater than or equal to 10,000. Unit: meter. 
                }
            },
            getTotalCount: true // The value of TotalCount indicates the number of rows that match the query conditions. By default, TotalCount is set to false, which indicates that the total number of matched rows is not returned. Set TotalCount to true in this example. 
        },
        columnToGet: { // Specify the columns that you want to return. You can configure the RETURN_SPECIFIED parameter to return specified columns, the RETURN_ALL parameter to return all columns, the RETURN_ALL_FROM_INDEX parameter to return all columns in the search index, or the RETURN_NONE parameter to return only the primary key columns. 
            returnType: TableStore.ColumnReturnType.RETURN_ALL
        }
    }, function (err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }
        console.log('success:', JSON.stringify(data, null, 2));
    });

Geo-bounding box query

You can use geo-bounding box query to specify a rectangular geographical area as a filtering condition in a query. Tablestore returns the rows in which the value of the Geopoint column falls with the rectangular geographical area.

  • Parameters
    Parameter Description
    tableName The name of the data table.
    indexName The name of the search index.
    query The query statement for the search index. Set the query type to TableStore.QueryType.GEO_BOUNDING_BOX_QUERY.
    fieldName The name of the column. The type of the column values is Geopoint.
    topLeft The coordinate pair of the upper-left corner of the rectangular geographical area.
    bottomRight The coordinate pair of the lower-right corner of the rectangular geographical area. The coordinate pairs of the upper-left corner and lower-right corner define a unique rectangular geographical area.

    This parameter value must be in the format of "latitude,longitude". Valid values of the latitude: [-90,90]. Valid values of longitude: [-180,180]. Example: “35.8,-45.91".

  • Examples

    The data type of Col_GeoPoint is Geopoint. The coordinate pair of the upper-left corner is "10,0". The coordinate pair of the lower-right corner is "0,10". The following code provides an example on how to obtain the rows in which the value of Col_GeoPoint falls within a rectangular geographical area:

    client.search({
        tableName: TABLE_NAME,
        indexName: INDEX_NAME,
        searchQuery: {
            offset: 0,
            limit: 10, // To query only the number of rows that meet the query conditions without returning specific data, you can set limit to 0. This way, Tablestore returns the number of rows that meet the query conditions without specific data from the table. 
            query: { // Set the query type to TableStore.QueryType.GEO_BOUNDING_BOX_QUERY. 
                queryType: TableStore.QueryType.GEO_BOUNDING_BOX_QUERY,
                query: {
                    fieldName: "Col_GeoPoint", // Specify the column name. 
                    topLeft: "10,0", // Specify the coordinate pair for the upper-left corner of the rectangular geographical area. 
                    bottomRight: "0,10" // Specify coordinate pair for the lower-right corner of the rectangular geographical area. 
                }
            },
            getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which indicates that the total number of rows that meet the query conditions is not returned. 
        },
        columnToGet: { // Specify the columns that you want to return. You can configure the RETURN_SPECIFIED parameter to return specified columns, the RETURN_ALL parameter to return all columns, the RETURN_ALL_FROM_INDEX parameter to return all columns in the search index, or the RETURN_NONE parameter to return only the primary key columns. 
            returnType: TableStore.ColumnReturnType.RETURN_ALL
        }
    }, function (err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }
        console.log('success:', JSON.stringify(data, null, 2));
    });

Geo-polygon query

You can use geo-polygon query to specify a polygon geographical area. Tablestore returns the rows in which the value of the Geopoint column falls within the polygon geographical area.

  • Parameters
    Parameter Description
    tableName The name of the data table.
    indexName The name of the search index.
    query The query statement for the search index. Set the query type to TableStore.QueryType.GEO_POLYGON_QUERY.
    fieldName The name of the column. Set the query type to Geopoint.
    points The coordinate pairs of the points that define polygon geographical area.

    This parameter value must be in the format of "latitude,longitude". Valid values of the latitude: [-90,90]. Valid values of longitude: [-180,180]. Example: “35.8,-45.91".

  • Examples

    The following code provides an example on how to obtain the rows in which the value of Col_GeoPoint falls within a polygon geographical area:

    client.search({
        tableName: TABLE_NAME,
        indexName: INDEX_NAME,
        searchQuery: {
            offset: 0,
            limit: 10, // To query only the number of rows that meet the query conditions without returning specific data, you can set limit to 0. This way, Tablestore returns the number of rows that meet the query conditions without specific data from the table. 
            query: { // Set the query type to TableStore.QueryType.GEO_POLYGON_QUERY. 
                queryType: TableStore.QueryType.GEO_POLYGON_QUERY,
                query: {
                    fieldName: "Col_GeoPoint",
                    points: ["0,0","5,5","5,0"] // Specify coordinate pairs for vertices of a polygon geographical area. 
                }
            },
            getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which indicates that the total number of rows that meet the query conditions is not returned. 
        },
        columnToGet: { // Specify the columns that you want to return. You can configure the RETURN_SPECIFIED parameter to return specified columns, the RETURN_ALL parameter to return all columns, the RETURN_ALL_FROM_INDEX parameter to return all columns in the search index, or the RETURN_NONE parameter to return only the primary key columns. 
            returnType: TableStore.ColumnReturnType.RETURN_ALL
        }
    }, function (err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }
        console.log('success:', JSON.stringify(data, null, 2));
    });