SingleColumnValueFilter

Updated at:

A single filter condition, such as column_a > 5. This is used for conditional updates and filtering.

Data structure

message SingleColumnValueFilter {
    required ComparatorType comparator = 1;
    required string column_name = 2;
    required bytes column_value = 3;
    required bool filter_if_missing = 4;
    required bool latest_version_only = 5; 
    optional ValueTransferRule value_transfer_rule =6;
     
}                

Name

Type

Required

Description

comparator

ComparatorType

Yes

The relational operator.

column_name

string

Yes

The column name.

column_value

bytes

Yes

The column value marshaled in the Plainbuffer format.

filter_if_missing

bool

Yes

Specifies whether to filter the row if the column does not exist.

latest_version_only

bool

Yes

Specifies whether the filter applies only to the latest version of the column. Valid values:

  • true (default): The filter checks only the value of the latest version to see if it meets the condition.

  • false: The filter checks the values of all versions to see if they meet the condition.

value_transfer_rule

ValueTransferRule

No

Uses a regular expression to match a string and then transforms the string into the String, Integer, or Double type.

Set this parameter to filter data in a column by the value of a subfield when the column stores data in a custom format, such as a JSON formatted string.

Related operations