Class PlanNode (2.1.0)

Version 2.1.0

• 3.51.0 (latest)
• 3.50.1
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.1
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.1
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.1
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.2
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.1
• 3.14.1
• 3.13.0
• 3.12.1
• 3.11.1
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.1.1
• 2.0.0
• 1.19.3
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0

PlanNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Node information for nodes appearing in a QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].

Attributes

Name	Description
index	int The ``PlanNode``'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
kind	`.query_plan.PlanNode.Kind` 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.
display_name	str The display name for the node.
child_links	Sequence[`.query_plan.PlanNode.ChildLink`] List of child node ``index``\ es and their relationship to this parent.
short_representation	`.query_plan.PlanNode.ShortRepresentation` Condensed representation for `SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR]` nodes.
metadata	`.struct.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	`.struct.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.

Inheritance

builtins.object > proto.message.Message > PlanNode

Classes

ChildLink

ChildLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata associated with a parent-child relationship appearing in a PlanNode][google.spanner.v1.PlanNode].

Kind

Kind(value)

The kind of PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of nodes that can appear in a query plan.

ShortRepresentation

ShortRepresentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Condensed representation of a node and its subtree. Only present for SCALAR [PlanNode(s)][google.spanner.v1.PlanNode].