首碼查詢 - Tablestore

首碼查詢（PrefixQuery）是通過指定首碼條件查詢索引中的資料。

功能概述

首碼查詢主要用於尋找以特定字串開頭的資料。使用PrefixQuery功能查詢資料時，您需要指定首碼值。

目前支援用於PrefixQuery的資料類型包括Keyword、FuzzyKeyword和Text。

Keyword類型：字串基礎資料類型，在中大規模資料上執行PrefixQuery等模糊查詢的效能較差，且效能會隨著資料規模增長而下降。
FuzzyKeyword類型：專門為PrefixQuery等模糊查詢功能最佳化過的資料類型，在小、中、大規模資料上的查詢效能均會更好更穩定，且效能基本不會隨著資料規模增長而下降。
Text類型：只要Text類型欄位值分詞後的詞條中有詞條滿足首碼條件即可，但是，由於分詞存在不確定性，一般不會在Text類型上使用PrefixQuery。當前只是為了相容性才支援此方式，請謹慎使用。

介面

首碼查詢的介面為Search或者ParallelScan，具體的Query類型為PrefixQuery。

參數

參數	說明
query	設定查詢類型為PrefixQuery。
fieldName	要匹配的欄位。
prefix	首碼值。對於Text類型欄位，只要分詞後的詞條中有詞條滿足首碼條件即可。
getTotalCount	是否返回匹配的總行數，預設為false，表示不返回。返回匹配的總行數會影響查詢效能。
weight	查詢權重，用於全文檢索索引情境中的score排序。查詢時指定列的算分權重，值越大，結果中分數的值會越大。取值範圍為正浮點數。使用此參數不會影響返回的結果數，只會影響返回的結果中的分數。
tableName	資料表名稱。
indexName	多元索引名稱。
columnsToGet	是否返回所有列，包含returnAll和columns設定。 returnAll預設為false，表示不返回所有列，此時可以通過columns指定返回的列；如果未通過columns指定返回的列，則只返回主鍵列。當設定returnAll為true時，表示返回所有列。

使用方式

您可以使用控制台、命令列工具或者SDK進行首碼查詢。進行首碼查詢之前，您需要完成如下準備工作。

重要

目前基於FuzzyKeyword類型的PrefixQuery只支援使用Table StoreSDK實現。

使用阿里雲帳號或者使用具有Table Store操作許可權的RAM使用者進行操作。如果需要為RAM使用者授權Table Store操作許可權，請參見通過RAM Policy為RAM使用者授權進行配置。
使用SDK方式和命令列工具方式進行操作時，如果當前無可用AccessKey，則需要為阿里雲帳號或者RAM使用者建立AccessKey。具體操作，請參見建立AccessKey。
已建立資料表。具體操作，請參見資料表操作。
已為資料表建立多元索引。具體操作，請參見建立多元索引。
使用SDK方式進行操作時，還需要完成初始化Client。具體操作，請參見初始化OTSClient。
使用命令列工具方式進行操作前，還需要完成下載並啟動命令列工具，然後配置接入執行個體資訊並選擇要操作的表。具體操作，請參見下載命令列工具、啟動並配置接入資訊和資料表操作。

使用控制台

進入索引管理頁簽。
1. 登入Table Store控制台。
2. 在頁面上方，選擇資源群組和地區。
3. 在概覽頁面，單擊執行個體名稱或在操作列單擊執行個體管理。
4. 在執行個體詳情頁簽下的資料表列表頁簽，單擊資料表名稱或在操作列單擊索引管理。
在索引管理頁簽，單擊目標多元索引操作列的搜尋。
在查詢資料對話方塊，查詢資料。
1. 系統預設返回所有列，如需顯示指定屬性列，關閉擷取所有列並輸入需要返回的屬性列，多個屬性列之間用半形逗號（,）隔開。
  說明
  系統預設會返回資料表的主鍵列。
2. 根據需要選擇邏輯操作符為And、Or或者Not。
  當選擇邏輯操作符為And時，返回滿足指定條件的資料。當選擇邏輯操作符為Or時，如果配置了單個條件，則返回滿足指定條件的資料；如果配置了多個條件，則返回滿足任意一個條件的資料。當選擇邏輯操作符為Not時，返回不滿足指定條件的資料。
3. 選擇索引欄位，單擊添加。
4. 設定索引欄位的查詢類型為首碼查詢（PrefixQuery）和輸入要查詢的值。
5. 系統預設關閉排序功能，如需根據指定欄位對返回結果進行排序，開啟是否排序開關後，根據需要添加要進行排序的欄位並配置排序方式。
6. 系統預設關閉統計功能，如需對指定欄位進行資料統計，開啟是否統計開關後，根據需要添加要進行統計的欄位和配置統計資訊。
單擊確定。
符合查詢條件的資料會顯示在索引管理頁簽中。

使用命令列工具

通過命令列工具執行search命令使用多元索引查詢資料。更多資訊，請參見多元索引。

重要

目前命令列工具僅支援Keyword類型的PrefixQuery，不支援FuzzyKeyword類型。

執行search命令使用search_index多元索引查詢表中資料，並返回所有建立索引的列。
```
search -n search_index --return_all_indexed
```

根據系統提示輸入查詢條件，樣本如下：

{
    "Offset": -1,
    "Limit": 10,
    "Collapse": null,
    "Sort": null,
    "GetTotalCount": true,
    "Token": null,
    "Query": {
        "Name": "PrefixQuery",
        "Query": {
            "FieldName": "col_keyword",
            "Prefix": "hangzhou"
        }
    }
}

使用SDK

您可以通過Java SDK、Go SDK、Python SDK、Node.js SDK、.NET SDK和PHP SDK使用首碼查詢。此處以Java SDK為例介紹首碼查詢的使用。

說明

實際使用時，不論是Keyword類型還是FuzzyKeyword類型，查詢語句是完全相同的，只是查詢列的類型不同。

以下樣本用於查詢表中Col_Keyword列的值中首碼為"hangzhou"的資料。

/**
 * 查詢表中Col_Keyword列中首碼為"hangzhou"的資料。
 * @param client
 */
private static void prefixQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    PrefixQuery prefixQuery = new PrefixQuery(); //設定查詢類型為PrefixQuery。
    searchQuery.setGetTotalCount(true);
    prefixQuery.setFieldName("Col_Keyword");
    prefixQuery.setPrefix("hangzhou");
    searchQuery.setQuery(prefixQuery);
    //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());
}

計費說明

使用多元索引查詢資料時會消耗讀輸送量。更多資訊，請參見多元索引計量計費。

Tablestore：首碼查詢

功能概述

介面

參數

使用方式

計費說明

常見問題

相關文檔