在服务端对读取结果再进行一次过滤,根据过滤器(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为空。

参数

参数 说明
columnName 过滤器中参考列的名称。
columnValue 过滤器中参考列的对比值。
ComparatorType 过滤器中的算术运算符,类型详情请参见ComparatorType

算术运算符包括EQUAL(=)、NOT_EQUAL(!=)、GREATER_THAN(>)、GREATER_EQUAL(>=)、LESS_THAN(<)和LESS_EQUAL(<=)。

LogicOperator 过滤器中的逻辑运算符,类型详情请参见LogicalOperator

逻辑运算符包括NOT、AND和OR。

passIfMissing 当参考列在某行中不存在时,是否返回该行。类型为bool值,默认值为true,表示如果参考列在某行中不存在,则返回该行。

当passIfMissing设置为false时,如果参考列在某行中不存在,则不返回该行。

latestVersionOnly 当参考列存在多个版本的数据时,是否只使用最新版本的值做比较。类型为bool值,默认值为true,表示如果参考列存在多个版本的数据时,则只使用该列最新版本的值进行比较。

当latestVersionOnly设置为false时,如果参考列存在多个版本的数据时,则会使用该列的所有版本的值进行比较,此时只要有一个版本的值满足条件,就返回该行。

示例

  • 构造SingleColumnCondition。
    function getRowWithCondition() {
      //当col1=表格存储时,返回该行。当passIfMissing设置为true时,如果该列不存在,则返回该行;当passIfMissing设置为false时,如果该列不存在,则不返回该行。
      var condition = new TableStore.SingleColumnCondition('col1', '表格存储', TableStore.ComparatorType.EQUAL,true);
    
      params.columnFilter = condition;
      client.getRow(params, function (err, data) {
        if (err) {
          console.log('error:', err);
          return;
        }
        console.log('success:', data);
      });
    }
  • 构造CompositeCondition。
    function getRowWithCompositeCondition() {
      //设置过滤器,当col1 = 表格存储且col5 = 123456789时,返回该行。
      var condition = new TableStore.CompositeCondition(TableStore.LogicalOperator.AND);
      condition.addSubCondition(new TableStore.SingleColumnCondition('col1', '表格存储', TableStore.ComparatorType.EQUAL));
      condition.addSubCondition(new TableStore.SingleColumnCondition('col5', Long.fromNumber(123456789), TableStore.ComparatorType.EQUAL));
    
      params.columnFilter = condition;
      client.getRow(params, function (err, data) {
        if (err) {
          console.log('error:', err);
          return;
        }
        console.log('success:', data);
      });
    }