當資料查詢的結果中含有某種類型的資料較多時，可以使用摺疊（Collapse）功能按照某一列對結果集做摺疊，使對應類型的資料在結果展示中只出現一次，保證結果展示中類型的多樣性。

前提條件

  • 已初始化Client。具體操作，請參見初始化。
  • 已建立資料表並寫入資料。
  • 已在資料表上建立多元索引。具體操作，請參見建立多元索引。

注意事項

  • 摺疊功能只能使用offset+limit方式翻頁，不能使用token方式。
  • 對結果集同時使用統計彙總與摺疊功能時，統計彙總功能只作用於使用摺疊功能前的結果集。
  • 使用摺疊功能後，返回的總分組數取決於offset+limit的最大值，目前支援返回的總分組數最大為50000。
  • 執行結果中返回的總行數是使用摺疊功能前的匹配行數，使用摺疊功能後的總分組數無法擷取。

參數

參數說明
query任意Query類型。
collapse摺疊參數設定，包含fieldName設定。

fieldName：列名，按該列對結果集做摺疊，只支援應用於整型、浮點數和Keyword類型的列，不支援數群組類型的列。

offset本次查詢的開始位置。
limit本次查詢需要返回的最大數量。

如果只為了擷取行數，無需具體資料，可以設定limit=0，即不返回任意一行資料。

getTotalCount是否返回匹配的總行數，預設為false，表示不返回。

返回匹配的總行數會影響查詢效能。

tableName資料表名稱。
indexName多元索引名稱。
columnsToGet是否返回所有列。
  • 當設定returnType為TableStore.ColumnReturnType.RETURN_SPECIFIED時，需要通過returnNames指定返回的列。
  • 當設定returnType為TableStore.ColumnReturnType.RETURN_ALL時，表示返回所有列。
  • 當設定returnType為TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX時，表示返回多元索引中的所有列。.
  • 當設定returnType為TableStore.ColumnReturnType.RETURN_NONE時，表示不返回所有列，只返回主鍵列。

樣本

let searchQuery = {
    offset: 0,
    limit: 100,
    query: {
        queryType: TableStore.QueryType.MATCH_ALL_QUERY,
    },
    collapse: {
        fieldName: "col_keyword",
    },
    getTotalCount: false,
};
let params = {
    tableName: tableName,
    indexName: indexName,
    searchQuery: searchQuery,
    columnToGet: { //返回列設定，可設定為RETURN_SPECIFIED（自訂返回列）、RETURN_ALL（返回所有列）、RETURN_ALL_FROM_INDEX（返回多元索引中的所有列）、RETURN_NONE（不返回）。
        returnType: TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX
    },
    timeoutMs: 30000,
}
client.search(params, function (err, data) {
    if (err) {
        console.log('search error:', err.toString());
    } else {
        console.log('search success:', data);
    }
});