全部產品
Search
文件中心

:匹配查詢

更新時間:Jul 03, 2024

MatchQuery採用近似匹配的方式查詢表中的資料。Table Store會先對Text類型的列值和查詢關鍵詞按照設定好的分詞器做切分,然後按照切分好後的詞去查詢。對於使用模糊分詞的Text類型的列,建議使用MatchPhraseQuery實現高效能的模糊查詢。

前提條件

參數

參數

說明

field_name

要匹配的列。

匹配查詢可應用於Text類型。

text

查詢關鍵詞,即要匹配的值。

當要匹配的列為Text類型時,查詢關鍵詞會被分詞成多個詞,分詞類型為建立多元索引時設定的分詞器類型。如果建立多元索引時未設定分詞器類型,則預設分詞類型為單字分詞。

例如當要匹配的列為Text類型時,分詞類型為單字分詞,則查詢詞為"this is",可以匹配到“...,this is tablestore”、“is this tablestore”、“tablestore is cool”、“this"、“is”等。

query

設定查詢類型為MatchQuery。

table_name

資料表名稱。

index_name

多元索引名稱。

limit

本次查詢需要返回的最大數量。

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

operator

邏輯運算子。預設為OR,表示當分詞後的多個詞只要有部分匹配時,則行資料滿足查詢條件。

如果設定operator為AND,則只有分詞後的所有詞都在列值中時,才表示行資料滿足查詢條件。

minimum_should_match

最小匹配個數。

只有當某一行資料的field_name列的值中至少包括最小匹配個數的詞時,才會返回該行資料。

說明

minimum_should_match需要與邏輯運算子OR配合使用。

get_total_count

是否返回匹配的總行數,預設為False,表示不返回。

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

columns_to_get

是否返回所有列。

  • 當設定return_type為ColumnReturnType.SPECIFIED時,可以通過column_names指定返回的列。

  • 當設定return_type為ColumnReturnType.ALL時,表示返回所有列。

  • 當設定return_type為ColumnReturnType.NONE時,表示不返回所有列,只返回主鍵列。

樣本

以下樣本用於查詢表中Col_Keyword列的值近似匹配'this is'的資料。

  • 5.2.1及之後版本

    使用5.2.1及之後的SDK版本時,預設的返回結果為SearchResponse對象,請求樣本如下:

    query = MatchQuery('Col_Keyword', 'this is')
    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類型結果,您可以使用如下請求樣本實現。

    query = MatchQuery('Col_Keyword', 'this is')
    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之前版本

    使用5.2.1之前的SDK版本時,預設的返回結果為Tuple類型,請求樣本如下:

    query = MatchQuery('Col_Keyword', 'this is')
    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)
    )

常見問題

相關文檔