Cloud Spanner V1 Client - Class ResultSet (1.87.0)

Version 1.87.0

• 1.88.0 (latest)
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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.
↳ precommit_token	Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

getMetadata

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

Returns
Type	Description
Google\Cloud\Spanner\V1\ResultSetMetadata|null

hasMetadata

clearMetadata

setMetadata

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

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\ResultSetMetadata

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
Google\Protobuf\Internal\RepeatedField

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
var	array<Google\Protobuf\ListValue>

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
Google\Cloud\Spanner\V1\ResultSetStats|null

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
var	Google\Cloud\Spanner\V1\ResultSetStats

Returns
Type	Description
$this

getPrecommitToken

Optional. A precommit token will be included if the read-write transaction is on a multiplexed session.

The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

Returns
Type	Description
Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null

hasPrecommitToken

clearPrecommitToken

setPrecommitToken

Optional. A precommit token will be included if the read-write transaction is on a multiplexed session.

The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken

Returns
Type	Description
$this