地理位置查询

前提条件

• 已初始化Client。具体操作，请参见初始化Client。

• 已创建数据表并写入数据。具体操作，请参见创建数据表和写入数据。

• 已在数据表上创建多元索引。具体操作，请参见创建多元索引。

地理距离查询（GeoDistanceQuery）

GeoDistanceQuery根据一个中心点和距离条件查询表中的数据，当一个地理位置点到指定的中心点的距离不超过指定的值时，满足查询条件。

• 参数

  参数	说明
  tableName	数据表名称。
  indexName	多元索引名称。
  query	多元索引的查询语句。设置查询类型为TableStore.QueryType.GEO_DISTANCE_QUERY。
  fieldName	列名，类型为Geopoint。
  centerPoint	中心地理坐标点，是一个经纬度值。 格式为“纬度,经度”，纬度在前，经度在后，且纬度范围为-90～+90，经度范围-180～+180。例如“35.8,-45.91”。
  distance	距离中心点的距离，类型为Double。单位为米。

• 示例

  以下示例用于查询表中Col_GeoPoint列的值距离中心点不超过一定距离的数据。

  client.search({
      tableName: TABLE_NAME,
      indexName: INDEX_NAME,
      searchQuery: {
          offset: 0,
          limit: 10, //如果只为了获取行数，无需获取具体数据，可以设置limit=0，即不返回任意一行数据。
          query: { //设置查询类型为TableStore.QueryType.GEO_DISTANCE_QUERY。
              queryType: TableStore.QueryType.GEO_DISTANCE_QUERY,
              query: {
                  fieldName: "Col_GeoPoint",
                  centerPoint: "1,1", //设置中心点。
                  distance: 10000 //设置条件为到中心点的距离不超过10000米。
              }
          },
          getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数，默认为false，表示不返回。
      },
      columnToGet: { //返回列设置，可设置为RETURN_SPECIFIED（自定义返回列）、RETURN_ALL（返回所有列）、RETURN_ALL_FROM_INDEX（返回多元索引中的所有列）、RETURN_NONE（不返回）。
          returnType: TableStore.ColumnReturnType.RETURN_ALL
      }
  }, function (err, data) {
      if (err) {
          console.log('error:', err);
          return;
      }
      console.log('success:', JSON.stringify(data, null, 2));
  });

地理长方形范围查询（GeoBoundingBoxQuery）

GeoBoundingBoxQuery根据一个长方形范围的地理位置边界条件查询表中的数据，当一个地理位置点落在给出的长方形范围内时满足查询条件。

• 参数

  参数	说明
  tableName	数据表名称。
  indexName	多元索引名称。
  query	多元索引的查询语句。设置查询类型为TableStore.QueryType.GEO_BOUNDING_BOX_QUERY。
  fieldName	列名，类型为Geopoint。
  topLeft	长方形框的左上角的坐标。
  bottomRight	长方形框的右下角的坐标，通过左上角和右下角就可以确定一个唯一的长方形。 格式为“纬度,经度”，纬度在前，经度在后，且纬度范围为-90～+90，经度范围-180～+180。例如“35.8,-45.91”。

• 示例

  以下示例用于查询表中Col_GeoPoint列的值在左上角为"10,0"，右下角为"0,10"的长方形范围内的数据。

  client.search({
      tableName: TABLE_NAME,
      indexName: INDEX_NAME,
      searchQuery: {
          offset: 0,
          limit: 10, //如果只为了获取行数，无需获取具体数据，可以设置limit=0，即不返回任意一行数据。
          query: { //设置查询类型为TableStore.QueryType.GEO_BOUNDING_BOX_QUERY。
              queryType: TableStore.QueryType.GEO_BOUNDING_BOX_QUERY,
              query: {
                  fieldName: "Col_GeoPoint", //设置列名。
                  topLeft: "10,0", //设置长方形左上角。
                  bottomRight: "0,10" //设置长方形右下角。
              }
          },
          getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数，默认为false，表示不返回。
      },
      columnToGet: { //返回列设置，可设置为RETURN_SPECIFIED（自定义返回列）、RETURN_ALL（返回所有列）、RETURN_ALL_FROM_INDEX（返回多元索引中的所有列）、RETURN_NONE（不返回）。
          returnType: TableStore.ColumnReturnType.RETURN_ALL
      }
  }, function (err, data) {
      if (err) {
          console.log('error:', err);
          return;
      }
      console.log('success:', JSON.stringify(data, null, 2));
  });

地理多边形范围查询（GeoPolygonQuery）

GeoPolygonQuery根据一个多边形范围条件查询表中的数据，当一个地理位置点落在指定的多边形范围内时满足查询条件。

• 参数

  参数	说明
  tableName	数据表名称。
  indexName	多元索引名称。
  query	多元索引的查询语句。设置查询类型为TableStore.QueryType.GEO_POLYGON_QUERY。
  fieldName	列名，类型为Geopoint。
  points	组成多边形的距离坐标点。 格式为“纬度,经度”，纬度在前，经度在后，且纬度范围为-90～+90，经度范围-180～+180。例如“35.8,-45.91”。

• 示例

  以下示例用于查询表中Col_GeoPoint列的值在一个给定多边形范围内的数据。

  client.search({
      tableName: TABLE_NAME,
      indexName: INDEX_NAME,
      searchQuery: {
          offset: 0,
          limit: 10, //如果只为了获取行数，无需获取具体数据，可以设置limit=0，即不返回任意一行数据。
          query: { //设置查询类型为TableStore.QueryType.GEO_POLYGON_QUERY。
              queryType: TableStore.QueryType.GEO_POLYGON_QUERY,
              query: {
                  fieldName: "Col_GeoPoint",
                  points: ["0,0","5,5","5,0"] //设置多边形的顶点。
              }
          },
          getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数，默认为false，表示不返回。
      },
      columnToGet: { //返回列设置，可设置为RETURN_SPECIFIED（自定义返回列）、RETURN_ALL（返回所有列）、RETURN_ALL_FROM_INDEX（返回多元索引中的所有列）、RETURN_NONE（不返回）。
          returnType: TableStore.ColumnReturnType.RETURN_ALL
      }
  }, function (err, data) {
      if (err) {
          console.log('error:', err);
          return;
      }
      console.log('success:', JSON.stringify(data, null, 2));
  });

常见问题

• 使用多元索引Search接口查不到数据

• 为什么使用多元索引翻页查询时Token失效了？

相关文档

• 多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、多条件组合查询、地理位置查询、嵌套类型查询、向量检索和列存在性查询，您可以选择合适的查询类型进行多维度数据查询。

  如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。

  如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。

• 如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。

• 如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。