在服务端对读取结果再进行一次过滤,根据过滤器(Filter)中的条件决定返回的行。使用过滤器后,只返回符合条件的数据行。
前提条件
- 已初始化Client。具体操作,请参见初始化OTSClient。 
- 已创建数据表并写入数据。 
使用方法
在通过GetRow、BatchGetRow或GetRange接口查询数据时,可以使用过滤器只返回符合条件的数据行。
过滤器目前包括SingleColumnValueFilter和CompositeColumnValueFilter。
- SingleColumnValueFilter:只判断某个参考列的列值。 
- CompositeColumnValueFilter:根据多个参考列的列值的判断结果进行逻辑组合,决定是否过滤某行。 
关于过滤器的更多信息,请参见功能介绍中的过滤器。
注意事项
- 过滤器的条件支持关系运算(=、!=、>、>=、<、<=)和逻辑运算(NOT、AND、OR),最多支持10个条件的组合。 
- 过滤器中的参考列必须在读取的结果内。如果指定的要读取的列中不包含参考列,则过滤器无法获取参考列的值。 
- 使用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,分别用 | 
| FilterIfMissing | 否 | 当参考列在某行中不存在时,是否返回该行。类型为bool值。取值范围如下: 
 | 
| LatestVersionOnly | 否 | 当参考列存在多个版本的数据时,是否只使用最新版本的值做比较。类型为bool值。取值范围如下: 
 | 
示例
使用SingleColumnValueFilter过滤数据
以下示例用于读取数据表中的一行数据,设置读取最新版本的数据,并根据c1列的值过滤数据。
func GetRowWithFilter(client *tablestore.TableStoreClient, tableName string) {
    fmt.Println("begin to get row")
    pk := new(tablestore.PrimaryKey)
    pk.AddPrimaryKeyColumn("pk1", "pk1value1")
    pk.AddPrimaryKeyColumn("pk2", int64(2))
    pk.AddPrimaryKeyColumn("pk3", []byte("pk3"))
    //设置条件为c1列值等于浙江,并且设置FilterIfMissing为false。
    condition := tablestore.NewSingleColumnCondition("c1", tablestore.ComparatorType(tablestore.CT_EQUAL), "浙江")
    condition.FilterIfMissing = false
    criteria := &tablestore.SingleRowQueryCriteria{
        TableName:     tableName,
        PrimaryKey:    pk,
        MaxVersion:    1,
        Filter:        condition,
    }
    getResp, err := client.GetRow(&tablestore.GetRowRequest{SingleRowQueryCriteria: criteria})
    if err != nil {
        fmt.Println("getrow failed with error:", err)
    } else {
        colMap := getResp.GetColumnMap()
        if len(colMap.Columns) > 0 {
            fmt.Println("length is ", len(colMap.Columns))
            fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
        } else {
            fmt.Println("No data that meets the conditions.")
        }
    }
}使用CompositeColumnValueFilter过滤数据
以下示例用于读取数据表中的一行数据,当c1列值等于浙江且c2列值等于杭州时返回该行数据。
func GetRowWithCompositeColumnValueFilter(client *tablestore.TableStoreClient, tableName string) {
    fmt.Println("begin to get row")
    pk := new(tablestore.PrimaryKey)
    pk.AddPrimaryKeyColumn("pk1", "pk1value1")
    pk.AddPrimaryKeyColumn("pk2", int64(2))
    pk.AddPrimaryKeyColumn("pk3", []byte("pk3"))
    //设置条件为c1列值等于浙江且c2列值等于杭州。
    filter := tablestore.NewCompositeColumnCondition(tablestore.LO_AND)
    filter1 := tablestore.NewSingleColumnCondition("c1", tablestore.CT_EQUAL, "浙江")
    filter2 := tablestore.NewSingleColumnCondition("c2", tablestore.CT_EQUAL, "杭州")
    filter.AddFilter(filter2)
    filter.AddFilter(filter1)
    criteria := &tablestore.SingleRowQueryCriteria{
        TableName:  tableName,
        PrimaryKey: pk,
        MaxVersion: 1,
        Filter:     filter,
    }
    getResp, err := client.GetRow(&tablestore.GetRowRequest{SingleRowQueryCriteria: criteria})
    if err != nil {
        fmt.Println("getrow failed with error:", err)
    } else {
        colMap := getResp.GetColumnMap()
        if len(colMap.Columns) > 0 {
            fmt.Println("length is ", len(colMap.Columns))
            fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
        } else {
            fmt.Println("No data that meets the conditions.")
        }
    }
}