MatchQuery采用近似匹配的方式查询表中的数据。对Text类型的列值和查询关键词会先按照设置好的分词器做切分,然后按照切分好后的词去查询。

前提条件

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

参数

参数 说明
field_name 要匹配的列。

匹配查询可应用于Text类型。

text 查询关键词,即要匹配的值。

当要匹配的列为Text类型时,查询关键词会被分词成多个词,分词类型为创建多元索引时设置的分词器类型。如果创建多元索引时未设置分词器类型,则默认分词类型为单字分词。

例如当要匹配的列为Text类型时,分词类型为单字分词,则查询词为"this is",可以匹配到“...,this is tablestore”、“is this tablestore”、“tablestore is cool”、“this"、“is”等。

query 设置查询类型为MatchQuery。
table_name 数据表名称。
index_name 多元索引名称。
limit 本次查询需要返回的最大数量。

如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。

operator 逻辑运算符。默认为OR,表示当分词后的多个词只要有部分匹配时,则行数据满足查询条件。

如果设置operator为AND,则只有分词后的所有词都在列值中时,才表示行数据满足查询条件。

minimum_should_match 最小匹配个数。

只有当某一行数据的field_name列的值中至少包括最小匹配个数的词时,才会返回该行数据。

说明 minimum_should_match需要与逻辑运算符OR配合使用。
get_total_count 是否返回匹配的总行数,默认为False,表示不返回。

返回匹配的总行数会影响查询性能。

columns_to_get 是否返回所有列。
  • 当设置return_type为ColumnReturnType.SPECIFIED时,可以通过column_names指定返回的列。
  • 当设置return_type为ColumnReturnType.ALL时,表示返回所有列。
  • 当设置return_type为ColumnReturnType.NONE时,表示不返回所有列,只返回主键列。

示例

query = MatchQuery('t', 'this is 0')
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)
)