edit-icon download-icon

SingleColumnValueFilter

Last Updated: Mar 23, 2018

SingleColumnValueFilter specifies a single condition, for example, column_a > 5. It is applicable to the ConditionUpdate and Filter functions.

Data structure

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

comparator:

column_name:

  • Type: String

  • The column name.

column_value:

  • Type: Bytes

  • The value of the column after being encoded in Plainbuffer format.

filter_if_missing:

  • Type: Bool

  • Determines whether the condition is filtered if the column of a row does not exist. For example, the condition is column_a > 0, and the value of filter_if_missing is true. If column_a does not exist for a row, the condition column_a > 0 is true.

latest_version_only:

  • Type: Bool

  • Determines whether the condition is valid only for the latest version. If the value is true, the value of the latest version is checked if it meets the condition. If the value is false, the values of all versions are checked if they meet the conditions.

ConditionUpdate

PutRow

UpdateRow

DeleteRow

BatchWriteRow

Filter

GetRow

GetRange

BatchGetRow

Thank you! We've received your feedback.