类似于MatchQuery,但是分词后多个词的位置关系会被考虑,只有分词后的多个词在行数据中以同样的顺序和位置存在时,才表示行数据满足查询条件。

前提条件

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

参数

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

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

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

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

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

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

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

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

例如查询的值为“this is”,可以匹配到“...,this is tablestore”、“this is a table”,但是无法匹配到“this table is ...”以及“is this a table”。

columns_to_get 是否返回所有列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_SPECIFIED时,可以通过return_names指定返回的列。
  • 当设置return_type为ColumnReturnTypeConst::RETURN_ALL时,表示返回所有列。
  • 当设置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_PHRASE_QUERY,
            'query' => array(
                'field_name' => 'text',
                'text' => 'text keyword'
            )
        ),
        '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);