Cloud Datastore V1 Client - Class ExplainMetrics (1.28.2)

Version latest

• 1.28.2 (latest)
• 1.28.1
• 1.26.0
• 1.25.0
• 1.24.4
• 1.23.0
• 1.22.1
• 1.21.2
• 1.19.0
• 1.18.1
• 1.17.1

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

Explain metrics for the query.

Generated from protobuf message google.datastore.v1.ExplainMetrics

Namespace

Google \ Cloud \ Datastore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ plan_summary	Google\Cloud\Datastore\V1\PlanSummary Planning phase information for the query.
↳ execution_stats	Google\Cloud\Datastore\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\Datastore\V1\PlanSummary|null

hasPlanSummary

clearPlanSummary

setPlanSummary

Planning phase information for the query.

Parameter
Name	Description
var	Google\Cloud\Datastore\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\Datastore\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\Datastore\V1\ExecutionStats

Returns
Type	Description
$this