使用多元索引查詢資料時,通過預先定義排序方式或者查詢時指定排序方式,您可以按照指定相片順序擷取到返回資料。當返回結果行數較多時,通過使用跳轉翻頁或者連續翻頁可以快速定位到所需資料。
使用情境
分類 | 使用方式 | 功能 | 使用情境 |
排序 | 建立時指定排序方式 | 多元索引預設按照設定的索引預排序(IndexSort)方式進行排序,用於確定資料的預設返回順序。 | |
查詢時指定排序方式 | 按照查詢結果的相關性(BM25演算法)分數進行排序,適用於有相關性的情境,例如全文檢索索引等。 | ||
按照主鍵進行排序,適用於按照事物標識排序的情境。 | |||
按照欄位值進行排序,適用於電商、社交媒資等按照事物屬性排序的情境,例如商品銷量、瀏覽量等。 | |||
根據地理點距離進行排序,適用於地圖、物流等按照距離排序事物的情境,例如某個位置周邊餐廳按距離排序等。 | |||
翻頁 | 查詢時指定翻頁方式 | 返回結果行數小於50000行時用於跳轉翻頁。 | |
用於連續翻頁,預設只能向後翻頁。由於在一次查詢的翻頁過程中token長期有效,您可以通過緩衝並使用之前的token實現向前翻頁。 |
索引預排序
多元索引預設按照設定的索引預排序(IndexSort)方式進行排序,使用多元索引查詢資料時,IndexSort決定了資料的預設返回順序。
在建立多元索引時,您可以自訂IndexSort,如果未自訂IndexSort,則IndexSort預設為主鍵排序。
索引預排序只支援PrimaryKeySort (按照主鍵排序)和FieldSort(按照欄位值排序)兩種方式。
含有Nested類型欄位的多元索引不支援索引預排序。
建立多元索引後,如果要修改多元索引的IndexSort,您可以使用動態修改schema功能實現。具體操作,請參見動態修改schema。
查詢時排序
只有enableSortAndAgg設定為true的欄位才能進行排序。
在每次查詢時,可以指定排序方式,多元索引支援如下四種排序方式(Sorter)。您也可以使用多個Sorter,實現先按照某種方式排序,再按照另一種方式排序的需求。
ScoreSort
按照查詢結果的相關性(BM25演算法)分數進行排序,適用於有相關性的情境,例如全文檢索索引等。
如果需要按照相關性打分進行排序,必須手動設定ScoreSort,否則會按照索引設定的IndexSort進行排序。
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翻頁
當需要擷取的返回結果行數小於50000行時,可以使用limit和offset進行翻頁,即limit+offset<=50000,其中limit的最大值為100。
如果需要提高limit的上限,請參見如何將多元索引Search介面查詢資料的limit提高到1000。
如果使用此方式進行翻頁時未設定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實現向前翻頁。
如果需要持久化NextToken或者傳輸NextToken給前端頁面,您可以使用Base64編碼將NextToken編碼為String進行儲存和傳輸。Token本身不是字串,直接使用string(NextToken)
將Token編碼為String會造成Token資訊丟失。
使用token翻頁後的排序方式和上一次請求的一致,無論是系統預設使用IndexSort還是自訂排序,因此設定了token不能再設定Sort。另外使用token後不能設定offset,只能依次往後讀取,即無法跳頁。
由於含有Nested類型欄位的多元索引不支援索引預排序,如果使用含有Nested類型欄位的多元索引查詢資料且需要翻頁,則必須在查詢條件中指定資料返回的排序方式,否則當符合查詢條件的資料未讀取完時,服務端不會返回nextToken。
/**
* 使用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));
});
}
});