Class ColumnRangeFilter (2.10.1)

ColumnRangeFilter(
    column_family_id,
    start_column=None,
    end_column=None,
    inclusive_start=None,
    inclusive_end=None,
)

A row filter to restrict to a range of columns.

Both the start and end column can be included or excluded in the range. By default, we include them both, but this can be changed with optional flags.

Parameters

NameDescription
column_family_id str

The column family that contains the columns. Must be of the form `_a-zA-Z0-9][-_.a-zA-Z0-9]`*.

start_column bytes

The start of the range of columns. If no value is used, the backend applies no upper bound to the values.

end_column bytes

The end of the range of columns. If no value is used, the backend applies no upper bound to the values.

inclusive_start bool

Boolean indicating if the start column should be included in the range (or excluded). Defaults to :data:True if start_column is passed and no inclusive_start was given.

inclusive_end bool

Boolean indicating if the end column should be included in the range (or excluded). Defaults to :data:True if end_column is passed and no inclusive_end was given.

Inheritance

builtins.object > RowFilter > ColumnRangeFilter

Methods

to_pb

to_pb()

Converts the row filter to a protobuf.

First converts to a .data_v2_pb2.ColumnRange and then uses it in the column_range_filter field.

Returns
TypeDescription
`.data_v2_pb2.RowFilter`The converted current object.