Cloud Spanner V1 Client - Class PlanNode (1.57.0)

Version 1.57.0

• 1.91.0 (latest)
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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
Name	Description
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
Type	Description
int

setIndex

The PlanNode's index in node list.

Parameter
Name	Description
var	int

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	int

Returns
Type	Description
$this

getDisplayName

The display name for the node.

Returns
Type	Description
string

setDisplayName

The display name for the node.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getChildLinks

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setChildLinks

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

Parameter
Name	Description
var	array<Google\Cloud\Spanner\V1\PlanNode\ChildLink>

Returns
Type	Description
$this

getShortRepresentation

Condensed representation for SCALAR nodes.

Returns
Type	Description
Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation|null

hasShortRepresentation

clearShortRepresentation

setShortRepresentation

Condensed representation for SCALAR nodes.

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this