It is possible to use aRowFilterwhen constructing aReadRowsQuery

The following basic filtersare provided:

• SinkFilter

• PassAllFilter

• BlockAllFilter

• RowKeyRegexFilter

• RowSampleFilter

• FamilyNameRegexFilter

• ColumnQualifierRegexFilter

• TimestampRangeFilter

• ColumnRangeFilter

• ValueRegexFilter

• ValueRangeFilter

• CellsRowOffsetFilter

• CellsRowLimitFilter

• CellsColumnLimitFilter

• StripValueTransformerFilter

• ApplyLabelFilter

In addition, these filters can be combined into composite filters with

• RowFilterChain

• RowFilterUnion

• ConditionalRowFilter

These rules can be nested arbitrarily, with a basic filter at the lowestlevel. For example:

# Filter in a specified column (matching any column family).col1_filter = ColumnQualifierRegexFilter(b'columnbia')# Create a filter to label results.label1 = u'label-red'label1_filter = ApplyLabelFilter(label1)# Combine the filters to label all the cells in columnbia.chain1 = RowFilterChain(filters=[col1_filter, label1_filter])# Create a similar filter to label cells blue.col2_filter = ColumnQualifierRegexFilter(b'columnseeya')label2 = u'label-blue'label2_filter = ApplyLabelFilter(label2)chain2 = RowFilterChain(filters=[col2_filter, label2_filter])# Bring our two labeled columns together.row_filter = RowFilterUnion(filters=[chain1, chain2])

Filters for Google Cloud Bigtable Row classes.

class google.cloud.bigtable.data.row_filters.ApplyLabelFilter(label:str)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

Filter to apply labels to cells.

Intended to be used as an intermediate filter on a pre-existing filteredresult set. This way if two sets are combined, the label can tell wherethe cell(s) originated.This allows the client to determine which resultswere produced from which part of the filter.

NOTE: Due to a technical limitation of the backend, it is not currentlypossible to apply multiple labels to a cell.

• Parameters

  label (str) – Label to apply to cells in the output row. Values must be at most 15 characters long, and match the pattern[a-z0-9\\-]+.

class google.cloud.bigtable.data.row_filters.BlockAllFilter(flag:bool)

Bases:google.cloud.bigtable.data.row_filters._BoolFilter

Row filter that doesn’t match any cells.

• Parameters

  flag (bool) – Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.

class google.cloud.bigtable.data.row_filters.CellsColumnLimitFilter(num_cells:int)

Bases:google.cloud.bigtable.data.row_filters._CellCountFilter

Row filter to limit cells in a column.

• Parameters

  num_cells (int) – Matches only the most recent N cells within each column. This filters a (family name, column) pair, based on timestamps of each cell.

class google.cloud.bigtable.data.row_filters.CellsRowLimitFilter(num_cells:int)

Bases:google.cloud.bigtable.data.row_filters._CellCountFilter

Row filter to limit cells in a row.

• Parameters

  num_cells (int) – Matches only the first N cells of the row.

class google.cloud.bigtable.data.row_filters.CellsRowOffsetFilter(num_cells:int)

Bases:google.cloud.bigtable.data.row_filters._CellCountFilter

Row filter to skip cells in a row.

• Parameters

  num_cells (int) – Skips the first N cells of the row.

class google.cloud.bigtable.data.row_filters.ColumnQualifierRegexFilter(regex:str |bytes)

Bases:google.cloud.bigtable.data.row_filters._RegexFilter

Row filter for a column qualifier regular expression.

Theregex must be valid RE2 patterns. See Google’sRE2 reference for the accepted syntax.

NOTE: Special care need be used with the expression used. Sinceeach of these properties can contain arbitrary bytes, the\\Cescape sequence must be used if a true wildcard is desired. The.character will not match the new line character\\n, which may bepresent in a binary value.

• Parameters

  regex (bytes) – A regular expression (RE2) to match cells from column that match this regex (irrespective of column family).

class google.cloud.bigtable.data.row_filters.ColumnRangeFilter(family_id:str, start_qualifier:Optional[bytes] = None, end_qualifier:Optional[bytes] = None, inclusive_start:Optional[bool] = None, inclusive_end:Optional[bool] = None)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

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 optionalflags.

