全部產品
Search
文件中心

:範圍查詢

更新時間:Jul 03, 2024

RangeQuery根據範圍條件查詢表中的資料。對於Text類型欄位,只要Text類型欄位值分詞後的詞條中有詞條滿足範圍條件即可。

前提條件

參數

參數

說明

field_name

要匹配的欄位。

range_from

起始位置的值。

range_to

結束位置的值。

include_lower

結果中是否需要包括range_from值,類型為Boolean。

include_upper

結果中是否需要包括range_to值,類型為Boolean。

table_name

資料表名稱。

index_name

多元索引名稱。

query

設定查詢類型為RangeQuery。

limit

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

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

get_total_count

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

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

columns_to_get

是否返回所有列,包含return_type和column_names設定。

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

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

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

樣本

以下樣本用於查詢表中Col_Keyword列的值在'key100'到'key200'之間的資料。

  • 5.2.1及之後版本

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

    query = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
    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 = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
    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 = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
    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)
    )

常見問題

相關文檔