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
Name
Description
value
string
A regex value.
Returns
Type
Description
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
Name
Description
value
array|string
An exact value.
Returns
Type
Description
Google\Cloud\Bigtable\Filter\SimpleFilter
rangeWithinFamily
Returns a builder used to configure qualifier range filters.
[[["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-08-28 UTC."],[],[],null,["# Cloud Bigtable Client - Class QualifierFilter (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Filter.Builder.QualifierFilter)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Filter.Builder.QualifierFilter)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Filter.Builder.QualifierFilter)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Filter.Builder.QualifierFilter)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Filter.Builder.QualifierFilter)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Filter.Builder.QualifierFilter)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Filter.Builder.QualifierFilter)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Filter.Builder.QualifierFilter)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Filter.Builder.QualifierFilter)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Filter.Builder.QualifierFilter)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Filter.Builder.QualifierFilter)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Filter.Builder.QualifierFilter)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Filter.Builder.QualifierFilter)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Filter.Builder.QualifierFilter)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Filter.Builder.QualifierFilter)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Filter.Builder.QualifierFilter)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Filter.Builder.QualifierFilter)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Filter.Builder.QualifierFilter)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Filter.Builder.QualifierFilter)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Filter.Builder.QualifierFilter)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Filter.Builder.QualifierFilter)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Filter.Builder.QualifierFilter)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Filter.Builder.QualifierFilter)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Filter.Builder.QualifierFilter)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Filter.Builder.QualifierFilter)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Filter.Builder.QualifierFilter)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Filter.Builder.QualifierFilter)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Filter.Builder.QualifierFilter)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Filter.Builder.QualifierFilter)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Filter.Builder.QualifierFilter)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Filter.Builder.QualifierFilter) \nReference documentation and code samples for the Cloud Bigtable Client class QualifierFilter.\n\nA builder used to configure qualifier based filters.\n\nExample: \n\n use Google\\Cloud\\Bigtable\\Filter;\n\n $builder = Filter::qualifier();\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Filter \\\\ Builder\n\nMethods\n-------\n\n### regex\n\nMatches only cells from columns whose qualifiers satisfy the given\n[RE2 regex](https://github.com/google/re2/wiki/Syntax). Note that, since\ncolumn qualifiers can contain arbitrary bytes, the `\\C` escape sequence\nmust be used if a true wildcard is desired. The `.` character will not\nmatch the new line character `\\n`, which may be present in a binary\nqualifier.\n\nExample: \n\n $qualifierFilter = $builder-\u003eregex('prefix.*');\n\n### exactMatch\n\nMatches only cells from rows whose keys equal the value. In other words, passes through the\nentire row when the key matches, and otherwise produces an empty row.\n\nExample: \n\n $qualifierFilter = $builder-\u003eexactMatch('cq1');\n\n### rangeWithinFamily\n\nReturns a builder used to configure qualifier range filters.\n\nExample: \n\n $qualifierFilter = $builder-\u003erangeWithinFamily('cf1')\n -\u003eof('cq1', 'cq10');"]]