Table Store Java SDK 範圍查詢 - Tablestore

前提條件

安裝Tablestore Java SDK並初始化用戶端。

功能說明

範圍查詢用於匹配欄位值處於指定區間內的資料。可以只設定下界或上界，也可以同時設定兩個邊界；至少需要設定一個邊界。對於 Text 類型欄位，只要分詞後的任一詞條處於指定區間內，該行資料即滿足查詢條件。

使用 greaterThan、greaterThanOrEqual、lessThan 和 lessThanOrEqual 方法可分別設定大於、大於等於、小於和小於等於條件。調用 search 方法時，將查詢類型設定為 RangeQuery。

SearchResponse search(SearchRequest request)

以下樣本查詢 Long 類型的 price 欄位值處於左閉右開區間 [100, 500) 內的資料，返回最多 10 行資料及匹配總行數。

String tableName = "example_table";
String indexName = "example_index";

RangeQuery rangeQuery = new RangeQuery();
rangeQuery.setFieldName("price");
rangeQuery.greaterThanOrEqual(ColumnValue.fromLong(100L));
rangeQuery.lessThan(ColumnValue.fromLong(500L));

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(rangeQuery);
searchQuery.setLimit(10);
searchQuery.setTrackTotalCount(SearchQuery.TRACK_TOTAL_COUNT);

SearchRequest request = new SearchRequest(tableName, indexName, searchQuery);
SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
columnsToGet.setReturnAll(true);
request.setColumnsToGet(columnsToGet);

SearchResponse response = client.search(request);
System.out.println(response.getTotalCount());
System.out.println(response.getRows());

參數說明

查詢請求

request 的類型為 SearchRequest，包含以下參數。

名稱	類型	說明
tableName（必選）	String	資料表名稱。
indexName（必選）	String	多元索引名稱。
searchQuery（必選）	SearchQuery	查詢條件和通用查詢配置。
columnsToGet（可選）	SearchRequest.ColumnsToGet	返回列配置。未設定時只返回主鍵列。
timeoutInMillisecond（可選）	int	請求級查詢逾時時間，單位為毫秒。預設值為 `-1`，表示不單獨設定查詢逾時時間。
routingValues（可選）	`List<PrimaryKey>`	自訂路由欄位對應的主索引值列表。未配置自訂路由時無需設定。

查詢配置

request.searchQuery 的類型為 SearchQuery，包含以下參數。

名稱	類型	說明
query（必選）	Query	查詢條件。範圍查詢設定為 `RangeQuery`。
offset（可選）	Integer	本次查詢的起始位置。
limit（可選）	Integer	本次查詢返回的最大行數。設定為 `0` 時不返回具體行。
highlight（可選）	Highlight	`Text` 欄位的摘要與高亮配置。有關配置方法，請參見摘要與高亮。
collapse（可選）	Collapse	結果摺疊配置，用於按指定列對返回結果去重。有關配置方法，請參見摺疊（去重）。
sort（可選）	Sort	返回結果的排序方式。有關配置方法，請參見排序和翻頁。
trackTotalCount（可選）	int	期望統計的最大匹配行數。預設值為 `TRACK_TOTAL_COUNT_DISABLED`，表示不統計；設定為 `TRACK_TOTAL_COUNT` 時統計全部匹配行。值越小，查詢效能越高。
filter（可選）	SearchFilter	對 `query` 的查詢結果進行過濾。
aggregationList（可選）	`List<Aggregation>`	統計彙總配置。有關配置方法，請參見統計彙總。
groupByList（可選）	`List<GroupBy>`	分組配置。有關配置方法，請參見統計彙總。
token（可選）	byte[]	翻頁憑證。將上一次響應的 `nextToken` 設定為該參數可繼續讀取後續資料。設定 `token` 時，SDK 會清除 `sort`，因為翻頁憑證中已包含排序條件。

查詢條件

request.searchQuery.query 的類型為 RangeQuery，包含以下參數。

名稱	類型	說明
fieldName（必選）	String	要查詢的索引欄位名稱。範圍查詢支援 `Long`、`Double`、`Boolean`、`Keyword`、`Text`、`Date`、`IP` 類型欄位，以及 `JSON Object` 的子欄位。對於 `Text` 欄位，任一分詞詞條處於指定區間內即匹配。
from（可選）	ColumnValue	查詢區間的下界，`from` 和 `to` 必須至少設定一個。調用 `greaterThan` 或 `greaterThanOrEqual` 可同時設定下界和是否包含下界。
to（可選）	ColumnValue	查詢區間的上界，`from` 和 `to` 必須至少設定一個。調用 `lessThan` 或 `lessThanOrEqual` 可同時設定上界和是否包含上界。
includeLower（可選）	boolean	是否包含 `from`。預設值為 `false`。`greaterThan` 將其設定為 `false`，`greaterThanOrEqual` 將其設定為 `true`。
includeUpper（可選）	boolean	是否包含 `to`。預設值為 `false`。`lessThan` 將其設定為 `false`，`lessThanOrEqual` 將其設定為 `true`。

返回列

request.columnsToGet 的類型為 SearchRequest.ColumnsToGet，包含以下參數。

名稱	類型	說明
columns（可選）	`List<String>`	要返回的屬性列名稱。僅 `returnAll` 和 `returnAllFromIndex` 均為 `false` 時需要設定；未設定時只返回主鍵列。
returnAll（可選）	boolean	是否返回資料表中的全部屬性列。預設值為 `false`。
returnAllFromIndex（可選）	boolean	是否返回已建立索引的全部屬性列。預設值為 `false`。不能與 `returnAll` 同時設定為 `true`。

傳回值

search 方法返回 SearchResponse。核心欄位如下。

名稱	類型	說明
totalCount	long	匹配行數，通過 `getTotalCount()` 擷取。傳回值取決於 `trackTotalCount` 配置。
rows	`List<Row>`	本次查詢返回的行資料，通過 `getRows()` 擷取。返回數量不超過 `limit`。
searchHits	`List<SearchHit>`	查詢命中結果，通過 `getSearchHits()` 擷取。配置 `highlight` 後，從該欄位讀取行資料和摘要與高亮結果。
nextToken	byte[]	下一頁憑證，通過 `getNextToken()` 擷取。值不為 `null` 時，將其設定到下一次請求的 `token` 中繼續讀取。
isAllSuccess	boolean	是否已成功查詢全部索引分割區，通過 `isAllSuccess()` 擷取。值為 `false` 時，返回的是部分結果，`totalCount` 可能小於實際匹配行數。

情境樣本

查詢自訂格式的日期

如果資料表中的 date_string 欄位為 String 類型，並在多元索引中映射為使用 yyyy-MM-dd HH:mm:ss 格式的 Date 類型，可使用相同格式的字串設定查詢邊界。以下樣本查詢 [2021-01-01 00:00:00, 2023-01-01 00:00:00) 內的資料。

RangeQuery rangeQuery = new RangeQuery();
rangeQuery.setFieldName("date_string");
rangeQuery.greaterThanOrEqual(ColumnValue.fromString("2021-01-01 00:00:00"));
rangeQuery.lessThan(ColumnValue.fromString("2023-01-01 00:00:00"));

查詢秒級時間戳記

如果資料表中的 date_epoch 欄位為 Integer 類型，並在多元索引中映射為使用 epoch_second 格式的 Date 類型，可使用秒級 Unix 時間戳記設定查詢邊界。以下樣本查詢值大於 1609459200 的資料。

RangeQuery rangeQuery = new RangeQuery();
rangeQuery.setFieldName("date_epoch");
rangeQuery.greaterThan(ColumnValue.fromLong(1609459200L));