參數
參數 | 說明 |
fieldName | 要匹配的欄位。 |
from | 起始位置的值。 設定範圍條件時,大於(>)可以使用greaterThan表示,大於等於(>=)可以使用greaterThanOrEqual表示。 |
to | 結束位置的值。 設定範圍條件時,小於(<)可以使用lessThan表示;小於等於(<=)可以使用lessThanOrEqual表示。 |
includeLower | 結果中是否需要包括from值,類型為Boolean。 |
includeUpper | 結果中是否需要包括to值,類型為Boolean。 |
query | 設定查詢類型為RangeQuery。 |
sort | 按照指定方式排序,詳情請參見排序和翻頁。 |
getTotalCount | 是否返回匹配的總行數,預設為false,表示不返回。 返回匹配的總行數會影響查詢效能。 |
tableName | 資料表名稱。 |
indexName | 多元索引名稱。 |
columnsToGet | 是否返回所有列,包含returnAll和columns設定。 returnAll預設為false,表示不返回所有列,此時可以通過columns指定返回的列;如果未通過columns指定返回的列,則只返回主鍵列。 當設定returnAll為true時,表示返回所有列。 |
使用方式
您可以使用控制台、命令列工具或者SDK進行範圍查詢。進行範圍查詢之前,您需要完成如下準備工作。
使用阿里雲帳號或者使用具有Table Store操作許可權的RAM使用者進行操作。如果需要為RAM使用者授權Table Store操作許可權,請參見通過RAM Policy為RAM使用者授權進行配置。
使用SDK方式和命令列工具方式進行操作時,如果當前無可用AccessKey,則需要為阿里雲帳號或者RAM使用者建立AccessKey。具體操作,請參見建立AccessKey。
已建立資料表。具體操作,請參見資料表操作。
已為資料表建立多元索引。具體操作,請參見建立多元索引。
使用SDK方式進行操作時,還需要完成初始化Client。具體操作,請參見初始化OTSClient。
使用命令列工具方式進行操作前,還需要完成下載並啟動命令列工具,然後配置接入執行個體資訊並選擇要操作的表。具體操作,請參見下載命令列工具、啟動並配置和資料表操作。
使用控制台
進入索引管理頁簽。
登入Table Store控制台。
在頁面上方,選擇資源群組和地區。
在概覽頁面,單擊執行個體名稱或在操作列單擊執行個體管理。
在執行個體詳情頁簽下的資料表列表頁簽,單擊資料表名稱或在操作列單擊索引管理。
在索引管理頁簽,單擊目標多元索引操作列的搜尋。
在查詢資料對話方塊,查詢資料。
系統預設返回所有列,如需顯示指定屬性列,關閉擷取所有列並輸入需要返回的屬性列,多個屬性列之間用半形逗號(,)隔開。
根據需要選擇邏輯操作符為And、Or或者Not。
當選擇邏輯操作符為And時,返回滿足指定條件的資料。當選擇邏輯操作符為Or時,如果配置了單個條件,則返回滿足指定條件的資料;如果配置了多個條件,則返回滿足任意一個條件的資料。當選擇邏輯操作符為Not時,返回不滿足指定條件的資料。
選擇索引欄位,單擊添加。
設定索引欄位的查詢類型為範圍查詢(RangeQuery)和輸入查詢範圍。
查詢範圍為左閉右開的區間,請根據需要配置。
系統預設關閉排序功能,如需根據指定欄位對返回結果進行排序,開啟是否排序開關後,根據需要添加要進行排序的欄位並配置排序方式。
系統預設關閉統計功能,如需對指定欄位進行資料統計,開啟是否統計開關後,根據需要添加要進行統計的欄位和配置統計資訊。
單擊確定。
符合查詢條件的資料會顯示在索引管理頁簽中。
使用命令列工具
通過命令列工具執行search
命令使用多元索引查詢資料。更多資訊,請參見多元索引。
執行search
命令使用search_index多元索引查詢表中資料,並返回所有建立索引的列。
search -n search_index --return_all_indexed
根據系統提示輸入查詢條件,樣本如下:
{
"Offset": -1,
"Limit": 10,
"Collapse": null,
"Sort": null,
"GetTotalCount": true,
"Token": null,
"Query": {
"Name": "RangeQuery",
"Query": {
"FieldName": "col_long",
"From": 1,
"To": 100,
"IncludeLower": true,
"IncludeUpper": false
}
}
}
使用SDK
您可以通過Java SDK、Go SDK、Python SDK、Node.js SDK、.NET SDK和PHP SDK使用範圍查詢。此處以Java SDK為例介紹範圍查詢的使用。
以下樣本用於查詢表中Col_Long列大於3的資料,結果按照Col_Long列的值逆序排序。
/**
* 查詢表中Col_Long列大於3的資料,結果按照Col_Long列的值逆序排序。
* @param client
*/
private static void rangeQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
RangeQuery rangeQuery = new RangeQuery(); //設定查詢類型為RangeQuery。
rangeQuery.setFieldName("Col_Long"); //設定要匹配的欄位。
rangeQuery.greaterThan(ColumnValue.fromLong(3)); //設定該欄位的範圍條件為大於3。
searchQuery.setGetTotalCount(true);
searchQuery.setQuery(rangeQuery);
//設定按照Col_Long列逆序排序。
FieldSort fieldSort = new FieldSort("Col_Long");
fieldSort.setOrder(SortOrder.DESC);
searchQuery.setSort(new Sort(Arrays.asList((Sort.Sorter)fieldSort)));
//searchQuery.setGetTotalCount(true); //設定返回匹配的總行數。
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通過設定columnsToGet參數可以指定返回的列或返回所有列,如果不設定此參數,則預設只返回主鍵列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //設定為返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //設定為返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //列印匹配到的總行數,非返回行數。
System.out.println("Row: " + resp.getRows());
}
計費說明
使用多元索引查詢資料時會消耗讀輸送量。更多資訊,請參見多元索引計量計費。