Reference documentation and code samples for the Cloud Spanner V1 Client class PlanNode.
Node information for nodes appearing in a QueryPlan.plan_nodes.
Generated from protobuf message google.spanner.v1.PlanNode
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index |
int
The |
↳ kind |
int
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 node, it will have a condensed representation which can be used to directly embed a description of the node in its parent. |
↳ display_name |
string
The display name for the node. |
↳ child_links |
array<Google\Cloud\Spanner\V1\PlanNode\ChildLink>
List of child node |
↳ short_representation |
Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation
Condensed representation for SCALAR nodes. |
↳ metadata |
Google\Protobuf\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
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. |
getIndex
The PlanNode's index in node list.
Generated from protobuf field int32 index = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setIndex
The PlanNode's index in node list.
Generated from protobuf field int32 index = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 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;
| 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 a 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;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The display name for the node.
Generated from protobuf field string display_name = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The display name for the node.
Generated from protobuf field string display_name = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setChildLinks
List of child node indexes and their relationship to this parent.
Generated from protobuf field repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Spanner\V1\PlanNode\ChildLink>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getShortRepresentation
Condensed representation for SCALAR nodes.
Generated from protobuf field .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation|null | |
hasShortRepresentation
clearShortRepresentation
setShortRepresentation
Condensed representation for SCALAR nodes.
Generated from protobuf field .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\PlanNode\ShortRepresentation
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasMetadata
clearMetadata
setMetadata
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasExecutionStats
clearExecutionStats
setExecutionStats
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;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |