google-cloud-spanner-v1 0.1.0

data/proto_docs/google/rpc/status.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Rpc
+    # The `Status` type defines a logical error model that is suitable for
+    # different programming environments, including REST APIs and RPC APIs. It is
+    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+    # three pieces of data: error code, error message, and error details.
+    #
+    # You can find out more about this error model and how to work with it in the
+    # [API Design Guide](https://cloud.google.com/apis/design/errors).
+    # @!attribute [rw] code
+    #   @return [::Integer]
+    #     The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+    # @!attribute [rw] message
+    #   @return [::String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
+    # @!attribute [rw] details
+    #   @return [::Array<::Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/spanner/v1/keys.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        # KeyRange represents a range of rows in a table or index.
+        #
+        # A range has a start key and an end key. These keys can be open or
+        # closed, indicating if the range includes rows with that key.
+        #
+        # Keys are represented by lists, where the ith value in the list
+        # corresponds to the ith component of the table or index primary key.
+        # Individual values are encoded as described
+        # {::Google::Cloud::Spanner::V1::TypeCode here}.
+        #
+        # For example, consider the following table definition:
+        #
+        #     CREATE TABLE UserEvents (
+        #       UserName STRING(MAX),
+        #       EventDate STRING(10)
+        #     ) PRIMARY KEY(UserName, EventDate);
+        #
+        # The following keys name rows in this table:
+        #
+        #     ["Bob", "2014-09-23"]
+        #     ["Alfred", "2015-06-12"]
+        #
+        # Since the `UserEvents` table's `PRIMARY KEY` clause names two
+        # columns, each `UserEvents` key has two elements; the first is the
+        # `UserName`, and the second is the `EventDate`.
+        #
+        # Key ranges with multiple components are interpreted
+        # lexicographically by component using the table or index key's declared
+        # sort order. For example, the following range returns all events for
+        # user `"Bob"` that occurred in the year 2015:
+        #
+        #     "start_closed": ["Bob", "2015-01-01"]
+        #     "end_closed": ["Bob", "2015-12-31"]
+        #
+        # Start and end keys can omit trailing key components. This affects the
+        # inclusion and exclusion of rows that exactly match the provided key
+        # components: if the key is closed, then rows that exactly match the
+        # provided components are included; if the key is open, then rows
+        # that exactly match are not included.
+        #
+        # For example, the following range includes all events for `"Bob"` that
+        # occurred during and after the year 2000:
+        #
+        #     "start_closed": ["Bob", "2000-01-01"]
+        #     "end_closed": ["Bob"]
+        #
+        # The next example retrieves all events for `"Bob"`:
+        #
+        #     "start_closed": ["Bob"]
+        #     "end_closed": ["Bob"]
+        #
+        # To retrieve events before the year 2000:
+        #
+        #     "start_closed": ["Bob"]
+        #     "end_open": ["Bob", "2000-01-01"]
+        #
+        # The following range includes all rows in the table:
+        #
+        #     "start_closed": []
+        #     "end_closed": []
+        #
+        # This range returns all users whose `UserName` begins with any
+        # character from A to C:
+        #
+        #     "start_closed": ["A"]
+        #     "end_open": ["D"]
+        #
+        # This range returns all users whose `UserName` begins with B:
+        #
+        #     "start_closed": ["B"]
+        #     "end_open": ["C"]
+        #
+        # Key ranges honor column sort order. For example, suppose a table is
+        # defined as follows:
+        #
+        #     CREATE TABLE DescendingSortedTable {
+        #       Key INT64,
+        #       ...
+        #     ) PRIMARY KEY(Key DESC);
+        #
+        # The following range retrieves all rows with key values between 1
+        # and 100 inclusive:
+        #
+        #     "start_closed": ["100"]
+        #     "end_closed": ["1"]
+        #
+        # Note that 100 is passed as the start, and 1 is passed as the end,
+        # because `Key` is a descending column in the schema.
+        # @!attribute [rw] start_closed
+        #   @return [::Google::Protobuf::ListValue]
+        #     If the start is closed, then the range includes all rows whose
+        #     first `len(start_closed)` key columns exactly match `start_closed`.
+        # @!attribute [rw] start_open
+        #   @return [::Google::Protobuf::ListValue]
+        #     If the start is open, then the range excludes rows whose first
+        #     `len(start_open)` key columns exactly match `start_open`.
+        # @!attribute [rw] end_closed
+        #   @return [::Google::Protobuf::ListValue]
+        #     If the end is closed, then the range includes all rows whose
+        #     first `len(end_closed)` key columns exactly match `end_closed`.
+        # @!attribute [rw] end_open
+        #   @return [::Google::Protobuf::ListValue]
+        #     If the end is open, then the range excludes rows whose first
+        #     `len(end_open)` key columns exactly match `end_open`.
+        class KeyRange
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All
+        # the keys are expected to be in the same table or index. The keys need
+        # not be sorted in any particular way.
+        #
+        # If the same key is specified multiple times in the set (for example
+        # if two ranges, two keys, or a key and a range overlap), Cloud Spanner
+        # behaves as if the key were only specified once.
+        # @!attribute [rw] keys
+        #   @return [::Array<::Google::Protobuf::ListValue>]
+        #     A list of specific keys. Entries in `keys` should have exactly as
+        #     many elements as there are columns in the primary or index key
+        #     with which this `KeySet` is used.  Individual key values are
+        #     encoded as described {::Google::Cloud::Spanner::V1::TypeCode here}.
+        # @!attribute [rw] ranges
+        #   @return [::Array<::Google::Cloud::Spanner::V1::KeyRange>]
+        #     A list of key ranges. See {::Google::Cloud::Spanner::V1::KeyRange KeyRange} for more information about
+        #     key range specifications.
+        # @!attribute [rw] all
+        #   @return [::Boolean]
+        #     For convenience `all` can be set to `true` to indicate that this
+        #     `KeySet` matches all keys in the table or index. Note that any keys
+        #     specified in `keys` or `ranges` are only yielded once.
+        class KeySet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/spanner/v1/mutation.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        # A modification to one or more Cloud Spanner rows.  Mutations can be
+        # applied to a Cloud Spanner database by sending them in a
+        # {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit} call.
+        # @!attribute [rw] insert
+        #   @return [::Google::Cloud::Spanner::V1::Mutation::Write]
+        #     Insert new rows in a table. If any of the rows already exist,
+        #     the write or transaction fails with error `ALREADY_EXISTS`.
+        # @!attribute [rw] update
+        #   @return [::Google::Cloud::Spanner::V1::Mutation::Write]
+        #     Update existing rows in a table. If any of the rows does not
+        #     already exist, the transaction fails with error `NOT_FOUND`.
+        # @!attribute [rw] insert_or_update
+        #   @return [::Google::Cloud::Spanner::V1::Mutation::Write]
+        #     Like {::Google::Cloud::Spanner::V1::Mutation#insert insert}, except that if the row already exists, then
+        #     its column values are overwritten with the ones provided. Any
+        #     column values not explicitly written are preserved.
+        #
+        #     When using {::Google::Cloud::Spanner::V1::Mutation#insert_or_update insert_or_update}, just as when using {::Google::Cloud::Spanner::V1::Mutation#insert insert}, all `NOT
+        #     NULL` columns in the table must be given a value. This holds true
+        #     even when the row already exists and will therefore actually be updated.
+        # @!attribute [rw] replace
+        #   @return [::Google::Cloud::Spanner::V1::Mutation::Write]
+        #     Like {::Google::Cloud::Spanner::V1::Mutation#insert insert}, except that if the row already exists, it is
+        #     deleted, and the column values provided are inserted
+        #     instead. Unlike {::Google::Cloud::Spanner::V1::Mutation#insert_or_update insert_or_update}, this means any values not
+        #     explicitly written become `NULL`.
+        #
+        #     In an interleaved table, if you create the child table with the
+        #     `ON DELETE CASCADE` annotation, then replacing a parent row
+        #     also deletes the child rows. Otherwise, you must delete the
+        #     child rows before you replace the parent row.
+        # @!attribute [rw] delete
+        #   @return [::Google::Cloud::Spanner::V1::Mutation::Delete]
+        #     Delete rows from a table. Succeeds whether or not the named
+        #     rows were present.
+        class Mutation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Arguments to {::Google::Cloud::Spanner::V1::Mutation#insert insert}, {::Google::Cloud::Spanner::V1::Mutation#update update}, {::Google::Cloud::Spanner::V1::Mutation#insert_or_update insert_or_update}, and
+          # {::Google::Cloud::Spanner::V1::Mutation#replace replace} operations.
+          # @!attribute [rw] table
+          #   @return [::String]
+          #     Required. The table whose rows will be written.
+          # @!attribute [rw] columns
+          #   @return [::Array<::String>]
+          #     The names of the columns in {::Google::Cloud::Spanner::V1::Mutation::Write#table table} to be written.
+          #
+          #     The list of columns must contain enough columns to allow
+          #     Cloud Spanner to derive values for all primary key columns in the
+          #     row(s) to be modified.
+          # @!attribute [rw] values
+          #   @return [::Array<::Google::Protobuf::ListValue>]
+          #     The values to be written. `values` can contain more than one
+          #     list of values. If it does, then multiple rows are written, one
+          #     for each entry in `values`. Each list in `values` must have
+          #     exactly as many entries as there are entries in {::Google::Cloud::Spanner::V1::Mutation::Write#columns columns}
+          #     above. Sending multiple lists is equivalent to sending multiple
+          #     `Mutation`s, each containing one `values` entry and repeating
+          #     {::Google::Cloud::Spanner::V1::Mutation::Write#table table} and {::Google::Cloud::Spanner::V1::Mutation::Write#columns columns}. Individual values in each list are
+          #     encoded as described {::Google::Cloud::Spanner::V1::TypeCode here}.
+          class Write
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Arguments to {::Google::Cloud::Spanner::V1::Mutation#delete delete} operations.
+          # @!attribute [rw] table
+          #   @return [::String]
+          #     Required. The table whose rows will be deleted.
+          # @!attribute [rw] key_set
+          #   @return [::Google::Cloud::Spanner::V1::KeySet]
+          #     Required. The primary keys of the rows within {::Google::Cloud::Spanner::V1::Mutation::Delete#table table} to delete.  The
+          #     primary keys must be specified in the order in which they appear in the
+          #     `PRIMARY KEY()` clause of the table's equivalent DDL statement (the DDL
+          #     statement used to create the table).
+          #     Delete is idempotent. The transaction will succeed even if some or all
+          #     rows do not exist.
+          class Delete
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/spanner/v1/query_plan.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        # Node information for nodes appearing in a {::Google::Cloud::Spanner::V1::QueryPlan#plan_nodes QueryPlan.plan_nodes}.
+        # @!attribute [rw] index
+        #   @return [::Integer]
+        #     The `PlanNode`'s index in {::Google::Cloud::Spanner::V1::QueryPlan#plan_nodes node list}.
+        # @!attribute [rw] kind
+        #   @return [::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
+        #     {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} node, it will have a condensed representation
+        #     which can be used to directly embed a description of the node in its
+        #     parent.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name for the node.
+        # @!attribute [rw] child_links
+        #   @return [::Array<::Google::Cloud::Spanner::V1::PlanNode::ChildLink>]
+        #     List of child node `index`es and their relationship to this parent.
+        # @!attribute [rw] short_representation
+        #   @return [::Google::Cloud::Spanner::V1::PlanNode::ShortRepresentation]
+        #     Condensed representation for {::Google::Cloud::Spanner::V1::PlanNode::Kind::SCALAR SCALAR} nodes.
+        # @!attribute [rw] metadata
+        #   @return [::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"
+        #         }
+        # @!attribute [rw] execution_stats
+        #   @return [::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.
+        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
+
+        # Contains an ordered list of nodes appearing in the query plan.
+        # @!attribute [rw] plan_nodes
+        #   @return [::Array<::Google::Cloud::Spanner::V1::PlanNode>]
+        #     The nodes in the query plan. Plan nodes are returned in pre-order starting
+        #     with the plan root. Each {::Google::Cloud::Spanner::V1::PlanNode PlanNode}'s `id` corresponds to its index in
+        #     `plan_nodes`.
+        class QueryPlan
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end