.NET SDK實現排序和翻頁 -

使用多元索引查詢資料時，通過預先定義排序方式或者查詢時指定排序方式，您可以按照指定相片順序擷取到返回資料。當返回結果行數較多時，通過使用跳轉翻頁或者連續翻頁可以快速定位到所需資料。

使用情境

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

索引預排序

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

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

重要

索引預排序只支援PrimaryKeySort （按照主鍵排序）和FieldSort（按照欄位值排序）兩種方式。
含有Nested類型欄位的多元索引不支援索引預排序。
建立多元索引後，如果要修改多元索引的IndexSort，您可以使用動態修改schema功能實現。具體操作，請參見動態修改schema。

查詢時排序

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

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

ScoreSort

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

重要

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

var searchQuery = new SearchQuery();
searchQuery.Sort = new Sort(new List<ISorter>() { new ScoreSort() });

PrimaryKeySort

按照主鍵進行排序。

//正序。
var searchQuery = new SearchQuery();
searchQuery.Sort = new Sort(new List<ISorter>() { new PrimaryKeySort() });

//逆序。
var searchQuery = new SearchQuery();
searchQuery.Sort = new Sort(new List<ISorter>() { new PrimaryKeySort(SortOrder.DESC) });

FieldSort

按照列值進行排序。

單列排序

按照某列的值進行排序。

var searchQuery = new SearchQuery();
var fieldSort = new FieldSort("col", SortOrder.ASC);
searchQuery.Sort = new Sort(new List<ISorter>() { fieldSort });

多列排序

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

var searchQuery = new SearchQuery();
var col1Sort = new FieldSort("col", SortOrder.ASC);
var col2Sort = new FieldSort("co2", SortOrder.ASC);
searchQuery.Sort = new Sort(new List<ISorter>() { col1Sort, col2Sort });

GeoDistanceSort

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

var searchQuery = new SearchQuery();
var geoDistanceSort = new GeoDistanceSort("geoCol", new List<string>(){"0","0"});
searchQuery.Sort = new Sort(new List<ISorter>() { geoDistanceSort });

翻頁方式

在擷取返回結果時，可以使用Limit和Offset或者使用Token進行翻頁。

使用Limit和Offset翻頁

當需要擷取的返回結果行數小於100000行時，可以通過Limit和Offset進行翻頁，即Limit+Offset<=100000，其中Limit的最大值為100。

說明

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

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

var searchQuery = new SearchQuery();
searchQuery.Query = new MatchAllQuery();
searchQuery.Limit = 100;
searchQuery.Offset = 100;

使用Token翻頁

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

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

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

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

重要

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

/// <summary>
/// 使用Token進行翻頁，此樣本將讀取所有資料，放到一個List中。
/// </summary>
/// <param name="otsClient"></param>
public static SearchResponse ReadMoreRowsWithToken(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    searchQuery.Query = new MatchAllQuery();

    var request = new SearchRequest(TableName, IndexName, searchQuery);

    var response = otsClient.Search(request);
    var rows = response.Rows;
    while (response.NextToken != null) //直到讀取到NextToken為null，即讀出全部資料。
    {
        request.SearchQuery.Token = response.NextToken;
        response = otsClient.Search(request);
        rows.AddRange(response.Rows);
    }

    return response;
}

：排序和翻頁