地理距离查询(GeoDistanceQuery)根据一个中心点和距离条件查询表中的数据。当一个地理位置点到指定的中心点的距离不超过指定的值时,表示该地理位置点满足查询条件。
接口
地理距离查询的接口为Search或者ParallelScan,具体的Query类型为GeoDistanceQuery。
参数
|
参数 |
说明 |
|
fieldName |
列名,类型为Geopoint。 |
|
centerPoint |
中心地理坐标点,是一个经纬度值。 格式为 |
|
distanceInMeter |
距离中心点的距离。类型为Double。单位为米。 |
|
getTotalCount |
是否返回匹配的总行数,默认为false,表示不返回。 返回匹配的总行数会影响查询性能。 |
|
query |
多元索引的查询语句。设置查询类型为GeoDistanceQuery。 |
|
tableName |
数据表名称。 |
|
indexName |
多元索引名称。 |
|
columnsToGet |
是否返回所有列,包含returnAll和columns设置。 returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。 当设置returnAll为true时,表示返回所有列。 |
使用方式
您可以使用控制台、命令行工具或者SDK进行地理距离查询。进行地理距离查询之前,您需要完成如下准备工作。
使用阿里云账号或者具有表格存储操作权限的 RAM 用户进行操作。如果需要为 RAM 用户授权表格存储操作权限,请参见通过RAM Policy为RAM用户授权进行配置。
使用 SDK 方式和命令行工具方式进行操作时,如果当前无可用 AccessKey,则需要为阿里云账号或者 RAM 用户创建 AccessKey。
已创建数据表。
已为数据表创建多元索引。
使用 SDK 方式进行操作时,还需要完成初始化Tablestore Client。
使用命令行工具方式进行操作前,还需要完成下载并启动命令行工具,然后配置接入实例信息并选择要操作的表。具体操作,请参见下载命令行工具、启动并配置接入信息和数据表操作。
计费说明
使用 VCU 模式(原预留模式)时,使用多元索引查询数据会消耗 VCU 的计算资源。使用 CU 模式(原按量模式)时,使用多元索引查询数据会消耗读吞吐量。更多信息,请参见多元索引计量计费。