使用場景

索引預排序

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

在創建多元索引時，您可以自定義IndexSort，如果未自定義IndexSort，則IndexSort默認為主鍵排序。

查詢時排序

只有enableSortAndAgg設置為true的字段才能進行排序。

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

ScoreSort

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

PrimaryKeySort

按照主鍵進行排序。

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

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

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

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。

/**
 * 通過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 //結果中的TotalCount表示數據的總行數，默認為false，表示不返回數據的總行數。
    },
    columnToGet: { //返回列設置RETURN_SPECIFIED表示自定義返回列，RETURN_ALL表示返回所有列，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翻頁后的排序方式和上一次請求的一致，無論是系統默認使用IndexSort還是自定義排序，因此設置了token不能再設置Sort。另外使用token后不能設置offset，只能依次往后讀取，即無法跳頁。

/**
 * 使用token翻頁示例（同步+異步）。
 */
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"]
    }
};

/**
 * 使用token翻頁示例（同步）。
 */
(async () => { //同步示例代碼。
  try {
    var data = await client.search(params);
    console.log('success:', JSON.stringify(data, null, 2));

    while (data.nextToken && data.nextToken.length) { //當存在nextToken時，表示還有未讀取的數據。

      //token持久化。
      //1）nextToken為buffer，需轉換為base64字符串后做持久化。
      //2）持久化的base64字符串，可轉換為buffer作為參數重新使用。
      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);
  }
})()

/**
 * 使用token翻頁示例（異步）。
 */
client.search(params, function (err, data) { 
    console.log('success:', JSON.stringify(data, null, 2));

    if (data.nextToken && data.nextToken.length) {

        //token持久化。
        //1）nextToken為buffer，需轉換為base64字符串后做持久化。
        //2）持久化的base64字符串，可轉換為buffer作為參數重新使用。
        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));
        });
    }
});