Cloud Spanner V1 Client - Class ResultSet (1.66.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class ResultSet.

Results from Read or ExecuteSql .

Generated from protobuf message google.spanner.v1.ResultSet

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ metadata
Google\Cloud\Spanner\V1\ResultSetMetadata

Metadata about the result set, such as row type information.

↳ rows
array< Google\Protobuf\ListValue >

Each element in rows is a row whose format is defined by metadata.row_type . The ith element in each row matches the ith field in metadata.row_type . Elements are encoded based on type as described here .

↳ stats
Google\Cloud\Spanner\V1\ResultSetStats

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode . DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode . Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode .

Metadata about the result set, such as row type information.

Returns
Type
Description

Metadata about the result set, such as row type information.

Parameter
Name
Description
Returns
Type
Description
$this

getRows

Each element in rows is a row whose format is defined by metadata.row_type . The ith element in each row matches the ith field in metadata.row_type . Elements are encoded based on type as described here .

Returns
Type
Description

setRows

Each element in rows is a row whose format is defined by metadata.row_type . The ith element in each row matches the ith field in metadata.row_type . Elements are encoded based on type as described here .

Parameter
Name
Description
Returns
Type
Description
$this

getStats

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode .

DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode . Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode .

Returns
Type
Description

hasStats

clearStats

setStats

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode .

DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode . Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode .

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: