Cloud Spanner V1 Client - Class PlanNode (1.56.0)

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

Node information for nodes appearing in a QueryPlan.plan_nodes.

Generated from protobuf message google.spanner.v1.PlanNode

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ index int

The PlanNode's index in node list.

↳ kind int

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

↳ display_name string

The display name for the node.

↳ child_links array<Google\Cloud\Spanner\V1\PlanNode\ChildLink>

List of child node indexes and their relationship to this parent.

↳ short_representation Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation

Condensed representation for SCALAR nodes.

↳ metadata Google\Protobuf\Struct

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

↳ execution_stats Google\Protobuf\Struct

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

getIndex

The PlanNode's index in node list.

Returns
TypeDescription
int

setIndex

The PlanNode's index in node list.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getKind

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

Returns
TypeDescription
int

setKind

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDisplayName

The display name for the node.

Returns
TypeDescription
string

setDisplayName

The display name for the node.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

List of child node indexes and their relationship to this parent.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

List of child node indexes and their relationship to this parent.

Parameter
NameDescription
var array<Google\Cloud\Spanner\V1\PlanNode\ChildLink>
Returns
TypeDescription
$this

getShortRepresentation

Condensed representation for SCALAR nodes.

Returns
TypeDescription
Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation|null

hasShortRepresentation

clearShortRepresentation

setShortRepresentation

Condensed representation for SCALAR nodes.

Parameter
NameDescription
var Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation
Returns
TypeDescription
$this

getMetadata

Attributes relevant to the node contained in a group of key-value pairs.

For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

Returns
TypeDescription
Google\Protobuf\Struct|null

hasMetadata

clearMetadata

setMetadata

Attributes relevant to the node contained in a group of key-value pairs.

For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

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

getExecutionStats

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasExecutionStats

clearExecutionStats

setExecutionStats

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

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