Tablestore：排序和翻頁

使用情境

索引預排序

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

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

查詢時排序

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

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

ScoreSort

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new ScoreSort())));

PrimaryKeySort

按照主鍵進行排序。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort()))); //正序。
//searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort(SortOrder.DESC)))); //逆序。

FieldSort

按照某列的值進行排序。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new FieldSort("col", SortOrder.ASC))));

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

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(
    new FieldSort("col1", SortOrder.ASC), new FieldSort("col2", SortOrder.ASC))));

數群組類型、巢狀型別等多重值欄位可以通過指定mode參數來控制參與排序的元素。

按照數組多值的指定列值進行排序。

// 有doc1和doc2兩行資料，其field1列為數群組類型。doc1的field1列值為[2,3]，doc2的field1列值為[1,3,4]。
// 您可以通過設定mode參數來指定按照數組中的哪個值進行排序。
{
    // 當設定mode參數為SortMode.MAX時，排序結果為doc2（4參與排序）、doc1（3參與排序）。
    FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
    fieldSort.setMode(SortMode.MAX);
}
{
    // 當設定mode參數為SortMode.MIN時，排序結果為doc1（2參與排序）、doc2（1參與排序）。
    FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
    fieldSort.setMode(SortMode.MIN);
}

您也可以對Nested類型欄位的子行進行排序。

// 有doc1和doc2兩行資料，其field1列為Nested類型。
// doc1的field1列值為[{"name":"b", "age":1},{"name":"a", "age":7}]。
// doc2的field1列值為[{"name":"a", "age":1},{"name":"c", "age":1},{"name":"d", "age":5}]

{
    // 對所有子行進行排序，通過設定mode參數來指定按照哪個值進行排序。
    // 當設定mode參數為SortMode.MAX時，按照age列排序的排序結果為doc1（7參與排序）、doc2（5參與排序）。
    FieldSort fieldSort = new FieldSort("field1.age", SortOrder.DESC);
    fieldSort.setMode(SortMode.MAX);
    String path = "field1";
    NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.matchAll().build());
    fieldSort.setNestedFilter(nestedFilter);
}
{
    // 僅對age=1的子行進行排序，通過設定mode參數來指定按照哪個值進行排序。
    {
        // 當設定mode參數為SortMode.MAX時，按照name列排序的排序結果為doc2（"a"參與排序）、doc1("b"參與排序)
        FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
        fieldSort.setMode(SortMode.MAX);
        String path = "field1";
        NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
        fieldSort.setNestedFilter(nestedFilter);
    }
    {
        // 當設定mode參數為SortMode.MIN時，按照name列排序的排序結果為doc1（"b"參與排序）、doc2（"a"參與排序）。
        FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
        fieldSort.setMode(SortMode.MIN);
        String path = "field1";
        NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
        fieldSort.setNestedFilter(nestedFilter);
    }
}

GeoDistanceSort

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

SearchQuery searchQuery = new SearchQuery();
//geo列為Geopoint類型，按照此列的值距離"0,0"點的距離進行排序。
Sort.Sorter sorter = new GeoDistanceSort("geo", Arrays.asList("0, 0"));
searchQuery.setSort(new Sort(Arrays.asList(sorter)));

翻頁方式

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

使用limit和offset翻頁

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

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setLimit(100);
searchQuery.setOffset(100);

使用token翻頁

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

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

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

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

private static void readMoreRowsWithToken(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    searchQuery.setQuery(new MatchAllQuery());
    searchQuery.setGetTotalCount(true);//設定返回匹配的總行數。

    SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);

    SearchResponse resp = client.search(searchRequest);
    if (!resp.isAllSuccess()) {
        throw new RuntimeException("not all success");
    }
    List<Row> rows = resp.getRows();
    while (resp.getNextToken()!=null) { // 當讀取到nextToken為null時，表示讀出全部資料。
        // 擷取nextToken。
        byte[] nextToken = resp.getNextToken();

        {
            // 如果需要持久化nextToken或者傳輸nextToken給前端頁面，您可以使用Base64編碼將nextToken編碼為String進行儲存和傳輸。
            // token本身不是字串，直接使用new String(nextToken)將token編碼為String會造成token資訊丟失。
            String tokenAsString = Base64.toBase64String(nextToken);
            // 將String解碼為byte。
            byte[] tokenAsByte = Base64.fromBase64String(tokenAsString);
        }

        // 將token設定到下一次請求中。
        searchRequest.getSearchQuery().setToken(nextToken);
        resp = client.search(searchRequest);
        if (!resp.isAllSuccess()) {
            throw new RuntimeException("not all success");
        }
        rows.addAll(resp.getRows());
    }
    System.out.println("RowSize: " + rows.size());
    System.out.println("TotalCount: " + resp.getTotalCount());// 列印匹配到的總行數，非返回行數。
}