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

前提条件

  • 已初始化Client,详情请参见初始化
  • 已创建数据表并写入数据。

使用方法

在通过GetRow、BatchGetRow或GetRange接口查询数据时,可以使用过滤器只返回符合条件的数据行。

过滤器目前包括RelationalCondition和CompositeCondition。

  • RelationalCondition:只判断某个参考列的列值。
  • CompositeCondition:根据多个参考列的列值的判断结果进行逻辑组合,决定是否过滤某行。

限制

  • 过滤器的条件支持关系运算(=、!=、>、>=、<、<=)和逻辑运算(NOT、AND、OR),最多支持10个条件的组合。
  • 过滤器中的参考列必须在读取的结果内。如果指定的要读取的列中不包含参考列,则过滤器无法获取参考列的值。
  • 在GetRow、BatchGetRow和GetRange接口中使用过滤器不会改变接口的原生语义和限制项。

    使用GetRange接口时,一次扫描数据的行数不能超过5000行或者数据大小不能超过4 MB。

    当在该次扫描的5000行或者4 MB数据中没有满足过滤器条件的数据时,得到的Response中的Rows为空,但是nextStartPrimaryKey可能不为空,此时需要使用nextStartPrimaryKey继续读取数据,直到nextStartPrimaryKey为空。

参数

参数 说明
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时,如果参考列在某行中不存在,则不返回该行。

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

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

示例

  • 构造RelationalCondition。
    public void GetRowWithRelationalCondition(OTSClient otsClient)
    {
        //定义行的主键,必须与创建表时的TableMeta中定义的一致。
        PrimaryKey primaryKey = new PrimaryKey
        {
            { "pk0", new ColumnValue(0) },
            { "pk1", new ColumnValue("abc") }
        };
    
        var rowQueryCriteria = new SingleRowQueryCriteria(TableName)
        {
            RowPrimaryKey = primaryKey
        };
    
        //只返回col0的值等于5的行。
        var filter = new RelationalCondition("col0",CompareOperator.EQUAL,new ColumnValue(5))
        {
            PassIfMissing = true
        };
    
        rowQueryCriteria.Filter = filter.ToFilter();
        rowQueryCriteria.AddColumnsToGet("col0");
        rowQueryCriteria.AddColumnsToGet("col1");
    
        GetRowRequest request = new GetRowRequest(rowQueryCriteria); 
    
        //查询。
        GetRowResponse response = otsClient.GetRow(request);
        PrimaryKey primaryKeyRead = response.PrimaryKey;
        AttributeColumns attributesRead = response.Attribute;
    
        Console.WriteLine("Primary key read: ");
        foreach (KeyValuePair<string, ColumnValue> entry in primaryKeyRead)
        {
            Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
        }
    
        Console.WriteLine("Attributes read: ");
        foreach (KeyValuePair<string, ColumnValue> entry in attributesRead)
        {
            Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
        }
    
        Console.WriteLine("Get row with filter succeed.");
    }
  • 构造CompositeCondition。
    public void GetRowWithCompositeCondition(OTSClient otsClient)
    {
        //定义行的主键,必须与创建表时的TableMeta中定义的一致。
        PrimaryKey primaryKey = new PrimaryKey
        {
            { "pk0", new ColumnValue(0) },
            { "pk1", new ColumnValue("abc") }
        };
    
        var rowQueryCriteria = new SingleRowQueryCriteria(TableName)
        {
            RowPrimaryKey = primaryKey
            };
    
        //只返回col0的值等于5的行或者col1不等于ff的行。
        var filter1 = new RelationalCondition("col0",
                                              CompareOperator.EQUAL,
                                              new ColumnValue(5));
    
        var filter2 = new RelationalCondition("col1", CompareOperator.NOT_EQUAL, new ColumnValue("ff"));
    
        var filter = new CompositeCondition(LogicOperator.OR);
        filter.AddCondition(filter1);
        filter.AddCondition(filter2);
    
        rowQueryCriteria.Filter = filter.ToFilter();
        rowQueryCriteria.AddColumnsToGet("col0");
        rowQueryCriteria.AddColumnsToGet("col1");
    
        GetRowRequest request = new GetRowRequest(rowQueryCriteria); 
    
        //查询。
        GetRowResponse response = otsClient.GetRow(request);
        PrimaryKey primaryKeyRead = response.PrimaryKey;
        AttributeColumns attributesRead = response.Attribute;
    
        Console.WriteLine("Primary key read: ");
        foreach (KeyValuePair<string, ColumnValue> entry in primaryKeyRead)
        {
            Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
        }
    
        Console.WriteLine("Attributes read: ");
        foreach (KeyValuePair<string, ColumnValue> entry in attributesRead)
        {
            Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
        }
    
        Console.WriteLine("Get row with filter succeed.");
    }