Python SDK实现前缀查询_表格存储(Tablestore)-阿里云帮助中心

PrefixQuery根据前缀条件查询表中的数据。对于Text类型字段，只要分词后的词条中有词条满足前缀条件即可。

前提条件

已初始化OTSClient。具体操作，请参见初始化OTSClient。
已创建数据表并写入数据。具体操作，请参见创建数据表和写入数据。
已在数据表上创建多元索引。具体操作，请参见创建多元索引。

参数

参数	说明
field_name	要匹配的列。
prefix	前缀值。对于Text类型字段，只要分词后的词条中有词条满足前缀条件即可。
query	设置查询类型为PrefixQuery。
table_name	数据表名称。
index_name	多元索引名称。
limit	本次查询需要返回的最大数量。如果只为了获取行数，无需获取具体数据，可以设置limit=0，即不返回任意一行数据。
get_total_count	是否返回匹配的总行数，默认为False，表示不返回。返回匹配的总行数会影响查询性能。
columns_to_get	是否返回所有列，包含return_type和column_names设置。当设置return_type为ColumnReturnType.SPECIFIED时，可以通过column_names指定返回的列。当设置return_type为ColumnReturnType.ALL时，表示返回所有列。当设置return_type为ColumnReturnType.NONE时，表示不返回所有列，只返回主键列。

示例

以下示例用于查询表中Col_Keyword列的值中前缀为'tablestore'的数据。

5.2.1及之后版本

使用5.2.1及之后的SDK版本时，默认的返回结果为SearchResponse对象，请求示例如下：

query = PrefixQuery('Col_Keyword', 'tablestore')
search_response = client.search(
    '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',  
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)
print('request_id : %s' % search_response.request_id)
print('is_all_succeed : %s' % search_response.is_all_succeed)
print('total_count : %s' % search_response.total_count)
print('rows : %s' % search_response.rows)

# # 当需要进行深度翻页时，推荐使用next_token进行翻页（翻页深度无限制）
# all_rows = []
# next_token = None
# # first round
# search_response = client.search(
#     '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
#     SearchQuery(query, next_token=next_token, limit=100, get_total_count=True),
#     columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
# all_rows.extend(search_response.rows)
# 
# # loop
# while search_response.next_token:
#     search_response = client.search(
#         '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
#         SearchQuery(query, next_token=search_response.next_token, limit=100, get_total_count=True),
#         columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
#     all_rows.extend(search_response.rows)
# print('Total rows:%s' % len(all_rows))

如果需要返回Tuple类型结果，您可以使用如下请求示例实现。

query = PrefixQuery('Col_Keyword', 'tablestore')
rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search(
    '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
).v1_response()

5.2.1之前版本

使用5.2.1之前的SDK版本时，默认的返回结果为Tuple类型，请求示例如下：

query = PrefixQuery('Col_Keyword', 'tablestore')
rows, next_token, total_count, is_all_succeed = client.search(
   '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)

前缀查询

前提条件

参数

示例

常见问题

相关文档