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

前提条件

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

参数

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

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

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

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

query_type设置查询类型为QueryTypeConst::TERMS_QUERY
field_name要匹配的字段。
terms多个查询关键词,即要匹配的值。

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

sort按照指定方式排序。更多信息,请参见排序和翻页
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' => 5,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::TERMS_QUERY,
            'query' => array(
                'field_name' => 'keyword',
                'terms' => array(
                    "keyword",
                    "php"
                )
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'long',
                    'order' => SortOrderConst::SORT_ORDER_DESC,
                    'mode' => SortModeConst::SORT_MODE_AVG
                )
            )
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('keyword', 'long')
    )
);
$response = $otsClient->search($request);