Cloud Bigtable Client - Class KeyFilter (2.18.0)

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

A builder used to configure row key related filters.

Example:

use Google\Cloud\Bigtable\Filter;

$builder = Filter::key();

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

Example:

$keyFilter = $builder->regex('prefix.*');

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:

$keyFilter = $builder->exactMatch('r1');

Matches all cells from a row with probability, and matches no cells from the row with probability 1-probability.

Example:

$keyFilter = $builder->sample(.7);