Tablestore：排序和翻頁

使用情境

索引預排序

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

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

查詢時排序

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

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

ScoreSort

使用 ScoreSort 按 BM25 相關性評分排序，支援升序和降序。

sort: {
    sorters: [
        {
            scoreSort: {
                order: TableStore.SortOrder.SORT_ORDER_ASC
            }
        }
    ]
}

PrimaryKeySort

按照主鍵進行排序。

使用 PrimaryKeySort 按主索引值排序。

sort: {
    sorters: [
        {
            primaryKeySort: {
                order: TableStore.SortOrder.SORT_ORDER_DESC //逆序。
                //order: TableStore.SortOrder.SORT_ORDER_ASC //正序。
            }
        }
    ]
}

FieldSort

使用 FieldSort 按列值排序。

sort: {
    sorters: [
        {
            fieldSort: {
                fieldName: "Col_Keyword",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        }
    ]
}

sort: {
    sorters: [
        {
            fieldSort: {
                fieldName: "Col_Keyword",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        },
        {
            fieldSort: {
                fieldName: "Col_Long",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        }
    ]
}

GeoDistanceSort

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

使用 GeoDistanceSort 按距中心地理座標點的距離排序。

sort: {
    sorters: [
        {
            geoDistanceSort: {
                fieldName: "Col_Geo_Point",
                points: ["0,0"],//設定中心點。
                order: TableStore.SortOrder.SORT_ORDER_ASC //距離中心點正序返回。
            }
        }
    ]
}

完整樣本請參見Search。

翻頁方式

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

使用 limit 和 offset 翻頁

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

通過 offset 和 limit 直接跳轉到任意頁，支援結果集不超過 10 萬行的情境。

/**
 * 通過 limit+offset 翻頁，直接跳轉到第 10 頁（第 90～99 條資料）。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 90,
        limit: 10,
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true //返回匹配的總行數，預設為 false。
    },
    columnToGet: {
        //RETURN_ALL：返回所有列。
        //RETURN_SPECIFIED：返回指定列。
        //RETURN_NONE：僅返回主鍵列。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

使用 token 翻頁

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

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

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

token 翻頁通過遊標（NextToken）逐頁擷取資料，每次響應中包含下一頁的 token。Token 在查詢期間持續有效，緩衝歷史 token 可回到之前的頁面。

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

以下樣本分別示範同步和非同步兩種方式的 token 翻頁，兩者使用相同的初始 params 對象。

var params = {
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10,
        token: null,//設定為上次響應的 nextToken，用於擷取下一頁資料（位元組流類型）。
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true
    },
    columnToGet: {
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["pic_tag", "pic_description", "time_stemp", "pos"]
    }
};

/**
 * 同步方式：逐頁等待響應後再擷取下一頁。
 */
(async () => {
  try {
    var data = await client.search(params);
    console.log('success:', JSON.stringify(data, null, 2));

    while (data.nextToken && data.nextToken.length) {
      //token 持久化：將位元組流 nextToken 轉換為 Base64 字串儲存，
      //使用時再轉換回位元組流。
      var nextToken = data.nextToken.toString("base64");
      var token = Buffer.from(nextToken, "base64");

      params.searchQuery.token = token;//更新 token，翻到下一頁。
      data = await client.search(params);
      console.log('token success:', JSON.stringify(data, null, 2));
    }
  } catch (error) {
      console.log(error);
  }
})()

/**
 * 非同步方式：通過回呼函數擷取下一頁資料。
 */
client.search(params, function (err, data) {
    console.log('success:', JSON.stringify(data, null, 2));

    if (data.nextToken && data.nextToken.length) {
        //token 持久化方式與同步樣本相同。
        var nextToken = data.nextToken.toString("base64");
        var token = Buffer.from(nextToken, "base64");

        params.searchQuery.token = token;//更新 token，翻到下一頁。
        client.search(params, function (err, data) {
            console.log('token success:', JSON.stringify(data, null, 2));
        });
    }
});