Tablestore:Geo query

Prerequisites

• An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.

• A data table is created and data is written to the data table. For more information, see Create data tables and Write data.

• A search index is created for the data table. For more information, see Create a search index.

Geo-distance query

You can use geo-distance query to specify a circular geographical area consisting of a central point and a 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 type of the query. Set the query type to TableStore.QueryType.GEO_DISTANCE_QUERY.
  fieldName	The name of the field. The type of the field 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 sample code provides an example on how to query the rows in which the value of the Col_GeoPoint column falls within a specific 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 specific data, set the limit parameter to 0. 
          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 the central point. 
                  distance: 10000 // Set the distance from the central point to a value smaller than or equal to 10,000. Unit: meter. 
              }
          },
          getTotalCount: true // Specify whether to return the total number of rows that meet the query conditions. Default value: false. 
      },
      columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return the specified columns, RETURN_ALL to return all columns, RETURN_ALL_FROM_INDEX to return all columns in the search index, or RETURN_NONE 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 type of the query. Set the query type to TableStore.QueryType.GEO_BOUNDING_BOX_QUERY.
  fieldName	The name of the field. The type of the field 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 following sample code provides an example on how to query the rows in which the value of the Col_GeoPoint column falls within a rectangular geographical area that is defined by a upper-left corner whose coordinate pair is "10,0" and a lower-right corner whose coordinate pair is "0,10":

  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 specific data, set the limit parameter to 0. 
          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 name of the field. 
                  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. Default value: false. 
      },
      columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return the specified columns, RETURN_ALL to return all columns, RETURN_ALL_FROM_INDEX to return all columns in the search index, or RETURN_NONE 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 type of the query. Set the query type to TableStore.QueryType.GEO_POLYGON_QUERY.
  fieldName	The name of the field. The type of the field values is Geopoint.
  points	The coordinate pairs of the points that define the polygon geographical area. The coordinate pair of each point must be in the format of "latitude,longitude". Valid values of latitude: [-90,90]. Valid values of longitude: [-180,180]. Example: “35.8,-45.91".

• Examples

  The following sample code provides an example on how to query the rows in which the value of the Col_GeoPoint column 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 specific data, set the limit parameter to 0. 
          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. Default value: false. 
      },
      columnToGet: { // Specify the columns that you want to return. You can set the parameter to RETURN_SPECIFIED to return the specified columns, RETURN_ALL to return all columns, RETURN_ALL_FROM_INDEX to return all columns in the search index, or RETURN_NONE 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));
  });

FAQ

• What do I do if no data can be found by calling the Search operation?

• Why does a token become invalid when pagination is used in a search index-based query?

References

• The following query types are supported by search indexes: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, Boolean query, geo query, nested query, vector query, and exists query. You can select a query type to query data based on your business requirements.

  If you want to sort or paginate the rows that meet the query conditions, you can use the sorting and paging feature. For more information, see Sorting and paging.

  If you want to collapse the result set based on a specific column, you can use the collapse (distinct) feature. This way, data of the specified type appears only once in the query results. For more information, see Collapse (distinct).

• If you want to analyze data in a data table, such as obtaining the extreme values, sum, and total number of rows, you can perform aggregation operations or execute SQL statements. For more information, see Aggregation and SQL query.

• If you want to quickly obtain all rows that meet the query conditions without the need to sort the rows, you can call the ParallelScan and ComputeSplits operations to use the parallel scan feature. For more information, see Parallel scan.