Cloud Firestore V1 Client - Class ExplainMetrics (1.46.0)

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

Explain metrics for the query.

Generated from protobuf message google.firestore.v1.ExplainMetrics

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ plan_summary Google\Cloud\Firestore\V1\PlanSummary

Planning phase information for the query.
↳ execution_stats Google\Cloud\Firestore\V1\ExecutionStats

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

getPlanSummary

Planning phase information for the query.

Returns
Type Description
Google\Cloud\Firestore\V1\PlanSummary|null

hasPlanSummary

clearPlanSummary

setPlanSummary

Planning phase information for the query.

Parameter
Name Description
var Google\Cloud\Firestore\V1\PlanSummary
Returns
Type Description
$this

getExecutionStats

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

Returns
Type Description
Google\Cloud\Firestore\V1\ExecutionStats|null

hasExecutionStats

clearExecutionStats

setExecutionStats

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

Parameter
Name Description
var Google\Cloud\Firestore\V1\ExecutionStats
Returns
Type Description
$this