Reference documentation and code samples for the Cloud Bigtable API class Google::Cloud::Bigtable::RowFilter::SimpleFilter.
SimpleFilter
Inherits
- Object
Methods
#block
def block() -> Google::Cloud::Bigtable::RowFilter::SimpleFilterDoes not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
#cells_per_column
def cells_per_column(limit) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only the most recent N cells within each column. For example,
if N=2, this filter would match column foo:bar at timestamps 10 and 9,
skip all earlier cells in foo:bar, and then begin matching again in
column foo:bar2.
If duplicate cells are present, as is possible when using an interleave,
each copy of the cell is counted separately.
- limit (String) — Max cell match per column limit
#cells_per_row
def cells_per_row(limit) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only the first N cells of each row. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.
- limit (String) — Max cell match per row limit
#cells_per_row_offset
def cells_per_row_offset(offset) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterSkips the first N cells of each row, matching all subsequent cells. If duplicate cells are present, as is possible when using an interleave, each copy of the cell is counted separately.
- offset (Integer) — Offset value.
#column_range
def column_range(range) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells from columns within the given range.
#family
def family(regex) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the :
character, even if it is not being used as a literal.
Note that, since column families cannot contain the new line character
\n, it is sufficient to use . as a full wildcard when matching
column family names.
- regex (String) — Regex to match family name.
#key
def key(regex) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells from rows whose keys satisfy the given RE2 regex. In
other words, passes through the entire row when the key matches, and
otherwise produces an empty row.
Note that, since row keys can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary key.
For Regex syntax:
- regex (String) — Regex to match row keys.
#label
def label(value) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterApplies the given label to all cells in the output row. This allows the client to determine which results were produced from which part of the filter.
Values must be at most 15 characters in length, and match the RE2
pattern [a-z0-9\-]+
Due to a technical limitation, it is not possible to apply
multiple labels to a cell. As a result, a chain may have no more than
one sub-filter that contains an apply_label_transformer. It is okay for
an interleave to contain multiple apply_label_transformers, as they
will be applied to separate copies of the input.
- value (String) — Label name
#pass
def pass() -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches all cells, regardless of input. Functionally equivalent to
leaving filter unset, but included for completeness.
#qualifier
def qualifier(regex) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells from columns whose qualifiers satisfy the given RE2
regex.
Note that, since column qualifiers can contain arbitrary bytes, the \C
escape sequence must be used if a true wildcard is desired. The .
character will not match the new line character \n, which may be
present in a binary qualifier.
- regex (String) — Regex to match column qualifier name.
#sample
def sample(probability) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
- probability (Float)
#sink
def sink() -> Google::Cloud::Bigtable::RowFilter::SimpleFilterOutputs all cells directly to the output of the read rather than to any parent filter.
#strip_value
def strip_value() -> Google::Cloud::Bigtable::RowFilter::SimpleFilterReplaces each cell's value with an empty string.
#timestamp_range
def timestamp_range(from, to) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterCreates a timestamp-range filter.
Matches only cells with timestamps within the given range. Specifies a contiguous range of timestamps.
- from (Integer) — Inclusive lower bound. If left empty, interpreted as 0.
- to (Integer) — Exclusive upper bound. If left empty, interpreted as infinity.
#value
def value(regex) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells with values that satisfy the given regular expression.
Note that, since cell values can contain arbitrary bytes, the \C escape
sequence must be used if a true wildcard is desired. The . character
will not match the new line character \n, which may be present in a
binary value.
- regex (String, Integer) — Regex to match cell value, or an Integer value to be encoded as a 64-bit signed big-endian integer.
#value_range
def value_range(range) -> Google::Cloud::Bigtable::RowFilter::SimpleFilterMatches only cells with values that fall within the given range.
See ValueRange#from and { Google::Cloud::Bigtable::ValueRange#to} for range option inclusive/exclusive options
- The value at which to start the range. If neither field is set, interpreted as an empty string, inclusive.
- The value at which to end the range. If neither field is set, interpreted as an infinite string, exclusive.