Cloud Bigtable Client - Class FamilyFilter (2.0.1)

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

A builder used to configure column family filters.

Example:

use Google\Cloud\Bigtable\Filter;

$builder = Filter::family();

Namespace

Google \ Cloud \ Bigtable \ Filter \ Builder

Methods

regex

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

Example:

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

A regex value.

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

exactMatch

Matches only cells from columns whose families match the value.

Example:

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

An exact value to match.

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