PlanNode
class PlanNode extends Message
Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
Protobuf type Google\Spanner\V1\PlanNode
Methods
No description
The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
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][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
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][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
The display name for the node.
The display name for the node.
List of child node indexes and their relationship to this parent.
List of child node indexes and their relationship to this parent.
Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
Attributes relevant to the node contained in a group of key-value pairs.
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.
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.
Details
at line 74
__construct()
at line 85
int
getIndex()
The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
Generated from protobuf field int32 index = 1;
at line 96
setIndex(int $var)
The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
Generated from protobuf field int32 index = 1;
at line 112
int
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][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
Generated from protobuf field .google.spanner.v1.PlanNode.Kind kind = 2;
at line 127
setKind(int $var)
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][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
Generated from protobuf field .google.spanner.v1.PlanNode.Kind kind = 2;
at line 139
string
getDisplayName()
The display name for the node.
Generated from protobuf field string display_name = 3;
at line 150
setDisplayName(string $var)
The display name for the node.
Generated from protobuf field string display_name = 3;
at line 162
RepeatedField
getChildLinks()
List of child node indexes and their relationship to this parent.
Generated from protobuf field repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
at line 173
setChildLinks(array|RepeatedField $var)
List of child node indexes and their relationship to this parent.
Generated from protobuf field repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
at line 185
PlanNode_ShortRepresentation
getShortRepresentation()
Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
Generated from protobuf field .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
at line 196
setShortRepresentation(PlanNode_ShortRepresentation $var)
Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
Generated from protobuf field .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
at line 214
Struct
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" }
Generated from protobuf field .google.protobuf.Struct metadata = 6;
at line 231
setMetadata(Struct $var)
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" }
Generated from protobuf field .google.protobuf.Struct metadata = 6;
at line 246
Struct
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.
Generated from protobuf field .google.protobuf.Struct execution_stats = 7;
at line 260
setExecutionStats(Struct $var)
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.
Generated from protobuf field .google.protobuf.Struct execution_stats = 7;