表格存储 Go SDK 地理位置查询-表格存储 Tablestore(Tablestore)-阿里云帮助中心

使用 Tablestore Go SDK 按圆形、长方形或多边形地理范围查询 Geo-point 字段。

前提条件

安装Tablestore Go SDK并初始化客户端。

功能说明

地理位置查询用于匹配 Geo-point 字段处于指定空间范围内的数据，支持地理距离、地理长方形范围和地理多边形范围三种查询方式。三种方式的坐标均使用 纬度,经度 格式，纬度范围为 [-90,+90]，经度范围为 [-180,+180]，例如 35.8,-45.91。

func (client *tablestore.TableStoreClient) Search(request *tablestore.SearchRequest) (*tablestore.SearchResponse, error)

地理距离查询

地理距离查询以一个坐标为圆心，匹配与圆心距离不超过指定值的数据。

tableName := "example_table"
indexName := "example_index"

query := &search.GeoDistanceQuery{FieldName: "location", CenterPoint: "30.25,120.16", DistanceInMeter: 50000}
searchQuery := search.NewSearchQuery().
    SetQuery(query).
    SetLimit(10).
    SetGetTotalCount(true)

response, err := client.Search(&tablestore.SearchRequest{
    TableName:   tableName,
    IndexName:   indexName,
    SearchQuery: searchQuery,
    ColumnsToGet: &tablestore.ColumnsToGet{
        ReturnAllFromIndex: true,
    },
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(response.TotalCount)
fmt.Println(response.Rows)

地理长方形范围查询

地理长方形范围查询使用左上角和右下角坐标定义查询范围。

tableName := "example_table"
indexName := "example_index"

query := &search.GeoBoundingBoxQuery{FieldName: "location", TopLeft: "32,119", BottomRight: "29,122"}
searchQuery := search.NewSearchQuery().
    SetQuery(query).
    SetLimit(10).
    SetGetTotalCount(true)

response, err := client.Search(&tablestore.SearchRequest{
    TableName:   tableName,
    IndexName:   indexName,
    SearchQuery: searchQuery,
    ColumnsToGet: &tablestore.ColumnsToGet{
        ReturnAllFromIndex: true,
    },
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(response.TotalCount)
fmt.Println(response.Rows)

地理多边形范围查询

地理多边形范围查询使用多个坐标点依次连接形成查询范围。

tableName := "example_table"
indexName := "example_index"

query := &search.GeoPolygonQuery{FieldName: "location", Points: []string{"29,119", "32,119", "32,122", "29,122"}}
searchQuery := search.NewSearchQuery().
    SetQuery(query).
    SetLimit(10).
    SetGetTotalCount(true)

response, err := client.Search(&tablestore.SearchRequest{
    TableName:   tableName,
    IndexName:   indexName,
    SearchQuery: searchQuery,
    ColumnsToGet: &tablestore.ColumnsToGet{
        ReturnAllFromIndex: true,
    },
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(response.TotalCount)
fmt.Println(response.Rows)

参数说明

查询请求

名称	类型	说明
TableName（必选）	string	数据表名称。
IndexName（必选）	string	多元索引名称。
SearchQuery（必选）	search.SearchQuery	查询条件和通用查询配置。
ColumnsToGet（可选）	*tablestore.ColumnsToGet	返回列配置。未设置时只返回主键列。
RoutingValues（可选）	[]*tablestore.PrimaryKey	自定义路由字段对应的主键值列表。未配置自定义路由时无需设置。
TimeoutMs（可选）	*int32	请求级超时时间，单位为毫秒。

查询配置

名称	类型	说明
SetQuery（必选）	search.Query	设置查询条件。
SetOffset（可选）	int32	设置本次查询的起始位置，默认值为 0。使用 Offset 翻页时，Offset + Limit 不能超过 100000。
SetLimit（可选）	int32	设置本次查询返回的最大行数，默认值为 10，最大值为 100。设置为 0 时不返回具体行。
SetCollapse（可选）	*search.Collapse	设置结果折叠。配置方法请参见折叠（去重）。
SetSort（可选）	*search.Sort	设置返回结果的排序方式。配置方法请参见排序和翻页。
SetGetTotalCount（可选）	bool	是否统计匹配总行数，默认值为 false。
SetToken（可选）	[]byte	设置上一次响应返回的 NextToken，以继续读取后续数据。调用该方法会清除 Sort，因为 Token 已包含上一页的排序条件。使用 Token 翻页时不能设置 Offset。
SetSearchFilter（可选）	*search.SearchFilter	对查询结果执行后过滤。配置方法请参见查询后过滤。
Aggregation（可选）	...search.Aggregation	设置统计聚合。配置方法请参见统计聚合。
GroupBy（可选）	...search.GroupBy	设置分组。配置方法请参见统计聚合。

地理距离查询条件

名称	类型	说明
FieldName（必选）	string	Geo-point 字段名称。
CenterPoint（必选）	string	圆心坐标，格式为 `纬度,经度`。
DistanceInMeter（必选）	float64	查询半径，单位为米。

地理长方形范围查询条件

名称	类型	说明
FieldName（必选）	string	Geo-point 字段名称。
TopLeft（必选）	string	左上角坐标。
BottomRight（必选）	string	右下角坐标。

地理多边形范围查询条件

名称	类型	说明
FieldName（必选）	string	Geo-point 字段名称。
Points（必选）	[]string	按顺序组成多边形的坐标点列表。

返回列

名称	类型	说明
Columns（可选）	[]string	要返回的属性列名称。仅 ReturnAll 和 ReturnAllFromIndex 均为 false 时生效。
ReturnAll（可选）	bool	是否返回数据表中的全部属性列，默认值为 false。
ReturnAllFromIndex（可选）	bool	是否返回已建立索引的全部属性列，默认值为 false。不能与 ReturnAll 同时设置为 true。

返回值

名称	类型	说明
TotalCount	int64	匹配总行数。返回值取决于 SetGetTotalCount 配置。
Rows	[]*tablestore.Row	本次查询返回的行数据，数量不超过 SetLimit 指定的值。
SearchHits	[]*tablestore.SearchHit	查询命中结果。配置摘要与高亮、嵌套 InnerHits 或需要相关性评分时，从该字段读取结果。
NextToken	[]byte	下一页凭证。值非空时，将其传入下一次查询继续读取。
IsAllSuccess	bool	是否已成功查询全部索引分区。值为 false 时返回的是部分结果，TotalCount 可能小于实际匹配行数。
AggregationResults	search.AggregationResults	统计聚合结果。
GroupByResults	search.GroupByResults	分组结果。