类似于TermQuery,但是TermsQuery可以指定多个查询关键词,查询匹配这些词的数据。多个查询关键词中只要有一个词精确匹配,该行数据就会被返回,等价于SQL中的In。

前提条件

  • 已初始化OTSClient,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

参数

参数 说明
query_type 设置查询类型为TermsQuery。
field_name 要匹配的字段。
terms 多个查询关键词,即要匹配的值。

多个查询关键词中只要有一个词精确匹配,该行数据就会被返回。

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时,表示不返回所有列,只返回主键列。

示例

query = TermsQuery('k', ['key000', 'key100', 'key888', 'key999', 'key908', 'key1000'])
rows, next_token, total_count, is_all_succeed = client.search(
    table_name, index_name, 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)