全部產品
Search
文件中心

:首碼查詢

更新時間:Jul 20, 2024

PrefixQuery根據首碼條件查詢表中的資料。對於Text類型欄位,只要Text類型欄位值分詞後的詞條中有詞條滿足首碼條件即可。

前提條件

參數

參數

說明

table_name

資料表名稱。

index_name

多元索引名稱。

offset

本次查詢的開始位置。

limit

本次查詢需要返回的最大數量。

如果只為了擷取行數,無需擷取具體資料,可以設定limit=0,即不返回任意一行資料。

get_total_count

是否返回匹配的總行數,預設為false,表示不返回。

返回匹配的總行數會影響查詢效能。

query_type

設定查詢類型為QueryTypeConst::PREFIX_QUERY

field_name

要匹配的欄位。

prefix

首碼值。

對於Text類型欄位,只要分詞後的詞條中有詞條滿足首碼條件即可。

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

樣本

以下樣本用於查詢表中keyword列的值中首碼為"key"的資料。

$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::PREFIX_QUERY,
            'query' => array(
                'field_name' => 'keyword',
                'prefix' => 'key'
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_ALL,
        'return_names' => array('keyword')
    )
);
$response = $otsClient->search($request);

常見問題

相關文檔