• Parameters

  • family_id (str) – The column family that contains the columns. Mustbe of the form[_a-zA-Z0-9][-_.a-zA-Z0-9]\*.

  • start_qualifier (bytes) – The start of the range of columns. If no value isused, the backend applies no upper bound to thevalues.

  • end_qualifier (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 beincluded in the range (or excluded). DefaultstoTrue ifstart_qualifier is passed andnoinclusive_start was given.

  • inclusive_end (bool) – Boolean indicating if the end column should beincluded in the range (or excluded). DefaultstoTrue ifend_qualifier is passed andnoinclusive_end was given.

• Raises

  ValueError ifinclusive_start is set but nostart_qualifier is given or ifinclusive_end is set but noend_qualifier is given

class google.cloud.bigtable.data.row_filters.ConditionalRowFilter(predicate_filter: google.cloud.bigtable.data.row_filters.RowFilter, true_filter:Optional[google.cloud.bigtable.data.row_filters.RowFilter] = None, false_filter:Optional[google.cloud.bigtable.data.row_filters.RowFilter] = None)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

Conditional row filter which exhibits ternary behavior.

Executes one of two filters based on another filter. If thepredicate_filterreturns any cells in the row, thentrue_filter is executed. If not,thenfalse_filter is executed.

NOTE: Thepredicate_filter does not execute atomically with the true and falsefilters, which may lead to inconsistent or unexpected results.

Additionally, executing aConditionalRowFilter has poorperformance on the server, especially whenfalse_filter is set.

• Parameters

  • predicate_filter (RowFilter) – The filter to condition on before executing thetrue/false filters.

  • true_filter (RowFilter) – (Optional) The filter to execute if there are any cellsmatchingpredicate_filter. If not provided, no resultswill be returned in the true case.

  • false_filter (RowFilter) – (Optional) The filter to execute if there are no cellsmatchingpredicate_filter. If not provided, no resultswill be returned in the false case.

class google.cloud.bigtable.data.row_filters.FamilyNameRegexFilter(regex:str |bytes)

Bases:google.cloud.bigtable.data.row_filters._RegexFilter

Row filter for a family name regular expression.

Theregex must be valid RE2 patterns. See Google’sRE2 reference for the accepted syntax.

• Parameters

  regex (str) – A regular expression (RE2) to match cells from columns in a given column family. For technical reasons, the regex must not contain the':' character, even if it is not being used as a literal.

class google.cloud.bigtable.data.row_filters.LiteralValueFilter(value:bytes |str |int)

Bases:google.cloud.bigtable.data.row_filters.ValueRegexFilter

Row filter for an exact value.

• Parameters

  value (bytes* or[str](https://docs.python.org/3/library/stdtypes.html#str) or[int*](https://docs.python.org/3/library/functions.html#int)) – a literal string, integer, or the equivalent bytes. Integer values will be packed into signed 8-bytes.

class google.cloud.bigtable.data.row_filters.PassAllFilter(flag:bool)

Bases:google.cloud.bigtable.data.row_filters._BoolFilter

Row filter equivalent to not filtering at all.

• Parameters

  flag (bool) – Matches all cells, regardless of input. Functionally equivalent to leavingfilter unset, but included for completeness.

class google.cloud.bigtable.data.row_filters.RowFilter()

Bases:abc.ABC

Basic filter to apply to cells in a row.

These values can be combined viaRowFilterChain,RowFilterUnion andConditionalRowFilter.

NOTE: This class is a do-nothing base class for all row filters.

class google.cloud.bigtable.data.row_filters.RowFilterChain(filters:Optional[list[google.cloud.bigtable.data.row_filters.RowFilter]] = None)

Bases:google.cloud.bigtable.data.row_filters._FilterCombination

Chain of row filters.

Sends rows through several filters in sequence. The filters are “chained”together to process a row. After the first filter is applied, the secondis applied to the filtered output and so on for subsequent filters.

• Parameters

  filters (list) – List ofRowFilter

class google.cloud.bigtable.data.row_filters.RowFilterUnion(filters:Optional[list[google.cloud.bigtable.data.row_filters.RowFilter]] = None)

Bases:google.cloud.bigtable.data.row_filters._FilterCombination

Union of row filters.

Sends rows through several filters simultaneously, thenmerges / interleaves all the filtered results together.

If multiple cells are produced with the same column and timestamp,they will all appear in the output row in an unspecified mutual order.

• Parameters

  filters (list) – List ofRowFilter

class google.cloud.bigtable.data.row_filters.RowKeyRegexFilter(regex:str |bytes)

Bases:google.cloud.bigtable.data.row_filters._RegexFilter

Row filter for a row key regular expression.

Theregex must be valid RE2 patterns. See Google’sRE2 reference for the accepted syntax.

NOTE: Special care need be used with the expression used. Sinceeach of these properties can contain arbitrary bytes, the\\Cescape sequence must be used if a true wildcard is desired. The.character will not match the new line character\\n, which may bepresent in a binary value.

• Parameters

  regex (bytes) – A regular expression (RE2) to match cells from rows with row keys that satisfy this regex. For aCheckAndMutateRowRequest, this filter is unnecessary since the row key is already specified.

class google.cloud.bigtable.data.row_filters.RowSampleFilter(sample:float)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

Matches all cells from a row with probability p.

• Parameters

  sample (float) – The probability of matching a cell (must be in the interval(0, 1) The end points are excluded).

class google.cloud.bigtable.data.row_filters.SinkFilter(flag:bool)

Bases:google.cloud.bigtable.data.row_filters._BoolFilter

Advanced row filter to skip parent filters.

• Parameters

  flag (bool) – ADVANCED USE ONLY. Hook for introspection into the row filter. Outputs all cells directly to the output of the read rather than to any parent filter. Cannot be used within thepredicate_filter,true_filter, orfalse_filter of aConditionalRowFilter.

class google.cloud.bigtable.data.row_filters.StripValueTransformerFilter(flag:bool)

Bases:google.cloud.bigtable.data.row_filters._BoolFilter

Row filter that transforms cells into empty string (0 bytes).

• Parameters

  flag (bool) – IfTrue, replaces each cell’s value with the empty string. As the name indicates, this is more useful as a transformer than a generic query / filter.

class google.cloud.bigtable.data.row_filters.TimestampRange(start: 'datetime' |None = None, end: 'datetime' |None = None)

Bases:object

Range of time with inclusive lower and exclusive upper bounds.

• Parameters

  • start (datetime.datetime) – (Optional) The (inclusive) lower bound of the timestamprange. If omitted, defaults to Unix epoch.

  • end (datetime.datetime) – (Optional) The (exclusive) upper bound of the timestamprange. If omitted, no upper bound is used.

class google.cloud.bigtable.data.row_filters.TimestampRangeFilter(start: 'datetime' |None = None, end: 'datetime' |None = None)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

Row filter that limits cells to a range of time.

• Parameters

  range (TimestampRange) – Range of time that cells should match against.

class google.cloud.bigtable.data.row_filters.ValueRangeFilter(start_value:Optional[Union[bytes,int]] = None, end_value:Optional[Union[bytes,int]] = None, inclusive_start:Optional[bool] = None, inclusive_end:Optional[bool] = None)

Bases:google.cloud.bigtable.data.row_filters.RowFilter

A range of values to restrict to in a row filter.

Will only match cells that have values in this range.

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

• Parameters

  • start_value (bytes) – The start of the range of values. If no value is used,the backend applies no lower bound to the values.

  • end_value (bytes) – The end of the range of values. If no value is used,the backend applies no upper bound to the values.

  • inclusive_start (bool) – Boolean indicating if the start value should beincluded in the range (or excluded). DefaultstoTrue ifstart_value is passed andnoinclusive_start was given.

  • inclusive_end (bool) – Boolean indicating if the end value should beincluded in the range (or excluded). DefaultstoTrue ifend_value is passed andnoinclusive_end was given.

• Raises

  ValueError ifinclusive_start is set but nostart_value is given or ifinclusive_end is set but noend_value is given

class google.cloud.bigtable.data.row_filters.ValueRegexFilter(regex:str |bytes)

Bases:google.cloud.bigtable.data.row_filters._RegexFilter

Row filter for a value regular expression.

Theregex must be valid RE2 patterns. See Google’sRE2 reference for the accepted syntax.

NOTE: Special care need be used with the expression used. Sinceeach of these properties can contain arbitrary bytes, the\\Cescape sequence must be used if a true wildcard is desired. The.character will not match the new line character\\n, which may bepresent in a binary value.

• Parameters

  regex (bytes* or[str*](https://docs.python.org/3/library/stdtypes.html#str)) – A regular expression (RE2) to match cells with values that match this regex. String values will be encoded as ASCII.