在服務端對讀取結果再進行一次過濾,根據過濾器(Filter)中的條件決定返回的行。使用過濾器後,只返回合格資料行。

前提條件

  • 已初始化Client,詳情請參見初始化
  • 已建立資料表並寫入資料。

使用方法

在通過GetRow、BatchGetRow或GetRange介面查詢資料時,可以使用過濾器只返回合格資料行。

過濾器目前包括SingleColumnCondition和CompositeColumnCondition。

  • SingleColumnCondition:只判斷某個參考列的列值。
  • CompositeColumnCondition:根據多個參考列的列值的判斷結果進行邏輯組合,決定是否過濾某行。

限制

  • 過濾器的條件支援關係運算(=、!=、>、>=、<、<=)和邏輯運算(NOT、AND、OR),最多支援10個條件的組合。
  • 過濾器中的參考列必須在讀取的結果內。如果指定的要讀取的列中不包含參考列,則過濾器無法擷取參考列的值。
  • 在GetRow、BatchGetRow和GetRange介面中使用過濾器不會改變介面的原生語義和限制項。

    使用GetRange介面時,一次掃描資料的行數不能超過5000行或者資料大小不能超過4 MB。

    當在該次掃描的5000行或者4 MB資料中沒有滿足過濾器條件的資料時,得到的Response中的Rows為空白,但是next_start_primary_key可能不為空白,此時需要使用next_start_primary_key繼續讀取資料,直到next_start_primary_key為空白。

參數

參數 說明
column_name 過濾器中參考列的名稱。
column_value 過濾器中參考列的對比值。
ComparatorType 過濾器中的關係運算子,類型詳情請參見ComparatorType

關係運算子包括EQUAL(=)、NOT_EQUAL(!=)、GREATER_THAN(>)、GREATER_EQUAL(>=)、LESS_THAN(<)和LESS_EQUAL(<=)。

LogicOperator 過濾器中的邏輯運算子,類型詳情請參見LogicalOperator

邏輯運算子包括NOT、AND和OR。

pass_if_missing 當參考列在某行中不存在時,是否返回該行。類型為bool值,預設值為True,表示如果參考列在某行中不存在,則返回該行。

當設定pass_if_missing為False時,如果參考列在某行中不存在,則不返回該行。

latest_version_only 當參考列存在多個版本的資料時,是否只使用最新版本的值做比較。類型為bool值,預設值為True,表示如果參考列存在多個版本的資料時,則只使用該列最新版本的值進行比較。

當設定latest_version_only為False時,如果參考列存在多個版本的資料時,則會使用該列的所有版本的值進行比較,此時只要有一個版本的值滿足條件,就返回該行。

樣本

  • 構造SingleColumnCondition。
    def get_row_with_condition(client):
        primary_key = [('uid',1), ('gid',101)]
        columns_to_get = [] # 設定需要返回的列。如果不設定,則表示返回所有列。
        //設定過濾器,當name的值為'杭州'時,返回該行。
        cond = SingleColumnCondition("name", '杭州', ComparatorType.EQUAL, pass_if_missing = True)
        consumed, return_row, next_token = client.get_row(table_name, primary_key, columns_to_get, cond, 1)
    
        print ('Read succeed, consume %s read cu.' % consumed.read)
    
        print ('Value of primary key: %s' % return_row.primary_key)
        print ('Value of attribute: %s' % return_row.attribute_columns)
        for att in return_row.attribute_columns:
            print ('name:%s\tvalue:%s\ttimestamp:%d' % (att[0], att[1], att[2]))
  • 構造CompositeColumnCondition。
    def get_row_with_composite_condition(client):
        primary_key = [('uid',1), ('gid',101)]
        columns_to_get = [] # given a list of columns to get, or empty list if you want to get entire row.
        //設定條件為(growth == 0.9) AND (name == '杭州')。
        cond = CompositeColumnCondition(LogicalOperator.AND)
        cond.add_sub_condition(SingleColumnCondition("growth", 0.9, ComparatorType.EQUAL))
        cond.add_sub_condition(SingleColumnCondition("name", '杭州', ComparatorType.EQUAL))
    
        consumed, return_row, next_token = client.get_row(table_name, primary_key, columns_to_get, cond, 1)
    
        print ('Read succeed, consume %s read cu.' % consumed.read)
    
        print ('Value of primary key: %s' % return_row.primary_key)
        print ('Value of attribute: %s' % return_row.attribute_columns)
        for att in return_row.attribute_columns:
            print ('name:%s\tvalue:%s\ttimestamp:%d' % (att[0], att[1], att[2]))