文档

过滤器

更新时间:

在服务端对读取结果再进行一次过滤,根据过滤器(Filter)中的条件决定返回的行。使用过滤器后,只返回符合条件的数据行。

前提条件

  • 已初始化Client。具体操作,请参见初始化OTSClient

  • 已创建数据表并写入数据。

使用方法

在通过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过滤数据

以下示例用于读取数据表中的一行数据,设置读取最新版本的数据以及根据name列值过滤数据。

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('Sampletable', 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过滤数据

以下示例用于读取数据表中的一行数据,设置根据growth列值和name列值的组合条件过滤数据。

def get_row_with_composite_condition(client):
    #设置要读取行的主键。
    primary_key = [('uid',1), ('gid',101)]
    #设置需要返回的列。如果不设置,则表示返回所有列。
    columns_to_get = [] 
    #设置条件为(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('Sampletable', 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]))

相关文档

  • 当某些应用需要使用不同属性作为查询条件来执行数据查询时,您可以通过将这些属性作为二级索引的主键列实现按照属性快速查询数据的需求。更多信息,请参见二级索引

  • 当日常业务中有非主键列查询、多列组合查询、模糊查询等多维查询需求以及求最值、统计行数、数据分组等数据分析需求时,您可以将这些属性作为多元索引中的字段并使用多元索引查询与分析数据。 更多信息,请参见多元索引

  • 本页导读 (1)