Reference documentation and code samples for the Cloud Bigtable V2 Client class ReadRowsRequest.
Request message for Bigtable.ReadRows.
Generated from protobuf messagegoogle.bigtable.v2.ReadRowsRequest
Namespace
Google \ Cloud \ Bigtable \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ table_name
string
Optional. The unique name of the table from which to read. Values are of the formprojects/<project>/instances/<instance>/tables/<table>.
↳ authorized_view_name
string
Optional. The unique name of the AuthorizedView from which to read. Values are of the formprojects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
↳ materialized_view_name
string
Optional. The unique name of the MaterializedView from which to read. Values are of the formprojects/<project>/instances/<instance>/materializedViews/<materialized_view>.
↳ app_profile_id
string
This value specifies routing for replication. If not specified, the "default" application profile will be used.
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
↳ rows_limit
int|string
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
↳ request_stats_view
int
The view into RequestStats, as described above.
↳ reversed
bool
Experimental API - Please note that this API is currently experimental and can change in the future. Return rows in lexiographical descending order of the row keys. The row contents will not be affected by this flag. Example result set: [ {key: "k2", "f:col1": "v1", "f:col2": "v1"}, {key: "k1", "f:col1": "v2", "f:col2": "v2"} ]
getTableName
Optional. The unique name of the table from which to read.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>.
Returns
Type
Description
string
setTableName
Optional. The unique name of the table from which to read.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAuthorizedViewName
Optional. The unique name of the AuthorizedView from which to read.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
Returns
Type
Description
string
setAuthorizedViewName
Optional. The unique name of the AuthorizedView from which to read.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMaterializedViewName
Optional. The unique name of the MaterializedView from which to read.
Values are of the formprojects/<project>/instances/<instance>/materializedViews/<materialized_view>.
Returns
Type
Description
string
setMaterializedViewName
Optional. The unique name of the MaterializedView from which to read.
Values are of the formprojects/<project>/instances/<instance>/materializedViews/<materialized_view>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAppProfileId
This value specifies routing for replication. If not specified, the
"default" application profile will be used.
Returns
Type
Description
string
setAppProfileId
This value specifies routing for replication. If not specified, the
"default" application profile will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRows
The row keys and/or ranges to read sequentially. If not specified, reads
from all rows.
The read will stop after committing to N rows' worth of results. The
default (zero) is to return all results.
Returns
Type
Description
int|string
setRowsLimit
The read will stop after committing to N rows' worth of results. The
default (zero) is to return all results.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getRequestStatsView
The view into RequestStats, as described above.
Returns
Type
Description
int
Enum of typeRequestStatsView.
setRequestStatsView
The view into RequestStats, as described above.
Parameter
Name
Description
var
int
Enum of typeRequestStatsView.
Returns
Type
Description
$this
getReversed
Experimental API - Please note that this API is currently experimental
and can change in the future.
Return rows in lexiographical descending order of the row keys. The row
contents will not be affected by this flag.
Example result set:
[
{key: "k2", "f:col1": "v1", "f:col2": "v1"},
{key: "k1", "f:col1": "v2", "f:col2": "v2"}
]
Returns
Type
Description
bool
setReversed
Experimental API - Please note that this API is currently experimental
and can change in the future.
Return rows in lexiographical descending order of the row keys. The row
contents will not be affected by this flag.
Example result set:
[
{key: "k2", "f:col1": "v1", "f:col2": "v1"},
{key: "k1", "f:col1": "v2", "f:col2": "v2"}
]
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
tableName
string
Optional. The unique name of the table from which to read.
Values are of the formprojects/<project>/instances/<instance>/tables/<table>. Please seeBigtableClient::tableName()for help formatting this field.
[[["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-09 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ReadRowsRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.ReadRowsRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.ReadRowsRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.ReadRowsRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.ReadRowsRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.ReadRowsRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.ReadRowsRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.ReadRowsRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.ReadRowsRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.ReadRowsRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.ReadRowsRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.ReadRowsRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.ReadRowsRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.ReadRowsRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.ReadRowsRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.ReadRowsRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.ReadRowsRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.ReadRowsRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.ReadRowsRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.ReadRowsRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.ReadRowsRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.ReadRowsRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.ReadRowsRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.ReadRowsRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.ReadRowsRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.ReadRowsRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.ReadRowsRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.ReadRowsRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.ReadRowsRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.ReadRowsRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.ReadRowsRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.ReadRowsRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ReadRowsRequest.\n\nRequest message for Bigtable.ReadRows.\n\nGenerated from protobuf message `google.bigtable.v2.ReadRowsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTableName\n\nOptional. The unique name of the table from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### setTableName\n\nOptional. The unique name of the table from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### getAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### setAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### getMaterializedViewName\n\nOptional. The unique name of the MaterializedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/materializedViews/\u003cmaterialized_view\u003e`.\n\n### setMaterializedViewName\n\nOptional. The unique name of the MaterializedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/materializedViews/\u003cmaterialized_view\u003e`.\n\n### getAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### setAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### getRows\n\nThe row keys and/or ranges to read sequentially. If not specified, reads\nfrom all rows.\n\n### hasRows\n\n### clearRows\n\n### setRows\n\nThe row keys and/or ranges to read sequentially. If not specified, reads\nfrom all rows.\n\n### getFilter\n\nThe filter to apply to the contents of the specified row(s). If unset,\nreads the entirety of each row.\n\n### hasFilter\n\n### clearFilter\n\n### setFilter\n\nThe filter to apply to the contents of the specified row(s). If unset,\nreads the entirety of each row.\n\n### getRowsLimit\n\nThe read will stop after committing to N rows' worth of results. The\ndefault (zero) is to return all results.\n\n### setRowsLimit\n\nThe read will stop after committing to N rows' worth of results. The\ndefault (zero) is to return all results.\n\n### getRequestStatsView\n\nThe view into RequestStats, as described above.\n\n### setRequestStatsView\n\nThe view into RequestStats, as described above.\n\n### getReversed\n\nExperimental API - Please note that this API is currently experimental\nand can change in the future.\n\nReturn rows in lexiographical descending order of the row keys. The row\ncontents will not be affected by this flag.\nExample result set:\n\\[\n{key: \"k2\", \"f:col1\": \"v1\", \"f:col2\": \"v1\"},\n{key: \"k1\", \"f:col1\": \"v2\", \"f:col2\": \"v2\"}\n\\]\n\n### setReversed\n\nExperimental API - Please note that this API is currently experimental\nand can change in the future.\n\nReturn rows in lexiographical descending order of the row keys. The row\ncontents will not be affected by this flag.\nExample result set:\n\\[\n{key: \"k2\", \"f:col1\": \"v1\", \"f:col2\": \"v1\"},\n{key: \"k1\", \"f:col1\": \"v2\", \"f:col2\": \"v2\"}\n\\]\n\n### static::build\n\n### static::buildFromTableNameAppProfileId"]]
