Cloud Bigtable Client - Class ValueFilter (2.1.0)

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

A builder used to configure value based filters.

Example:

use Google\Cloud\Bigtable\Filter;

$builder = Filter::value();

Namespace

Google \ Cloud \ Bigtable \ Filter \ Builder

Methods

regex

Matches only cells with values that satisfy the given RE2 regex. 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.

Example:

$valueFilter = $builder->regex('prefix.*');
Parameter
Name Description
value string

A regex value.

Returns
Type Description
Google\Cloud\Bigtable\Filter\SimpleFilter

exactMatch

Matches only cells with values that match the given value.

Example:

$valueFilter = $builder->exactMatch('value1');
Parameter
Name Description
value array|string

An exact value to match.

Returns
Type Description
Google\Cloud\Bigtable\Filter\SimpleFilter

range

Returns a builder used to configure value range filters.

Example:

$valueFilter = $builder->range()
    ->of('value1', 'value10');
Returns
Type Description
Google\Cloud\Bigtable\Filter\ValueRangeFilter

strip

Replaces each cell's value with an empty string.

Returns
Type Description
Google\Cloud\Bigtable\Filter\SimpleFilter