Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::PlanNode (v0.22.2)

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

Node information for nodes appearing in a QueryPlan.plan_nodes.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#child_links

def child_links() -> ::Array<::Google::Cloud::Spanner::V1::PlanNode::ChildLink>
Returns

#child_links=

def child_links=(value) -> ::Array<::Google::Cloud::Spanner::V1::PlanNode::ChildLink>
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name for the node.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name for the node.
Returns
  • (::String) — The display name for the node.

#execution_stats

def execution_stats() -> ::Google::Protobuf::Struct
Returns
  • (::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.

#execution_stats=

def execution_stats=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::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.
Returns
  • (::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.

#index

def index() -> ::Integer
Returns
  • (::Integer) — The PlanNode's index in node list.

#index=

def index=(value) -> ::Integer
Parameter
  • value (::Integer) — The PlanNode's index in node list.
Returns
  • (::Integer) — The PlanNode's index in node list.

#kind

def kind() -> ::Google::Cloud::Spanner::V1::PlanNode::Kind
Returns
  • (::Google::Cloud::Spanner::V1::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 node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

#kind=

def kind=(value) -> ::Google::Cloud::Spanner::V1::PlanNode::Kind
Parameter
  • value (::Google::Cloud::Spanner::V1::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 node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
Returns
  • (::Google::Cloud::Spanner::V1::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 node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

#metadata

def metadata() -> ::Google::Protobuf::Struct
Returns
  • (::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"
}

#metadata=

def metadata=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::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"
}
Returns
  • (::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"
}

#short_representation

def short_representation() -> ::Google::Cloud::Spanner::V1::PlanNode::ShortRepresentation
Returns

#short_representation=

def short_representation=(value) -> ::Google::Cloud::Spanner::V1::PlanNode::ShortRepresentation
Parameter
Returns