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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ metadata |
ResultSetMetadata
Metadata about the result set, such as row type information. |
↳ rows |
array<Google\Protobuf\ListValue>
Each element in |
↳ stats |
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 |
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 |
ResultSetMetadata|null |
|
hasMetadata
clearMetadata
setMetadata
Metadata about the result set, such as row type information.
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
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 |
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 |
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 |
MultiplexedSessionPrecommitToken
|
| Returns | |
|---|---|
| Type | Description |
$this |
|