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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable Client - Class FamilyFilter (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Filter.Builder.FamilyFilter)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Filter.Builder.FamilyFilter)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Filter.Builder.FamilyFilter)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Filter.Builder.FamilyFilter)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Filter.Builder.FamilyFilter)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Filter.Builder.FamilyFilter)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Filter.Builder.FamilyFilter)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Filter.Builder.FamilyFilter)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Filter.Builder.FamilyFilter)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Filter.Builder.FamilyFilter)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Filter.Builder.FamilyFilter)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Filter.Builder.FamilyFilter)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Filter.Builder.FamilyFilter)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Filter.Builder.FamilyFilter)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Filter.Builder.FamilyFilter)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Filter.Builder.FamilyFilter)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Filter.Builder.FamilyFilter)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Filter.Builder.FamilyFilter)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Filter.Builder.FamilyFilter)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Filter.Builder.FamilyFilter)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Filter.Builder.FamilyFilter)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Filter.Builder.FamilyFilter)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Filter.Builder.FamilyFilter)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Filter.Builder.FamilyFilter)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Filter.Builder.FamilyFilter)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Filter.Builder.FamilyFilter)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Filter.Builder.FamilyFilter)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Filter.Builder.FamilyFilter)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Filter.Builder.FamilyFilter)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Filter.Builder.FamilyFilter)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Filter.Builder.FamilyFilter) \nReference documentation and code samples for the Cloud Bigtable Client class FamilyFilter.\n\nA builder used to configure column family filters.\n\nExample: \n\n use Google\\Cloud\\Bigtable\\Filter;\n\n $builder = Filter::family();\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Filter \\\\ Builder\n\nMethods\n-------\n\n### regex\n\nMatches only cells from columns whose families satisfy the given\n[RE2 regex](https://github.com/google/re2/wiki/Syntax).\n\nFor technical reasons, the regex must not contain the `:` character, even\nif it is not being used as literal. Note that, since column families\ncannot contain the new line character `\\n`, it is sufficient to use `.`\nas a full wildcard when matching column family names.\n\nExample: \n\n $familyFilter = $builder-\u003eregex('prefix.*');\n\n### exactMatch\n\nMatches only cells from columns whose families match the value.\n\nExample: \n\n $familyFilter = $builder-\u003eexactMatch('cf1');"]]