Reference documentation and code samples for the Cloud Spanner V1 Client class ResultSetStats.
Additional statistics about a ResultSet or PartialResultSet.
Generated from protobuf message google.spanner.v1.ResultSetStats
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query_plan |
Google\Cloud\Spanner\V1\QueryPlan
QueryPlan for the query associated with this result. |
↳ query_stats |
Google\Protobuf\Struct
Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" } |
↳ row_count_exact |
int|string
Standard DML returns an exact count of rows that were modified. |
↳ row_count_lower_bound |
int|string
Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified. |
getQueryPlan
QueryPlan for the query associated with this result.
Generated from protobuf field .google.spanner.v1.QueryPlan query_plan = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\QueryPlan|null | |
hasQueryPlan
clearQueryPlan
setQueryPlan
QueryPlan for the query associated with this result.
Generated from protobuf field .google.spanner.v1.QueryPlan query_plan = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\QueryPlan
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryStats
Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
Generated from protobuf field .google.protobuf.Struct query_stats = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasQueryStats
clearQueryStats
setQueryStats
Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
Generated from protobuf field .google.protobuf.Struct query_stats = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCountExact
Standard DML returns an exact count of rows that were modified.
Generated from protobuf field int64 row_count_exact = 3;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasRowCountExact
setRowCountExact
Standard DML returns an exact count of rows that were modified.
Generated from protobuf field int64 row_count_exact = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCountLowerBound
Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.
Generated from protobuf field int64 row_count_lower_bound = 4;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasRowCountLowerBound
setRowCountLowerBound
Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.
Generated from protobuf field int64 row_count_lower_bound = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCount
| Returns | |
|---|---|
| Type | Description |
string | |