Cloud Spanner V1 Client - Class ResultSet (1.54.2)

Version 1.54.2

• 1.91.0 (latest)
• 1.90.0
• 1.89.0
• 1.88.0
• 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

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.

getMetadata

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

Generated from protobuf field .google.spanner.v1.ResultSetMetadata metadata = 1;

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

hasMetadata

clearMetadata

setMetadata

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

Generated from protobuf field .google.spanner.v1.ResultSetMetadata metadata = 1;

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.

Generated from protobuf field repeated .google.protobuf.ListValue rows = 2;

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.

Generated from protobuf field repeated .google.protobuf.ListValue rows = 2;

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.

Generated from protobuf field .google.spanner.v1.ResultSetStats stats = 3;

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.

Generated from protobuf field .google.spanner.v1.ResultSetStats stats = 3;

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

Returns
Type	Description
$this