vendor/google.golang.org/genproto/googleapis/spanner/v1/query_plan.pb.go

   1 // Code generated by protoc-gen-go. DO NOT EDIT.
   2 // source: google/spanner/v1/query_plan.proto
   3
   4 package spanner
   5
   6 import proto "github.com/golang/protobuf/proto"
   7 import fmt "fmt"
   8 import math "math"
   9 import _ "google.golang.org/genproto/googleapis/api/annotations"
  10 import google_protobuf1 "github.com/golang/protobuf/ptypes/struct"
  11
  12 // Reference imports to suppress errors if they are not otherwise used.
  13 var _ = proto.Marshal
  14 var _ = fmt.Errorf
  15 var _ = math.Inf
  16
  17 // The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of
  18 // nodes that can appear in a query plan.
  19 type PlanNode_Kind int32
  20
  21 const (
  22         // Not specified.
  23         PlanNode_KIND_UNSPECIFIED PlanNode_Kind = 0
  24         // Denotes a Relational operator node in the expression tree. Relational
  25         // operators represent iterative processing of rows during query execution.
  26         // For example, a `TableScan` operation that reads rows from a table.
  27         PlanNode_RELATIONAL PlanNode_Kind = 1
  28         // Denotes a Scalar node in the expression tree. Scalar nodes represent
  29         // non-iterable entities in the query plan. For example, constants or
  30         // arithmetic operators appearing inside predicate expressions or references
  31         // to column names.
  32         PlanNode_SCALAR PlanNode_Kind = 2
  33 )
  34
  35 var PlanNode_Kind_name = map[int32]string{
  36         0: "KIND_UNSPECIFIED",
  37         1: "RELATIONAL",
  38         2: "SCALAR",
  39 }
  40 var PlanNode_Kind_value = map[string]int32{
  41         "KIND_UNSPECIFIED": 0,
  42         "RELATIONAL":       1,
  43         "SCALAR":           2,
  44 }
  45
  46 func (x PlanNode_Kind) String() string {
  47         return proto.EnumName(PlanNode_Kind_name, int32(x))
  48 }
  49 func (PlanNode_Kind) EnumDescriptor() ([]byte, []int) { return fileDescriptor2, []int{0, 0} }
  50
  51 // Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
  52 type PlanNode struct {
  53         // The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
  54         Index int32 `protobuf:"varint,1,opt,name=index" json:"index,omitempty"`
  55         // Used to determine the type of node. May be needed for visualizing
  56         // different kinds of nodes differently. For example, If the node is a
  57         // [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation
  58         // which can be used to directly embed a description of the node in its
  59         // parent.
  60         Kind PlanNode_Kind `protobuf:"varint,2,opt,name=kind,enum=google.spanner.v1.PlanNode_Kind" json:"kind,omitempty"`
  61         // The display name for the node.
  62         DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
  63         // List of child node `index`es and their relationship to this parent.
  64         ChildLinks []*PlanNode_ChildLink `protobuf:"bytes,4,rep,name=child_links,json=childLinks" json:"child_links,omitempty"`
  65         // Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
  66         ShortRepresentation *PlanNode_ShortRepresentation `protobuf:"bytes,5,opt,name=short_representation,json=shortRepresentation" json:"short_representation,omitempty"`
  67         // Attributes relevant to the node contained in a group of key-value pairs.
  68         // For example, a Parameter Reference node could have the following
  69         // information in its metadata:
  70         //
  71         //     {
  72         //       "parameter_reference": "param1",
  73         //       "parameter_type": "array"
  74         //     }
  75         Metadata *google_protobuf1.Struct `protobuf:"bytes,6,opt,name=metadata" json:"metadata,omitempty"`
  76         // The execution statistics associated with the node, contained in a group of
  77         // key-value pairs. Only present if the plan was returned as a result of a
  78         // profile query. For example, number of executions, number of rows/time per
  79         // execution etc.
  80         ExecutionStats *google_protobuf1.Struct `protobuf:"bytes,7,opt,name=execution_stats,json=executionStats" json:"execution_stats,omitempty"`
  81 }
  82
  83 func (m *PlanNode) Reset()                    { *m = PlanNode{} }
  84 func (m *PlanNode) String() string            { return proto.CompactTextString(m) }
  85 func (*PlanNode) ProtoMessage()               {}
  86 func (*PlanNode) Descriptor() ([]byte, []int) { return fileDescriptor2, []int{0} }
  87
  88 func (m *PlanNode) GetIndex() int32 {
  89         if m != nil {
  90                 return m.Index
  91         }
  92         return 0
  93 }
  94
  95 func (m *PlanNode) GetKind() PlanNode_Kind {
  96         if m != nil {
  97                 return m.Kind
  98         }
  99         return PlanNode_KIND_UNSPECIFIED
 100 }
 101
 102 func (m *PlanNode) GetDisplayName() string {
 103         if m != nil {
 104                 return m.DisplayName
 105         }
 106         return ""
 107 }
 108
 109 func (m *PlanNode) GetChildLinks() []*PlanNode_ChildLink {
 110         if m != nil {
 111                 return m.ChildLinks
 112         }
 113         return nil
 114 }
 115
 116 func (m *PlanNode) GetShortRepresentation() *PlanNode_ShortRepresentation {
 117         if m != nil {
 118                 return m.ShortRepresentation
 119         }
 120         return nil
 121 }
 122
 123 func (m *PlanNode) GetMetadata() *google_protobuf1.Struct {
 124         if m != nil {
 125                 return m.Metadata
 126         }
 127         return nil
 128 }
 129
 130 func (m *PlanNode) GetExecutionStats() *google_protobuf1.Struct {
 131         if m != nil {
 132                 return m.ExecutionStats
 133         }
 134         return nil
 135 }
 136
 137 // Metadata associated with a parent-child relationship appearing in a
 138 // [PlanNode][google.spanner.v1.PlanNode].
 139 type PlanNode_ChildLink struct {
 140         // The node to which the link points.
 141         ChildIndex int32 `protobuf:"varint,1,opt,name=child_index,json=childIndex" json:"child_index,omitempty"`
 142         // The type of the link. For example, in Hash Joins this could be used to
 143         // distinguish between the build child and the probe child, or in the case
 144         // of the child being an output variable, to represent the tag associated
 145         // with the output variable.
 146         Type string `protobuf:"bytes,2,opt,name=type" json:"type,omitempty"`
 147         // Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds
 148         // to an output variable of the parent node. The field carries the name of
 149         // the output variable.
 150         // For example, a `TableScan` operator that reads rows from a table will
 151         // have child links to the `SCALAR` nodes representing the output variables
 152         // created for each column that is read by the operator. The corresponding
 153         // `variable` fields will be set to the variable names assigned to the
 154         // columns.
 155         Variable string `protobuf:"bytes,3,opt,name=variable" json:"variable,omitempty"`
 156 }
 157
 158 func (m *PlanNode_ChildLink) Reset()                    { *m = PlanNode_ChildLink{} }
 159 func (m *PlanNode_ChildLink) String() string            { return proto.CompactTextString(m) }
 160 func (*PlanNode_ChildLink) ProtoMessage()               {}
 161 func (*PlanNode_ChildLink) Descriptor() ([]byte, []int) { return fileDescriptor2, []int{0, 0} }
 162
 163 func (m *PlanNode_ChildLink) GetChildIndex() int32 {
 164         if m != nil {
 165                 return m.ChildIndex
 166         }
 167         return 0
 168 }
 169
 170 func (m *PlanNode_ChildLink) GetType() string {
 171         if m != nil {
 172                 return m.Type
 173         }
 174         return ""
 175 }
 176
 177 func (m *PlanNode_ChildLink) GetVariable() string {
 178         if m != nil {
 179                 return m.Variable
 180         }
 181         return ""
 182 }
 183
 184 // Condensed representation of a node and its subtree. Only present for
 185 // `SCALAR` [PlanNode(s)][google.spanner.v1.PlanNode].
 186 type PlanNode_ShortRepresentation struct {
 187         // A string representation of the expression subtree rooted at this node.
 188         Description string `protobuf:"bytes,1,opt,name=description" json:"description,omitempty"`
 189         // A mapping of (subquery variable name) -> (subquery node id) for cases
 190         // where the `description` string of this node references a `SCALAR`
 191         // subquery contained in the expression subtree rooted at this node. The
 192         // referenced `SCALAR` subquery may not necessarily be a direct child of
 193         // this node.
 194         Subqueries map[string]int32 `protobuf:"bytes,2,rep,name=subqueries" json:"subqueries,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value"`
 195 }
 196
 197 func (m *PlanNode_ShortRepresentation) Reset()                    { *m = PlanNode_ShortRepresentation{} }
 198 func (m *PlanNode_ShortRepresentation) String() string            { return proto.CompactTextString(m) }
 199 func (*PlanNode_ShortRepresentation) ProtoMessage()               {}
 200 func (*PlanNode_ShortRepresentation) Descriptor() ([]byte, []int) { return fileDescriptor2, []int{0, 1} }
 201
 202 func (m *PlanNode_ShortRepresentation) GetDescription() string {
 203         if m != nil {
 204                 return m.Description
 205         }
 206         return ""
 207 }
 208
 209 func (m *PlanNode_ShortRepresentation) GetSubqueries() map[string]int32 {
 210         if m != nil {
 211                 return m.Subqueries
 212         }
 213         return nil
 214 }
 215
 216 // Contains an ordered list of nodes appearing in the query plan.
 217 type QueryPlan struct {
 218         // The nodes in the query plan. Plan nodes are returned in pre-order starting
 219         // with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id` corresponds to its index in
 220         // `plan_nodes`.
 221         PlanNodes []*PlanNode `protobuf:"bytes,1,rep,name=plan_nodes,json=planNodes" json:"plan_nodes,omitempty"`
 222 }
 223
 224 func (m *QueryPlan) Reset()                    { *m = QueryPlan{} }
 225 func (m *QueryPlan) String() string            { return proto.CompactTextString(m) }
 226 func (*QueryPlan) ProtoMessage()               {}
 227 func (*QueryPlan) Descriptor() ([]byte, []int) { return fileDescriptor2, []int{1} }
 228
 229 func (m *QueryPlan) GetPlanNodes() []*PlanNode {
 230         if m != nil {
 231                 return m.PlanNodes
 232         }
 233         return nil
 234 }
 235
 236 func init() {
 237         proto.RegisterType((*PlanNode)(nil), "google.spanner.v1.PlanNode")
 238         proto.RegisterType((*PlanNode_ChildLink)(nil), "google.spanner.v1.PlanNode.ChildLink")
 239         proto.RegisterType((*PlanNode_ShortRepresentation)(nil), "google.spanner.v1.PlanNode.ShortRepresentation")
 240         proto.RegisterType((*QueryPlan)(nil), "google.spanner.v1.QueryPlan")
 241         proto.RegisterEnum("google.spanner.v1.PlanNode_Kind", PlanNode_Kind_name, PlanNode_Kind_value)
 242 }
 243
 244 func init() { proto.RegisterFile("google/spanner/v1/query_plan.proto", fileDescriptor2) }
 245
 246 var fileDescriptor2 = []byte{
 247         // 588 bytes of a gzipped FileDescriptorProto
 248         0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x94, 0x54, 0xd1, 0x6e, 0xd3, 0x30,
 249         0x14, 0x25, 0x5d, 0x5b, 0xd6, 0x5b, 0xd4, 0x15, 0x6f, 0x68, 0x51, 0x41, 0x22, 0x54, 0x42, 0xea,
 250         0x53, 0xa2, 0x6d, 0x3c, 0x4c, 0x43, 0x08, 0xba, 0xae, 0x9b, 0xaa, 0x55, 0xa5, 0x38, 0xc0, 0x03,
 251         0x42, 0x8a, 0xdc, 0xc6, 0x74, 0x56, 0x53, 0x3b, 0xc4, 0x4e, 0xb5, 0x3e, 0xf0, 0x0b, 0x7c, 0x08,
 252         0x3f, 0xc4, 0xef, 0x20, 0x3b, 0x69, 0x18, 0x14, 0x55, 0xe2, 0xed, 0x5e, 0xdf, 0x73, 0x4f, 0x7c,
 253         0xcf, 0xb9, 0x0e, 0xb4, 0x67, 0x42, 0xcc, 0x22, 0xea, 0xc9, 0x98, 0x70, 0x4e, 0x13, 0x6f, 0x79,
 254         0xe4, 0x7d, 0x4d, 0x69, 0xb2, 0x0a, 0xe2, 0x88, 0x70, 0x37, 0x4e, 0x84, 0x12, 0xe8, 0x61, 0x86,
 255         0x71, 0x73, 0x8c, 0xbb, 0x3c, 0x6a, 0x3d, 0xc9, 0xdb, 0x48, 0xcc, 0x3c, 0xc2, 0xb9, 0x50, 0x44,
 256         0x31, 0xc1, 0x65, 0xd6, 0x50, 0x54, 0x4d, 0x36, 0x49, 0xbf, 0x78, 0x52, 0x25, 0xe9, 0x54, 0x65,
 257         0xd5, 0xf6, 0xf7, 0x2a, 0xec, 0x8e, 0x23, 0xc2, 0x47, 0x22, 0xa4, 0xe8, 0x00, 0x2a, 0x8c, 0x87,
 258         0xf4, 0xd6, 0xb6, 0x1c, 0xab, 0x53, 0xc1, 0x59, 0x82, 0x5e, 0x40, 0x79, 0xce, 0x78, 0x68, 0x97,
 259         0x1c, 0xab, 0xd3, 0x38, 0x76, 0xdc, 0x8d, 0x0b, 0xb8, 0x6b, 0x02, 0xf7, 0x9a, 0xf1, 0x10, 0x1b,
 260         0x34, 0x7a, 0x06, 0x0f, 0x42, 0x26, 0xe3, 0x88, 0xac, 0x02, 0x4e, 0x16, 0xd4, 0xde, 0x71, 0xac,
 261         0x4e, 0x0d, 0xd7, 0xf3, 0xb3, 0x11, 0x59, 0x50, 0x74, 0x09, 0xf5, 0xe9, 0x0d, 0x8b, 0xc2, 0x20,
 262         0x62, 0x7c, 0x2e, 0xed, 0xb2, 0xb3, 0xd3, 0xa9, 0x1f, 0x3f, 0xdf, 0xc6, 0xdf, 0xd3, 0xf0, 0x21,
 263         0xe3, 0x73, 0x0c, 0xd3, 0x75, 0x28, 0xd1, 0x04, 0x0e, 0xe4, 0x8d, 0x48, 0x54, 0x90, 0xd0, 0x38,
 264         0xa1, 0x92, 0xf2, 0x4c, 0x00, 0xbb, 0xe2, 0x58, 0x9d, 0xfa, 0xb1, 0xb7, 0x8d, 0xd0, 0xd7, 0x7d,
 265         0xf8, 0x8f, 0x36, 0xbc, 0x2f, 0x37, 0x0f, 0xd1, 0x09, 0xec, 0x2e, 0xa8, 0x22, 0x21, 0x51, 0xc4,
 266         0xae, 0x1a, 0xde, 0xc3, 0x35, 0xef, 0x5a, 0x58, 0xd7, 0x37, 0xc2, 0xe2, 0x02, 0x88, 0xde, 0xc0,
 267         0x1e, 0xbd, 0xa5, 0xd3, 0x54, 0x33, 0x04, 0x52, 0x11, 0x25, 0xed, 0xfb, 0xdb, 0x7b, 0x1b, 0x05,
 268         0xde, 0xd7, 0xf0, 0xd6, 0x67, 0xa8, 0x15, 0x33, 0xa3, 0xa7, 0x6b, 0xbd, 0xee, 0x9a, 0x94, 0x09,
 269         0x31, 0x30, 0x4e, 0x21, 0x28, 0xab, 0x55, 0x4c, 0x8d, 0x53, 0x35, 0x6c, 0x62, 0xd4, 0x82, 0xdd,
 270         0x25, 0x49, 0x18, 0x99, 0x44, 0x6b, 0x0f, 0x8a, 0xbc, 0xf5, 0xd3, 0x82, 0xfd, 0x7f, 0x28, 0x80,
 271         0x1c, 0xa8, 0x87, 0x54, 0x4e, 0x13, 0x16, 0x1b, 0x1d, 0xad, 0xdc, 0xba, 0xdf, 0x47, 0x28, 0x00,
 272         0x90, 0xe9, 0x44, 0x2f, 0x27, 0xa3, 0xd2, 0x2e, 0x19, 0xe7, 0x5e, 0xff, 0xa7, 0xd0, 0xae, 0x5f,
 273         0x30, 0xf4, 0xb9, 0x4a, 0x56, 0xf8, 0x0e, 0x65, 0xeb, 0x15, 0xec, 0xfd, 0x55, 0x46, 0x4d, 0xd8,
 274         0x99, 0xd3, 0x55, 0x7e, 0x1b, 0x1d, 0xea, 0x7d, 0x5d, 0x92, 0x28, 0xcd, 0x06, 0xae, 0xe0, 0x2c,
 275         0x39, 0x2b, 0x9d, 0x5a, 0xed, 0x53, 0x28, 0xeb, 0x5d, 0x44, 0x07, 0xd0, 0xbc, 0x1e, 0x8c, 0x2e,
 276         0x82, 0x0f, 0x23, 0x7f, 0xdc, 0xef, 0x0d, 0x2e, 0x07, 0xfd, 0x8b, 0xe6, 0x3d, 0xd4, 0x00, 0xc0,
 277         0xfd, 0x61, 0xf7, 0xfd, 0xe0, 0xed, 0xa8, 0x3b, 0x6c, 0x5a, 0x08, 0xa0, 0xea, 0xf7, 0xba, 0xc3,
 278         0x2e, 0x6e, 0x96, 0xda, 0x57, 0x50, 0x7b, 0xa7, 0xdf, 0x9c, 0xbe, 0x39, 0x3a, 0x03, 0xd0, 0x4f,
 279         0x2f, 0xe0, 0x22, 0xa4, 0xd2, 0xb6, 0xcc, 0x98, 0x8f, 0xb7, 0x8c, 0x89, 0x6b, 0x71, 0x1e, 0xc9,
 280         0xf3, 0x6f, 0xf0, 0x68, 0x2a, 0x16, 0x9b, 0xe0, 0xf3, 0x46, 0xc1, 0x3f, 0xd6, 0xee, 0x8f, 0xad,
 281         0x4f, 0xa7, 0x39, 0x68, 0x26, 0x22, 0xc2, 0x67, 0xae, 0x48, 0x66, 0xde, 0x8c, 0x72, 0xb3, 0x1b,
 282         0x5e, 0x56, 0x22, 0x31, 0x93, 0x77, 0x7e, 0x0b, 0x2f, 0xf3, 0xf0, 0x47, 0xe9, 0xf0, 0x2a, 0x6b,
 283         0xed, 0x45, 0x22, 0x0d, 0x5d, 0x3f, 0xff, 0xca, 0xc7, 0xa3, 0x49, 0xd5, 0xb4, 0x9f, 0xfc, 0x0a,
 284         0x00, 0x00, 0xff, 0xff, 0xcc, 0x06, 0x5f, 0x9c, 0x54, 0x04, 0x00, 0x00,
 285 }