Send feedback
Class PlanNode (3.57.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
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
google.cloud.spanner_v1.types.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
MutableSequence[google.cloud.spanner_v1.types.PlanNode.ChildLink ]
List of child node index
\ es and their relationship to
this parent.
short_representation
google.cloud.spanner_v1.types.PlanNode.ShortRepresentation
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.
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
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].
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Class PlanNode (3.57.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.57.0 (latest)](/python/docs/reference/spanner/latest/google.cloud.spanner_v1.types.PlanNode)\n- [3.56.0](/python/docs/reference/spanner/3.56.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.55.0](/python/docs/reference/spanner/3.55.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.54.0](/python/docs/reference/spanner/3.54.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.53.0](/python/docs/reference/spanner/3.53.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.52.0](/python/docs/reference/spanner/3.52.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.51.0](/python/docs/reference/spanner/3.51.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.50.1](/python/docs/reference/spanner/3.50.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.46.0](/python/docs/reference/spanner/3.46.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.45.0](/python/docs/reference/spanner/3.45.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.44.0](/python/docs/reference/spanner/3.44.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.43.0](/python/docs/reference/spanner/3.43.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.42.0](/python/docs/reference/spanner/3.42.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.41.0](/python/docs/reference/spanner/3.41.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.40.1](/python/docs/reference/spanner/3.40.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.39.0](/python/docs/reference/spanner/3.39.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.38.0](/python/docs/reference/spanner/3.38.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.37.0](/python/docs/reference/spanner/3.37.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.36.0](/python/docs/reference/spanner/3.36.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.35.1](/python/docs/reference/spanner/3.35.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.34.0](/python/docs/reference/spanner/3.34.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.33.0](/python/docs/reference/spanner/3.33.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.32.0](/python/docs/reference/spanner/3.32.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.31.0](/python/docs/reference/spanner/3.31.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.30.0](/python/docs/reference/spanner/3.30.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.29.0](/python/docs/reference/spanner/3.29.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.28.0](/python/docs/reference/spanner/3.28.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.27.1](/python/docs/reference/spanner/3.27.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.26.0](/python/docs/reference/spanner/3.26.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.25.0](/python/docs/reference/spanner/3.25.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.24.0](/python/docs/reference/spanner/3.24.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.23.0](/python/docs/reference/spanner/3.23.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.22.2](/python/docs/reference/spanner/3.22.2/google.cloud.spanner_v1.types.PlanNode)\n- [3.21.0](/python/docs/reference/spanner/3.21.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.20.0](/python/docs/reference/spanner/3.20.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.19.0](/python/docs/reference/spanner/3.19.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.18.0](/python/docs/reference/spanner/3.18.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.17.0](/python/docs/reference/spanner/3.17.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.16.0](/python/docs/reference/spanner/3.16.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.15.1](/python/docs/reference/spanner/3.15.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.14.1](/python/docs/reference/spanner/3.14.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.13.0](/python/docs/reference/spanner/3.13.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.12.1](/python/docs/reference/spanner/3.12.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.11.1](/python/docs/reference/spanner/3.11.1/google.cloud.spanner_v1.types.PlanNode)\n- [3.10.0](/python/docs/reference/spanner/3.10.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.9.0](/python/docs/reference/spanner/3.9.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.8.0](/python/docs/reference/spanner/3.8.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.7.0](/python/docs/reference/spanner/3.7.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.6.0](/python/docs/reference/spanner/3.6.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.5.0](/python/docs/reference/spanner/3.5.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.4.0](/python/docs/reference/spanner/3.4.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.3.0](/python/docs/reference/spanner/3.3.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.2.0](/python/docs/reference/spanner/3.2.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.1.0](/python/docs/reference/spanner/3.1.0/google.cloud.spanner_v1.types.PlanNode)\n- [3.0.0](/python/docs/reference/spanner/3.0.0/google.cloud.spanner_v1.types.PlanNode)\n- [2.1.1](/python/docs/reference/spanner/2.1.1/google.cloud.spanner_v1.types.PlanNode)\n- [2.0.0](/python/docs/reference/spanner/2.0.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.19.3](/python/docs/reference/spanner/1.19.3/google.cloud.spanner_v1.types.PlanNode)\n- [1.18.0](/python/docs/reference/spanner/1.18.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.17.1](/python/docs/reference/spanner/1.17.1/google.cloud.spanner_v1.types.PlanNode)\n- [1.16.0](/python/docs/reference/spanner/1.16.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.15.1](/python/docs/reference/spanner/1.15.1/google.cloud.spanner_v1.types.PlanNode)\n- [1.14.0](/python/docs/reference/spanner/1.14.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.13.0](/python/docs/reference/spanner/1.13.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.12.0](/python/docs/reference/spanner/1.12.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.11.0](/python/docs/reference/spanner/1.11.0/google.cloud.spanner_v1.types.PlanNode)\n- [1.10.0](/python/docs/reference/spanner/1.10.0/google.cloud.spanner_v1.types.PlanNode) \n\n PlanNode(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nNode information for nodes appearing in a\n`QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes]`.\n\nClasses\n-------\n\n### ChildLink\n\n ChildLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nMetadata associated with a parent-child relationship appearing in a\n`PlanNode][google.spanner.v1.PlanNode]`.\n\n### Kind\n\n Kind(value)\n\nThe kind of `PlanNode][google.spanner.v1.PlanNode]`. Distinguishes\nbetween the two different kinds of nodes that can appear in a query\nplan.\n\n### ShortRepresentation\n\n ShortRepresentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nCondensed representation of a node and its subtree. Only present for\n`SCALAR` \\[PlanNode(s)\\]\\[google.spanner.v1.PlanNode\\]."]]