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

前提條件

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

注意事項

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

參數

參數說明
query可以是任意Query類型。
collapse摺疊參數設定，包含field_name設定。

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

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

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

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

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

table_name資料表名稱。
index_name多元索引名稱。
columns_to_get是否返回所有列，包含return_type和column_names設定。
  • 當設定return_type為ColumnReturnType.SPECIFIED時，可以通過column_names指定返回的列。
  • 當設定return_type為ColumnReturnType.ALL時，表示返回所有列。
  • 當設定return_type為ColumnReturnType.NONE時，表示不返回所有列，只返回主鍵列。

樣本

# 構造查詢條件，返回price為1000的所有商品。
query = TermQuery('price', 1000)

# 根據"product_name"列對結果集做摺疊。
collapse = Collapse('product_name')
search_response = client.search(table_name, index_name,
                                SearchQuery(query, limit=100, get_total_count = False, collapse_field = collapse),
                                columns_to_get = ColumnsToGet(return_type = ColumnReturnType.ALL_FROM_INDEX))