Class: Google::Apis::SpannerV1::PlanNode

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

Node information for nodes appearing in a QueryPlan.plan_nodes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PlanNode

Returns a new instance of PlanNode



1848
1849
1850
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1848

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

List of child node indexes and their relationship to this parent. Corresponds to the JSON property childLinks

Returns:



1802
1803
1804
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1802

def child_links
  @child_links
end

#display_name ⇒ String

The display name for the node. Corresponds to the JSON property displayName

Returns:

  • (String) 


1807
1808
1809
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1807

def display_name
  @display_name
end

#execution_stats ⇒ Hash<String,Object>

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. Corresponds to the JSON property executionStats

Returns:

  • (Hash<String,Object>) 


1815
1816
1817
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1815

def execution_stats
  @execution_stats
end

#index ⇒ Fixnum

The PlanNode's index in node list. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


1820
1821
1822
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1820

def index
  @index
end

#kind ⇒ String

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. Corresponds to the JSON property kind

Returns:

  • (String) 


1829
1830
1831
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1829

def kind
  @kind
end

#metadata ⇒ Hash<String,Object>

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" Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


1840
1841
1842
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1840

def metadata
  @metadata
end

#short_representation ⇒ Google::Apis::SpannerV1::ShortRepresentation

Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s). Corresponds to the JSON property shortRepresentation

Returns:



1846
1847
1848
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1846

def short_representation
  @short_representation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1853
1854
1855
1856
1857
1858
1859
1860
1861
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1853

def update!(**args)
  @child_links = args[:child_links] if args.key?(:child_links)
  @display_name = args[:display_name] if args.key?(:display_name)
  @execution_stats = args[:execution_stats] if args.key?(:execution_stats)
  @index = args[:index] if args.key?(:index)
  @kind = args[:kind] if args.key?(:kind)
  @metadata = args[:metadata] if args.key?(:metadata)
  @short_representation = args[:short_representation] if args.key?(:short_representation)
end