Cloud Spanner V1 Client - Class QueryPlan (2.1.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class QueryPlan.

Contains an ordered list of nodes appearing in the query plan.

Generated from protobuf message google.spanner.v1.QueryPlan

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ plan_nodes`	`array<PlanNode>` The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`.
`↳ query_advice`	`QueryAdvisorResult` Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.

getPlanNodes

The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's id corresponds to its index in plan_nodes.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPlanNodes

The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's id corresponds to its index in plan_nodes.

Parameter
Name	Description
`var`	`array<PlanNode>`

Returns
Type	Description
`$this`

getQueryAdvice

Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.

Returns
Type	Description
`QueryAdvisorResult\|null`

hasQueryAdvice

clearQueryAdvice

setQueryAdvice