表格存储 Python SDK 匹配查询-表格存储 Tablestore(Tablestore)-阿里云帮助中心

前提条件

功能说明

匹配查询用于检索 Text 或 Keyword 类型字段（字段说明请参见字符串类型）。查询 Text 字段时，查询文本使用字段的分词器分词，并根据 operator 或 minimum_should_match 判断需要匹配的词条；查询 Keyword 字段时，查询文本不分词。匹配查询不要求词条按查询文本中的顺序相邻出现；如需按词条顺序和位置匹配，请使用短语匹配查询。

MatchQuery(
    field_name,
    text,
    minimum_should_match=None,
    operator=None,
    weight=None,
)

以下示例查询 description 字段中同时包含 tablestore 和 durable 词条的数据。

query = MatchQuery(
    "description",
    "tablestore durable",
    operator=QueryOperator.AND,
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(
        query,
        sort=Sort([ScoreSort()]),
        limit=10,
        get_total_count=True,
    ),
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
for hit in response.search_hits:
    print(hit.score, hit.row)

参数说明

查询请求

search 方法包含以下参数。

名称	类型	说明
table_name（必选）	`str`	数据表名称。
index_name（必选）	`str`	多元索引名称。
search_query（必选）	`SearchQuery`	查询条件和通用查询配置。
columns_to_get（可选）	`ColumnsToGet`	返回列配置。未设置时只返回主键列。
routing_keys（可选）	`list`	自定义路由字段对应的主键值列表。未配置自定义路由时无需设置。
timeout_s（可选）	`int`	请求级超时时间，单位为秒。未设置时使用客户端默认超时时间。

查询配置

search_query 的类型为 SearchQuery，包含以下参数。

名称	类型	说明
query（必选）	`Query`	查询条件。设置为 `MatchQuery`。
sort（可选）	`Sort`	返回结果的排序方式。有关配置方法，请参见排序和翻页。
get_total_count（可选）	`bool`	是否返回匹配总行数。默认值为 `False`；设置为 `True` 会增加查询开销。
next_token（可选）	`bytes`	翻页凭证。将上一次响应的 `next_token` 设置到下一次请求中可继续读取。
offset（可选）	`int`	本次查询的起始位置，适用于浅翻页。
limit（可选）	`int`	本次查询返回的最大行数。设置为 `0` 时不返回具体行。
aggs（可选）	`list[Agg]`	指标聚合配置。有关配置方法，请参见统计聚合。
group_bys（可选）	`list[BaseGroupBy]`	分组配置。有关配置方法，请参见统计聚合。
collapse_field（可选）	`Collapse`	结果折叠配置。有关配置方法，请参见折叠（去重）。
highlight（可选）	`Highlight`	`Text` 字段的摘要与高亮配置。有关配置方法，请参见摘要与高亮。

匹配条件

search_query.query 的类型为 MatchQuery，包含以下参数。

名称	类型	说明
field_name（必选）	`str`	要查询的 `Text` 或 `Keyword` 类型索引字段名称。
text（必选）	`str`	查询文本。查询 `Text` 字段时进行分词；查询 `Keyword` 字段时不分词。
minimum_should_match（可选）	`int`	`operator` 为 `OR` 时至少需要匹配的查询词条数。
operator（可选）	`QueryOperator`	查询词条的组合方式。`OR`（默认）表示匹配任意词条；`AND` 表示必须匹配全部词条。
weight（可选）	`float`	查询权重，必须为正浮点数。默认值为 `1.0`；影响相关性得分，不改变匹配范围。

返回列

columns_to_get 的类型为 ColumnsToGet，包含以下参数。

名称	类型	说明
column_names（可选）	`list[str]`	要返回的属性列名称。仅 `return_type` 为 `SPECIFIED` 时设置。
return_type（可选）	`ColumnReturnType`	返回列模式。`NONE`（默认）仅返回主键列；`SPECIFIED` 返回指定属性列；`ALL` 返回数据表全部属性列；`ALL_FROM_INDEX` 返回索引中已存储的全部属性列。

返回值

search 方法返回 SearchResponse。核心字段如下。

字段	类型	说明
rows	`list[Row]`	本次查询返回的行数据，数量不超过 `limit`。
next_token	`bytes`	下一页凭证。值为空时表示没有更多数据。
total_count	`int`	匹配行数，取决于 `get_total_count` 配置。
is_all_succeed	`bool`	是否已成功查询全部索引分区。值为 `False` 时返回的是部分结果。
agg_results	`list[AggResult]`	指标聚合结果。未配置 `aggs` 时为空。
group_by_results	`list[GroupByResult]`	分组结果。未配置 `group_bys` 时为空。
search_hits	`list[SearchHit]`	查询命中结果，包含行数据、相关性得分和高亮结果等扩展信息。

兼容 Tuple 返回格式

Tablestore Python SDK 5.2.0 开始将查询接口的返回值由 Tuple 调整为响应对象，5.1.0 及以下版本直接返回 Tuple。5.2.1 及以上版本可调用 SearchResponse.v1_response() 获取与旧版本兼容的 Tuple。新代码建议直接访问 SearchResponse 的属性，避免返回字段扩展后解包数量不匹配。

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()

场景示例

设置最小匹配词条数

以下示例要求查询文本分词后至少有两个词条命中。

query = MatchQuery(
    "description",
    "tablestore durable cloud",
    operator=QueryOperator.OR,
    minimum_should_match=2,
)
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(query, limit=10),
)
print(response.rows)