MatchQuery采用近似匹配的方式查询表中的数据。对Text类型的列值和查询关键词会先按照设置好的分词器做切分,然后按照切分好后的词去查询。对于进行模糊分词的列,建议使用MatchPhraseQuery实现高性能的模糊查询。

前提条件

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

参数

参数说明
table_name数据表名称。
index_name多元索引名称。
offset本次查询的开始位置。
limit本次查询需要返回的最大数量。

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

get_total_count是否返回匹配的总行数,默认为false,表示不返回。

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

query_type设置查询类型为QueryTypeConst::MATCH_QUERY
field_name要匹配的列。

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

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

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

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

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

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

minimum_should_match最小匹配个数。

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

说明 minimum_should_match需要与逻辑运算符OR配合使用。
columns_to_get是否返回所有列,包含return_type和return_names设置。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_SPECIFIED时,可以通过return_names指定返回的列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_ALL时,表示返回所有列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX时,表示返回多元索引中的所有列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_NONE时,表示不返回所有列,只返回主键列。

示例

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 2,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_QUERY,
            'query' => array(
                'field_name' => 'text',
                'text' => 'ots text php keyword',
//              'operator' => QueryOperatorConst::PBAND,
                'operator' => QueryOperatorConst::PBOR,//minimum_should_match与OR配合使用。
                'minimum_should_match' => 3
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('text')
    )
);
$response = $otsClient->search($request);