Cloud Bigtable Client - Class QualifierFilter (1.29.2)

Reference documentation and code samples for the Cloud Bigtable Client class QualifierFilter.

A builder used to configure qualifier based filters.

Example:

use Google\Cloud\Bigtable\Filter;

$builder = Filter::qualifier();

Namespace

Google \ Cloud \ Bigtable \ Filter \ Builder

Methods

regex

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

Example:

$qualifierFilter = $builder->regex('prefix.*');
Parameter
NameDescription
value string

A regex value.

Returns
TypeDescription
Google\Cloud\Bigtable\Filter\SimpleFilter

exactMatch

Matches only cells from rows whose keys equal the value. In other words, passes through the entire row when the key matches, and otherwise produces an empty row.

Example:

$qualifierFilter = $builder->exactMatch('cq1');
Parameter
NameDescription
value array|string

An exact value.

Returns
TypeDescription
Google\Cloud\Bigtable\Filter\SimpleFilter

rangeWithinFamily

Returns a builder used to configure qualifier range filters.

Example:

$qualifierFilter = $builder->rangeWithinFamily('cf1')
    ->of('cq1', 'cq10');
Parameter
NameDescription
family string

The family name to search within.

Returns
TypeDescription
Google\Cloud\Bigtable\Filter\QualifierRangeFilter