Class PlanNode (3.22.1)

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

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


index int
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.
display_name str
The display name for the node.
child_links Sequence[]
List of child node ``index``\ es and their relationship to this parent.
Condensed representation for `SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR]` nodes.
metadata google.protobuf.struct_pb2.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_pb2.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.


builtins.object > proto.message.Message > PlanNode


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

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



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


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].