Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is aSCALARnode, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
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" }
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.
Used to determine the type of node. May be needed for visualizing
different kinds of nodes differently. For example, If the node is aSCALARnode, 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 aSCALARnode, 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 nodeindexes and their relationship to this parent.
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"
}
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"
}
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.
[[["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,["# Cloud Spanner V1 Client - Class PlanNode (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.PlanNode)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.PlanNode)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.PlanNode)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.PlanNode)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.PlanNode)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.PlanNode)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.PlanNode)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.PlanNode)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.PlanNode)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.PlanNode)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.PlanNode)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.PlanNode)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.PlanNode)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.PlanNode)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.PlanNode)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.PlanNode)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.PlanNode)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.PlanNode)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.PlanNode)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.PlanNode)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.PlanNode)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.PlanNode)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.PlanNode)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.PlanNode)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.PlanNode)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.PlanNode)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.PlanNode)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.PlanNode)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.PlanNode)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.PlanNode)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.PlanNode)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.PlanNode)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.PlanNode)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.PlanNode)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.PlanNode)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.PlanNode)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.PlanNode)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.PlanNode)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.PlanNode)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.PlanNode)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.PlanNode)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.PlanNode)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.PlanNode) \nReference documentation and code samples for the Cloud Spanner V1 Client class PlanNode.\n\nNode information for nodes appearing in a [QueryPlan.plan_nodes](/php/docs/reference/cloud-spanner/latest/V1.QueryPlan#_Google_Cloud_Spanner_V1_QueryPlan__getPlanNodes__).\n\nGenerated from protobuf message `google.spanner.v1.PlanNode`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIndex\n\nThe `PlanNode`'s index in [node list](/php/docs/reference/cloud-spanner/latest/V1.QueryPlan#_Google_Cloud_Spanner_V1_QueryPlan__getPlanNodes__).\n\n### setIndex\n\nThe `PlanNode`'s index in [node list](/php/docs/reference/cloud-spanner/latest/V1.QueryPlan#_Google_Cloud_Spanner_V1_QueryPlan__getPlanNodes__).\n\n### getKind\n\nUsed to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\n[SCALAR](/php/docs/reference/cloud-spanner/latest/V1.PlanNode.Kind#_Google_Cloud_Spanner_V1_PlanNode_Kind__SCALAR) node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.\n\n### setKind\n\nUsed to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\n[SCALAR](/php/docs/reference/cloud-spanner/latest/V1.PlanNode.Kind#_Google_Cloud_Spanner_V1_PlanNode_Kind__SCALAR) node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.\n\n### getDisplayName\n\nThe display name for the node.\n\n### setDisplayName\n\nThe display name for the node.\n\n### getChildLinks\n\nList of child node `index`es and their relationship to this parent.\n\n### setChildLinks\n\nList of child node `index`es and their relationship to this parent.\n\n### getShortRepresentation\n\nCondensed representation for [SCALAR](/php/docs/reference/cloud-spanner/latest/V1.PlanNode.Kind#_Google_Cloud_Spanner_V1_PlanNode_Kind__SCALAR) nodes.\n\n### hasShortRepresentation\n\n### clearShortRepresentation\n\n### setShortRepresentation\n\nCondensed representation for [SCALAR](/php/docs/reference/cloud-spanner/latest/V1.PlanNode.Kind#_Google_Cloud_Spanner_V1_PlanNode_Kind__SCALAR) nodes.\n\n### getMetadata\n\nAttributes relevant to the node contained in a group of key-value pairs.\n\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n{\n\"parameter_reference\": \"param1\",\n\"parameter_type\": \"array\"\n}\n\n### hasMetadata\n\n### clearMetadata\n\n### setMetadata\n\nAttributes relevant to the node contained in a group of key-value pairs.\n\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n{\n\"parameter_reference\": \"param1\",\n\"parameter_type\": \"array\"\n}\n\n### getExecutionStats\n\nThe execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.\n\n### hasExecutionStats\n\n### clearExecutionStats\n\n### setExecutionStats\n\nThe execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc."]]
