Google Cloud Spanner v1 API - Class PlanNode (4.3.0)

public sealed class PlanNode : IMessage<PlanNode>, IEquatable<PlanNode>, IDeepCloneable<PlanNode>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API class PlanNode.

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

Inheritance

object > PlanNode

Implements

IMessage PlanNode, IEquatable PlanNode, IDeepCloneable PlanNode, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.SpannerV1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

PlanNode()

public PlanNode()

PlanNode(PlanNode)

public PlanNode(PlanNode other)

Parameter
Name	Description
`other`	`PlanNode`

Properties

ChildLinks

public RepeatedField<PlanNode.Types.ChildLink> ChildLinks { get; }

List of child node indexes and their relationship to this parent.

Property Value
Type	Description
`RepeatedFieldPlanNodeTypesChildLink`

DisplayName

public string DisplayName { get; set; }

The display name for the node.

Property Value
Type	Description
`string`

ExecutionStats

public Struct ExecutionStats { get; set; }

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.

Property Value
Type	Description
`Struct`

Index

public int Index { get; set; }

The PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes].

Property Value
Type	Description
`int`

Kind

public PlanNode.Types.Kind Kind { get; set; }

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.

Property Value
Type	Description
`PlanNodeTypesKind`

Metadata

public Struct Metadata { get; set; }

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" }

Property Value
Type	Description
`Struct`

ShortRepresentation

public PlanNode.Types.ShortRepresentation ShortRepresentation { get; set; }

Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.

Property Value
Type	Description
`PlanNodeTypesShortRepresentation`