Cloud Firestore V1 Client - Class ExecutionStats (1.46.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class ExecutionStats.

Execution statistics for the query.

Generated from protobuf message google.firestore.v1.ExecutionStats

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ results_returned int|string

Total number of results returned, including documents, projections, aggregation results, keys.

↳ execution_duration Google\Protobuf\Duration

Total time to execute the query in the backend.

↳ read_operations int|string

Total billable read operations.

↳ debug_stats Google\Protobuf\Struct

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

getResultsReturned

Total number of results returned, including documents, projections, aggregation results, keys.

Returns
Type Description
int|string

setResultsReturned

Total number of results returned, including documents, projections, aggregation results, keys.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getExecutionDuration

Total time to execute the query in the backend.

Returns
Type Description
Google\Protobuf\Duration|null

hasExecutionDuration

clearExecutionDuration

setExecutionDuration

Total time to execute the query in the backend.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getReadOperations

Total billable read operations.

Returns
Type Description
int|string

setReadOperations

Total billable read operations.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDebugStats

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

Returns
Type Description
Google\Protobuf\Struct|null

hasDebugStats

clearDebugStats

setDebugStats

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this