排序和翻頁 - Tablestore

使用情境


分類	使用方式	功能	使用情境
排序	建立時指定排序方式	IndexSort（索引預排序）	多元索引預設按照設定的索引預排序（IndexSort）方式進行排序，用於確定資料的預設返回順序。
	查詢時指定排序方式	ScoreSort （分數排序）	按照查詢結果的相關性（BM25演算法）分數進行排序，適用於有相關性的情境，例如全文檢索索引等。
		PrimaryKeySort（主鍵排序）	按照主鍵進行排序，適用於按照事物標識排序的情境。
		FieldSort（欄位值排序）	按照欄位值進行排序，適用於電商、社交媒資等按照事物屬性排序的情境，例如商品銷量、瀏覽量等。
		GeoDistanceSort（地理位置排序）	根據地理點距離進行排序，適用於地圖、物流等按照距離排序事物的情境，例如某個位置周邊餐廳按距離排序等。
翻頁	查詢時指定翻頁方式	使用limit和offser翻頁	返回結果行數小於50000行時用於跳轉翻頁。
翻頁	查詢時指定翻頁方式	使用token翻頁	用於連續翻頁，預設只能向後翻頁。由於在一次查詢的翻頁過程中token長期有效，您可以通過緩衝並使用之前的token實現向前翻頁。

索引預排序

多元索引預設按照設定的索引預排序（IndexSort）方式進行排序，使用多元索引查詢資料時，IndexSort決定了資料的預設返回順序。

在建立多元索引時，您可以自訂IndexSort，如果未自訂IndexSort，則IndexSort預設為主鍵排序。

重要

索引預排序只支援PrimaryKeySort （按照主鍵排序）和FieldSort（按照欄位值排序）兩種方式。
含有Nested類型欄位的多元索引不支援索引預排序。

查詢時排序

只有enable_sort_and_agg設定為true的欄位才能進行排序。

在每次查詢時，可以指定排序方式，多元索引支援如下四種排序方式（Sorter）。您也可以使用多個Sorter，實現先按照某種方式排序，再按照另一種方式排序的需求。

ScoreSort

按照查詢結果的相關性（BM25演算法）分數進行排序，適用於有相關性的情境，例如全文檢索索引等。

重要如果需要按照相關性打分進行排序，必須手動設定ScoreSort，否則會按照索引設定的IndexSort進行排序。

'sort' => array(
    array(
        'score_sort' => array(
            'order' => SortOrderConst::SORT_ORDER_DESC
        )
    ),
)

PrimaryKeySort

按照主鍵進行排序。

'sort' => array(
    array(
        'pk_sort' => array(
            'order' => SortOrderConst::SORT_ORDER_ASC
        )
    ),
)

FieldSort

按照某列的值進行排序。

'sort' => array(
    array(
        'field_sort' => array(
            'field_name' => 'keyword',
            'order' => SortOrderConst::SORT_ORDER_ASC,
            'mode' => SortModeConst::SORT_MODE_AVG,
        )
    ),
)

GeoDistanceSort

根據地理點距離進行排序。

'sort' => array(
    array(
        'geo_distance_sort' => array(
            'field_name' => 'geo',
            'order' => SortOrderConst::SORT_ORDER_ASC,
            'distance_type' => GeoDistanceTypeConst::GEO_DISTANCE_PLANE,
            'points' => array('0.6,0.6')
        )
    ),
)

多類型組合排序

先按照某列進行排序，再按照另一列進行排序。

'sort' => array(
    array(
        'field_sort' => array(
            'field_name' => 'keyword',
            'order' => SortOrderConst::SORT_ORDER_ASC,
            'mode' => SortModeConst::SORT_MODE_AVG,
        )
    ),
    array(
        'pk_sort' => array(
            'order' => SortOrderConst::SORT_ORDER_ASC
        )
    ),
)

翻頁方式

在擷取返回結果時，可以使用limit和offset或者使用token進行翻頁。

使用limit和offset翻頁

當需要擷取的返回結果行數小於50000行時，可以使用limit和offset進行翻頁，即limit+offset<=50000，其中limit的最大值為100。

说明如果需要提高limit的上限，請參見如何將多元索引Search介面查詢資料的limit提高到1000。

如果使用此方式進行翻頁時未設定limit和offset，則limit的預設值為10，offset的預設值為0。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 10,
        'limit' => 10,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_ALL_QUERY
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        ),
        'token' => null,
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('col1', 'col2')
    )
);
$response = $otsClient->search($request);

使用token翻頁

由於使用token進行翻頁時翻頁深度無限制，當需要進行深度翻頁時，推薦使用token進行翻頁。

當符合查詢條件的資料未讀取完時，服務端會返回next_token，此時可以使用next_token繼續讀取後面的資料。

使用token進行翻頁時預設只能向後翻頁。由於在一次查詢的翻頁過程中token長期有效，您可以通過緩衝並使用之前的token實現向前翻頁。

使用token翻頁後的排序方式和上一次請求的一致，無論是系統預設使用IndexSort還是自訂排序，因此設定了token不能再設定Sort。另外使用token後不能設定offset，只能依次往後讀取，即無法跳頁。

重要由於含有Nested類型欄位的多元索引不支援索引預排序，如果使用含有Nested類型欄位的多元索引查詢資料且需要翻頁，則必須在查詢條件中指定資料返回的排序方式，否則當符合查詢條件的資料未讀取完時，服務端不會返回next_token。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 10,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::FUNCTION_SCORE_QUERY,
            'query' => array(
                'query' => array(
                    'query_type' => QueryTypeConst::TERM_QUERY,
                    'query' => array(
                        'field_name' => 'keyword',
                        'term' => 'keyword'
                    )
                ),
                'field_value_factor' => array(
                    'field_name' => 'long'
                )
            )
        ),
        'sort' => array(
            array(
                'score_sort' => array(
                    'order' => SortOrderConst::SORT_ORDER_DESC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('keyword', 'long')
    )
);

$response = $otsClient->search($request);
print "total_hits: " . $response['total_hits'] . "\n";
print json_encode($response['rows'], JSON_PRETTY_PRINT);

while($response['next_token'] != null) {
    $request['search_query']['token'] = $response['next_token'];
    $request['search_query']['sort'] = null;//當有next_token時，不能再設定Sort，token中包含sort資訊。
    $response = $otsClient->search($request);
    print json_encode($response['rows'], JSON_PRETTY_PRINT);
}