前提條件
已初始化OTSClient。具體操作,請參見初始化Tablestore Client。
已在資料表上建立多元索引。具體操作,請參見建立多元索引。
參數
|
參數 |
說明 |
|
query_type |
查詢類型,設定為 TermQuery。 |
|
field_name |
要查詢的欄位名稱。 |
|
term |
精確匹配的關鍵字。該關鍵字不會被分詞,以完整詞條進行匹配。 對於 TEXT 類型欄位,Tablestore 會對欄位值進行分詞,並將每個詞條與關鍵字逐一比對,任意詞條匹配則返回該行。 例如,某 TEXT 欄位的值為"tablestore is cool",分詞後得到"tablestore"、"is"、"cool"三個詞條,查詢"tablestore"、"is"或"cool"時均可命中該行。 |
|
table_name |
資料表名稱。 |
|
index_name |
多元索引名稱。 |
|
limit |
本次查詢返回的最大行數。 如果只需擷取匹配行數而不需要實際資料,將 limit 設定為 0。 |
|
get_total_count |
是否返回匹配的總行數,預設為 False。 開啟後會降低查詢效能。 |
|
columns_to_get |
指定每行返回的列,通過 return_type 和 column_names 配置。
|
樣本
以下樣本查詢 Col_Keyword 列精確匹配"tablestore"的資料行。
-
5.2.1 及之後版本
SDK for Python V5.2.1 及之後版本預設返回 SearchResponse 對象,樣本如下:
query = TermQuery('Col_Keyword', 'tablestore') search_response = client.search( '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', SearchQuery(query, limit=100, get_total_count=True), ColumnsToGet(return_type=ColumnReturnType.ALL) ) print('request_id : %s' % search_response.request_id) print('is_all_succeed : %s' % search_response.is_all_succeed) print('total_count : %s' % search_response.total_count) print('rows : %s' % search_response.rows) # # 當需要進行深度翻頁時,推薦使用next_token進行翻頁(翻頁深度無限制) # all_rows = [] # next_token = None # # first round # search_response = client.search( # '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', # SearchQuery(query, next_token=next_token, limit=100, get_total_count=True), # columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL)) # all_rows.extend(search_response.rows) # # # loop # while search_response.next_token: # search_response = client.search( # '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', # SearchQuery(query, next_token=search_response.next_token, limit=100, get_total_count=True), # columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL)) # all_rows.extend(search_response.rows) # print('Total rows:%s' % len(all_rows))如需返回 Tuple 類型結果,調用
.v1_response()方法:query = TermQuery('Col_Keyword', 'tablestore') rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search( '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', SearchQuery(query, limit=100, get_total_count=True), ColumnsToGet(return_type=ColumnReturnType.ALL) ).v1_response() -
5.2.1 之前版本
SDK for Python V5.2.1 之前版本預設返回 Tuple 類型結果,樣本如下:
query = TermQuery('Col_Keyword', 'tablestore') rows, next_token, total_count, is_all_succeed = client.search( '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', SearchQuery(query, limit=100, get_total_count=True), ColumnsToGet(return_type=ColumnReturnType.ALL) )