Cloud Spanner V1 Client - Class ResultSetStats (1.64.0)

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

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Returns
TypeDescription
Google\Cloud\Spanner\V1\QueryPlan|null

hasQueryPlan

clearQueryPlan

setQueryPlan

QueryPlan for the query associated with this result.

Parameter
NameDescription
var Google\Cloud\Spanner\V1\QueryPlan
Returns
TypeDescription
$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" }

Returns
TypeDescription
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" }

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getRowCountExact

Standard DML returns an exact count of rows that were modified.

Returns
TypeDescription
int|string

hasRowCountExact

setRowCountExact

Standard DML returns an exact count of rows that were modified.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRowCountLowerBound

Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.

Returns
TypeDescription
int|string

hasRowCountLowerBound

setRowCountLowerBound

Partitioned DML does not offer exactly-once semantics, so it returns a lower bound of the rows modified.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRowCount

Returns
TypeDescription
string