Class: Google::Cloud::Spanner::V1::PlanNode

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/v1/query_plan.rb

Overview

Node information for nodes appearing in a QueryPlan.plan_nodes.

Defined Under Namespace

Modules: Kind Classes: ChildLink, ShortRepresentation

Instance Attribute Summary collapse

Instance Attribute Details



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#display_name ⇒ ::String 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#execution_stats ⇒ ::Google::Protobuf::Struct 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#index ⇒ ::Integer 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#kind ⇒ ::Google::Cloud::Spanner::V1::PlanNode::Kind 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#metadata ⇒ ::Google::Protobuf::Struct 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end

#short_representation ⇒ ::Google::Cloud::Spanner::V1::PlanNode::ShortRepresentation 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/spanner/v1/query_plan.rb', line 60

class PlanNode
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Metadata associated with a parent-child relationship appearing in a
  # {::Google::Cloud::Spanner::V1::PlanNode PlanNode}.
  # @!attribute [rw] child_index
  #   @return [::Integer]
  #     The node to which the link points.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of the link. For example, in Hash Joins this could be used to
  #     distinguish between the build child and the probe child, or in the case
  #     of the child being an output variable, to represent the tag associated
  #     with the output variable.
  # @!attribute [rw] variable
  #   @return [::String]
  #     Only present if the child node is {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} and corresponds
  #     to an output variable of the parent node. The field carries the name of
  #     the output variable.
  #     For example, a `TableScan` operator that reads rows from a table will
  #     have child links to the `SCALAR` nodes representing the output variables
  #     created for each column that is read by the operator. The corresponding
  #     `variable` fields will be set to the variable names assigned to the
  #     columns.
  class ChildLink
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Condensed representation of a node and its subtree. Only present for
  # `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
  # @!attribute [rw] description
  #   @return [::String]
  #     A string representation of the expression subtree rooted at this node.
  # @!attribute [rw] subqueries
  #   @return [::Google::Protobuf::Map{::String => ::Integer}]
  #     A mapping of (subquery variable name) -> (subquery node id) for cases
  #     where the `description` string of this node references a `SCALAR`
  #     subquery contained in the expression subtree rooted at this node. The
  #     referenced `SCALAR` subquery may not necessarily be a direct child of
  #     this node.
  class ShortRepresentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Integer]
    class SubqueriesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The kind of {::Google::Cloud::Spanner::V1::PlanNode PlanNode}. Distinguishes between the two different kinds of
  # nodes that can appear in a query plan.
  module Kind
    # Not specified.
    KIND_UNSPECIFIED = 0

    # Denotes a Relational operator node in the expression tree. Relational
    # operators represent iterative processing of rows during query execution.
    # For example, a `TableScan` operation that reads rows from a table.
    RELATIONAL = 1

    # Denotes a Scalar node in the expression tree. Scalar nodes represent
    # non-iterable entities in the query plan. For example, constants or
    # arithmetic operators appearing inside predicate expressions or references
    # to column names.
    SCALAR = 2
  end
end