google-cloud-spanner-v1 0.1.0

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

@@ -0,0 +1,208 @@
+# 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
+        # Results from {::Google::Cloud::Spanner::V1::Spanner::Client#read Read} or
+        # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql}.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::Spanner::V1::ResultSetMetadata]
+        #     Metadata about the result set, such as row type information.
+        # @!attribute [rw] rows
+        #   @return [::Array<::Google::Protobuf::ListValue>]
+        #     Each element in `rows` is a row whose format is defined by
+        #     {::Google::Cloud::Spanner::V1::ResultSetMetadata#row_type metadata.row_type}. The ith element
+        #     in each row matches the ith field in
+        #     {::Google::Cloud::Spanner::V1::ResultSetMetadata#row_type metadata.row_type}. Elements are
+        #     encoded based on type as described
+        #     {::Google::Cloud::Spanner::V1::TypeCode here}.
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Spanner::V1::ResultSetStats]
+        #     Query plan and execution statistics for the SQL statement that
+        #     produced this result set. These can be requested by setting
+        #     {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#query_mode ExecuteSqlRequest.query_mode}.
+        #     DML statements always produce stats containing the number of rows
+        #     modified, unless executed using the
+        #     {::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode::PLAN ExecuteSqlRequest.QueryMode.PLAN} {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#query_mode ExecuteSqlRequest.query_mode}.
+        #     Other fields may or may not be populated, based on the
+        #     {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#query_mode ExecuteSqlRequest.query_mode}.
+        class ResultSet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Partial results from a streaming read or SQL query. Streaming reads and
+        # SQL queries better tolerate large result sets, large rows, and large
+        # values, but are a little trickier to consume.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::Spanner::V1::ResultSetMetadata]
+        #     Metadata about the result set, such as row type information.
+        #     Only present in the first response.
+        # @!attribute [rw] values
+        #   @return [::Array<::Google::Protobuf::Value>]
+        #     A streamed result set consists of a stream of values, which might
+        #     be split into many `PartialResultSet` messages to accommodate
+        #     large rows and/or large values. Every N complete values defines a
+        #     row, where N is equal to the number of entries in
+        #     {::Google::Cloud::Spanner::V1::StructType#fields metadata.row_type.fields}.
+        #
+        #     Most values are encoded based on type as described
+        #     {::Google::Cloud::Spanner::V1::TypeCode here}.
+        #
+        #     It is possible that the last value in values is "chunked",
+        #     meaning that the rest of the value is sent in subsequent
+        #     `PartialResultSet`(s). This is denoted by the {::Google::Cloud::Spanner::V1::PartialResultSet#chunked_value chunked_value}
+        #     field. Two or more chunked values can be merged to form a
+        #     complete value as follows:
+        #
+        #       * `bool/number/null`: cannot be chunked
+        #       * `string`: concatenate the strings
+        #       * `list`: concatenate the lists. If the last element in a list is a
+        #         `string`, `list`, or `object`, merge it with the first element in
+        #         the next list by applying these rules recursively.
+        #       * `object`: concatenate the (field name, field value) pairs. If a
+        #         field name is duplicated, then apply these rules recursively
+        #         to merge the field values.
+        #
+        #     Some examples of merging:
+        #
+        #         # Strings are concatenated.
+        #         "foo", "bar" => "foobar"
+        #
+        #         # Lists of non-strings are concatenated.
+        #         [2, 3], [4] => [2, 3, 4]
+        #
+        #         # Lists are concatenated, but the last and first elements are merged
+        #         # because they are strings.
+        #         ["a", "b"], ["c", "d"] => ["a", "bc", "d"]
+        #
+        #         # Lists are concatenated, but the last and first elements are merged
+        #         # because they are lists. Recursively, the last and first elements
+        #         # of the inner lists are merged because they are strings.
+        #         ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]
+        #
+        #         # Non-overlapping object fields are combined.
+        #         {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}
+        #
+        #         # Overlapping object fields are merged.
+        #         {"a": "1"}, {"a": "2"} => {"a": "12"}
+        #
+        #         # Examples of merging objects containing lists of strings.
+        #         {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}
+        #
+        #     For a more complete example, suppose a streaming SQL query is
+        #     yielding a result set whose rows contain a single string
+        #     field. The following `PartialResultSet`s might be yielded:
+        #
+        #         {
+        #           "metadata": { ... }
+        #           "values": ["Hello", "W"]
+        #           "chunked_value": true
+        #           "resume_token": "Af65..."
+        #         }
+        #         {
+        #           "values": ["orl"]
+        #           "chunked_value": true
+        #           "resume_token": "Bqp2..."
+        #         }
+        #         {
+        #           "values": ["d"]
+        #           "resume_token": "Zx1B..."
+        #         }
+        #
+        #     This sequence of `PartialResultSet`s encodes two rows, one
+        #     containing the field value `"Hello"`, and a second containing the
+        #     field value `"World" = "W" + "orl" + "d"`.
+        # @!attribute [rw] chunked_value
+        #   @return [::Boolean]
+        #     If true, then the final value in {::Google::Cloud::Spanner::V1::PartialResultSet#values values} is chunked, and must
+        #     be combined with more values from subsequent `PartialResultSet`s
+        #     to obtain a complete field value.
+        # @!attribute [rw] resume_token
+        #   @return [::String]
+        #     Streaming calls might be interrupted for a variety of reasons, such
+        #     as TCP connection loss. If this occurs, the stream of results can
+        #     be resumed by re-sending the original request and including
+        #     `resume_token`. Note that executing any other transaction in the
+        #     same session invalidates the token.
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Spanner::V1::ResultSetStats]
+        #     Query plan and execution statistics for the statement that produced this
+        #     streaming result set. These can be requested by setting
+        #     {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#query_mode ExecuteSqlRequest.query_mode} and are sent
+        #     only once with the last response in the stream.
+        #     This field will also be present in the last response for DML
+        #     statements.
+        class PartialResultSet
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata about a {::Google::Cloud::Spanner::V1::ResultSet ResultSet} or {::Google::Cloud::Spanner::V1::PartialResultSet PartialResultSet}.
+        # @!attribute [rw] row_type
+        #   @return [::Google::Cloud::Spanner::V1::StructType]
+        #     Indicates the field names and types for the rows in the result
+        #     set.  For example, a SQL query like `"SELECT UserId, UserName FROM
+        #     Users"` could return a `row_type` value like:
+        #
+        #         "fields": [
+        #           { "name": "UserId", "type": { "code": "INT64" } },
+        #           { "name": "UserName", "type": { "code": "STRING" } },
+        #         ]
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::Transaction]
+        #     If the read or SQL query began a transaction as a side-effect, the
+        #     information about the new transaction is yielded here.
+        class ResultSetMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Additional statistics about a {::Google::Cloud::Spanner::V1::ResultSet ResultSet} or {::Google::Cloud::Spanner::V1::PartialResultSet PartialResultSet}.
+        # @!attribute [rw] query_plan
+        #   @return [::Google::Cloud::Spanner::V1::QueryPlan]
+        #     {::Google::Cloud::Spanner::V1::QueryPlan QueryPlan} for the query associated with this result.
+        # @!attribute [rw] query_stats
+        #   @return [::Google::Protobuf::Struct]
+        #     Aggregated statistics from the execution of the query. Only present when
+        #     the query is profiled. For example, a query could return the statistics as
+        #     follows:
+        #
+        #         {
+        #           "rows_returned": "3",
+        #           "elapsed_time": "1.22 secs",
+        #           "cpu_time": "1.19 secs"
+        #         }
+        # @!attribute [rw] row_count_exact
+        #   @return [::Integer]
+        #     Standard DML returns an exact count of rows that were modified.
+        # @!attribute [rw] row_count_lower_bound
+        #   @return [::Integer]
+        #     Partitioned DML does not offer exactly-once semantics, so it
+        #     returns a lower bound of the rows modified.
+        class ResultSetStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,681 @@
+# 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
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#create_session CreateSession}.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Required. The database in which the new session is created.
+        # @!attribute [rw] session
+        #   @return [::Google::Cloud::Spanner::V1::Session]
+        #     The session to create.
+        class CreateSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#batch_create_sessions BatchCreateSessions}.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Required. The database in which the new sessions are created.
+        # @!attribute [rw] session_template
+        #   @return [::Google::Cloud::Spanner::V1::Session]
+        #     Parameters to be applied to each created session.
+        # @!attribute [rw] session_count
+        #   @return [::Integer]
+        #     Required. The number of sessions to be created in this batch call.
+        #     The API may return fewer than the requested number of sessions. If a
+        #     specific number of sessions are desired, the client can make additional
+        #     calls to BatchCreateSessions (adjusting
+        #     {::Google::Cloud::Spanner::V1::BatchCreateSessionsRequest#session_count session_count} as necessary).
+        class BatchCreateSessionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#batch_create_sessions BatchCreateSessions}.
+        # @!attribute [rw] session
+        #   @return [::Array<::Google::Cloud::Spanner::V1::Session>]
+        #     The freshly created sessions.
+        class BatchCreateSessionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A session in the Cloud Spanner API.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the session. This is always system-assigned; values provided
+        #     when creating a session are ignored.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The labels for the session.
+        #
+        #      * Label keys must be between 1 and 63 characters long and must conform to
+        #        the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
+        #      * Label values must be between 0 and 63 characters long and must conform
+        #        to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
+        #      * No more than 64 labels can be associated with a given session.
+        #
+        #     See https://goo.gl/xmQnxf for more information on and examples of labels.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the session is created.
+        # @!attribute [rw] approximate_last_use_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The approximate timestamp when the session is last used. It is
+        #     typically earlier than the actual last use time.
+        class Session
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#get_session GetSession}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the session to retrieve.
+        class GetSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#list_sessions ListSessions}.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Required. The database in which to list sessions.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Number of sessions to be returned in the response. If 0 or less, defaults
+        #     to the server's maximum allowed page size.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     If non-empty, `page_token` should contain a
+        #     {::Google::Cloud::Spanner::V1::ListSessionsResponse#next_page_token next_page_token} from a previous
+        #     {::Google::Cloud::Spanner::V1::ListSessionsResponse ListSessionsResponse}.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     An expression for filtering the results of the request. Filter rules are
+        #     case insensitive. The fields eligible for filtering are:
+        #
+        #       * `labels.key` where key is the name of a label
+        #
+        #     Some examples of using filters are:
+        #
+        #       * `labels.env:*` --> The session has the label "env".
+        #       * `labels.env:dev` --> The session has the label "env" and the value of
+        #                            the label contains the string "dev".
+        class ListSessionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#list_sessions ListSessions}.
+        # @!attribute [rw] sessions
+        #   @return [::Array<::Google::Cloud::Spanner::V1::Session>]
+        #     The list of requested sessions.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     `next_page_token` can be sent in a subsequent
+        #     {::Google::Cloud::Spanner::V1::Spanner::Client#list_sessions ListSessions} call to fetch more of the matching
+        #     sessions.
+        class ListSessionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#delete_session DeleteSession}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the session to delete.
+        class DeleteSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql} and
+        # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the SQL query should be performed.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionSelector]
+        #     The transaction to use.
+        #
+        #     For queries, if none is provided, the default is a temporary read-only
+        #     transaction with strong concurrency.
+        #
+        #     Standard DML statements require a read-write transaction. To protect
+        #     against replays, single-use transactions are not supported.  The caller
+        #     must either supply an existing transaction ID or begin a new transaction.
+        #
+        #     Partitioned DML requires an existing Partitioned DML transaction ID.
+        # @!attribute [rw] sql
+        #   @return [::String]
+        #     Required. The SQL string.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Struct]
+        #     Parameter names and values that bind to placeholders in the SQL string.
+        #
+        #     A parameter placeholder consists of the `@` character followed by the
+        #     parameter name (for example, `@firstName`). Parameter names can contain
+        #     letters, numbers, and underscores.
+        #
+        #     Parameters can appear anywhere that a literal value is expected.  The same
+        #     parameter name can be used more than once, for example:
+        #
+        #     `"WHERE id > @msg_id AND id < @msg_id + 100"`
+        #
+        #     It is an error to execute a SQL statement with unbound parameters.
+        # @!attribute [rw] param_types
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}]
+        #     It is not always possible for Cloud Spanner to infer the right SQL type
+        #     from a JSON value.  For example, values of type `BYTES` and values
+        #     of type `STRING` both appear in {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#params params} as JSON strings.
+        #
+        #     In these cases, `param_types` can be used to specify the exact
+        #     SQL type for some or all of the SQL statement parameters. See the
+        #     definition of {::Google::Cloud::Spanner::V1::Type Type} for more information
+        #     about SQL types.
+        # @!attribute [rw] resume_token
+        #   @return [::String]
+        #     If this request is resuming a previously interrupted SQL statement
+        #     execution, `resume_token` should be copied from the last
+        #     {::Google::Cloud::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
+        #     enables the new SQL statement execution to resume where the last one left
+        #     off. The rest of the request parameters must exactly match the
+        #     request that yielded this token.
+        # @!attribute [rw] query_mode
+        #   @return [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode]
+        #     Used to control the amount of debugging information returned in
+        #     {::Google::Cloud::Spanner::V1::ResultSetStats ResultSetStats}. If {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#partition_token partition_token} is set, {::Google::Cloud::Spanner::V1::ExecuteSqlRequest#query_mode query_mode} can only
+        #     be set to {::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode::NORMAL QueryMode.NORMAL}.
+        # @!attribute [rw] partition_token
+        #   @return [::String]
+        #     If present, results will be restricted to the specified partition
+        #     previously created using PartitionQuery().  There must be an exact
+        #     match for the values of fields common to this message and the
+        #     PartitionQueryRequest message used to create this partition_token.
+        # @!attribute [rw] seqno
+        #   @return [::Integer]
+        #     A per-transaction sequence number used to identify this request. This field
+        #     makes each request idempotent such that if the request is received multiple
+        #     times, at most one will succeed.
+        #
+        #     The sequence number must be monotonically increasing within the
+        #     transaction. If a request arrives for the first time with an out-of-order
+        #     sequence number, the transaction may be aborted. Replays of previously
+        #     handled requests will yield the same response as the first execution.
+        #
+        #     Required for DML statements. Ignored for queries.
+        # @!attribute [rw] query_options
+        #   @return [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions]
+        #     Query optimizer configuration to use for the given query.
+        class ExecuteSqlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Query optimizer configuration.
+          # @!attribute [rw] optimizer_version
+          #   @return [::String]
+          #     An option to control the selection of optimizer version.
+          #
+          #     This parameter allows individual queries to pick different query
+          #     optimizer versions.
+          #
+          #     Specifying "latest" as a value instructs Cloud Spanner to use the
+          #     latest supported query optimizer version. If not specified, Cloud Spanner
+          #     uses optimizer version set at the database level options. Any other
+          #     positive integer (from the list of supported optimizer versions)
+          #     overrides the default optimizer version for query execution.
+          #     The list of supported optimizer versions can be queried from
+          #     SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
+          #     with an invalid optimizer version will fail with a syntax error
+          #     (`INVALID_ARGUMENT`) status.
+          #
+          #     The `optimizer_version` statement hint has precedence over this setting.
+          class QueryOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Spanner::V1::Type]
+          class ParamTypesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Mode in which the statement must be processed.
+          module QueryMode
+            # The default mode. Only the statement results are returned.
+            NORMAL = 0
+
+            # This mode returns only the query plan, without any results or
+            # execution statistics information.
+            PLAN = 1
+
+            # This mode returns both the query plan and the execution statistics along
+            # with the results.
+            PROFILE = 2
+          end
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#execute_batch_dml ExecuteBatchDml}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the DML statements should be performed.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionSelector]
+        #     Required. The transaction to use. Must be a read-write transaction.
+        #
+        #     To protect against replays, single-use transactions are not supported. The
+        #     caller must either supply an existing transaction ID or begin a new
+        #     transaction.
+        # @!attribute [rw] statements
+        #   @return [::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>]
+        #     Required. The list of statements to execute in this batch. Statements are executed
+        #     serially, such that the effects of statement `i` are visible to statement
+        #     `i+1`. Each statement must be a DML statement. Execution stops at the
+        #     first failed statement; the remaining statements are not executed.
+        #
+        #     Callers must provide at least one statement.
+        # @!attribute [rw] seqno
+        #   @return [::Integer]
+        #     Required. A per-transaction sequence number used to identify this request. This field
+        #     makes each request idempotent such that if the request is received multiple
+        #     times, at most one will succeed.
+        #
+        #     The sequence number must be monotonically increasing within the
+        #     transaction. If a request arrives for the first time with an out-of-order
+        #     sequence number, the transaction may be aborted. Replays of previously
+        #     handled requests will yield the same response as the first execution.
+        class ExecuteBatchDmlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A single DML statement.
+          # @!attribute [rw] sql
+          #   @return [::String]
+          #     Required. The DML string.
+          # @!attribute [rw] params
+          #   @return [::Google::Protobuf::Struct]
+          #     Parameter names and values that bind to placeholders in the DML string.
+          #
+          #     A parameter placeholder consists of the `@` character followed by the
+          #     parameter name (for example, `@firstName`). Parameter names can contain
+          #     letters, numbers, and underscores.
+          #
+          #     Parameters can appear anywhere that a literal value is expected.  The
+          #     same parameter name can be used more than once, for example:
+          #
+          #     `"WHERE id > @msg_id AND id < @msg_id + 100"`
+          #
+          #     It is an error to execute a SQL statement with unbound parameters.
+          # @!attribute [rw] param_types
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}]
+          #     It is not always possible for Cloud Spanner to infer the right SQL type
+          #     from a JSON value.  For example, values of type `BYTES` and values
+          #     of type `STRING` both appear in {::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement#params params} as JSON strings.
+          #
+          #     In these cases, `param_types` can be used to specify the exact
+          #     SQL type for some or all of the SQL statement parameters. See the
+          #     definition of {::Google::Cloud::Spanner::V1::Type Type} for more information
+          #     about SQL types.
+          class Statement
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::Spanner::V1::Type]
+            class ParamTypesEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#execute_batch_dml ExecuteBatchDml}. Contains a list
+        # of {::Google::Cloud::Spanner::V1::ResultSet ResultSet} messages, one for each DML statement that has successfully
+        # executed, in the same order as the statements in the request. If a statement
+        # fails, the status in the response body identifies the cause of the failure.
+        #
+        # To check for DML statements that failed, use the following approach:
+        #
+        # 1. Check the status in the response message. The [google.rpc.Code][google.rpc.Code] enum
+        #    value `OK` indicates that all statements were executed successfully.
+        # 2. If the status was not `OK`, check the number of result sets in the
+        #    response. If the response contains `N` {::Google::Cloud::Spanner::V1::ResultSet ResultSet} messages, then
+        #    statement `N+1` in the request failed.
+        #
+        # Example 1:
+        #
+        # * Request: 5 DML statements, all executed successfully.
+        # * Response: 5 {::Google::Cloud::Spanner::V1::ResultSet ResultSet} messages, with the status `OK`.
+        #
+        # Example 2:
+        #
+        # * Request: 5 DML statements. The third statement has a syntax error.
+        # * Response: 2 {::Google::Cloud::Spanner::V1::ResultSet ResultSet} messages, and a syntax error (`INVALID_ARGUMENT`)
+        #   status. The number of {::Google::Cloud::Spanner::V1::ResultSet ResultSet} messages indicates that the third
+        #   statement failed, and the fourth and fifth statements were not executed.
+        # @!attribute [rw] result_sets
+        #   @return [::Array<::Google::Cloud::Spanner::V1::ResultSet>]
+        #     One {::Google::Cloud::Spanner::V1::ResultSet ResultSet} for each statement in the request that ran successfully,
+        #     in the same order as the statements in the request. Each {::Google::Cloud::Spanner::V1::ResultSet ResultSet} does
+        #     not contain any rows. The {::Google::Cloud::Spanner::V1::ResultSetStats ResultSetStats} in each {::Google::Cloud::Spanner::V1::ResultSet ResultSet} contain
+        #     the number of rows modified by the statement.
+        #
+        #     Only the first {::Google::Cloud::Spanner::V1::ResultSet ResultSet} in the response contains valid
+        #     {::Google::Cloud::Spanner::V1::ResultSetMetadata ResultSetMetadata}.
+        # @!attribute [rw] status
+        #   @return [::Google::Rpc::Status]
+        #     If all DML statements are executed successfully, the status is `OK`.
+        #     Otherwise, the error status of the first failed statement.
+        class ExecuteBatchDmlResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Options for a PartitionQueryRequest and
+        # PartitionReadRequest.
+        # @!attribute [rw] partition_size_bytes
+        #   @return [::Integer]
+        #     **Note:** This hint is currently ignored by PartitionQuery and
+        #     PartitionRead requests.
+        #
+        #     The desired data size for each partition generated.  The default for this
+        #     option is currently 1 GiB.  This is only a hint. The actual size of each
+        #     partition may be smaller or larger than this size request.
+        # @!attribute [rw] max_partitions
+        #   @return [::Integer]
+        #     **Note:** This hint is currently ignored by PartitionQuery and
+        #     PartitionRead requests.
+        #
+        #     The desired maximum number of partitions to return.  For example, this may
+        #     be set to the number of workers available.  The default for this option
+        #     is currently 10,000. The maximum value is currently 200,000.  This is only
+        #     a hint.  The actual number of partitions returned may be smaller or larger
+        #     than this maximum count request.
+        class PartitionOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#partition_query PartitionQuery}
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session used to create the partitions.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionSelector]
+        #     Read only snapshot transactions are supported, read/write and single use
+        #     transactions are not.
+        # @!attribute [rw] sql
+        #   @return [::String]
+        #     Required. The query request to generate partitions for. The request will fail if
+        #     the query is not root partitionable. The query plan of a root
+        #     partitionable query has a single distributed union operator. A distributed
+        #     union operator conceptually divides one or more tables into multiple
+        #     splits, remotely evaluates a subquery independently on each split, and
+        #     then unions all results.
+        #
+        #     This must not contain DML commands, such as INSERT, UPDATE, or
+        #     DELETE. Use {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql} with a
+        #     PartitionedDml transaction for large, partition-friendly DML operations.
+        # @!attribute [rw] params
+        #   @return [::Google::Protobuf::Struct]
+        #     Parameter names and values that bind to placeholders in the SQL string.
+        #
+        #     A parameter placeholder consists of the `@` character followed by the
+        #     parameter name (for example, `@firstName`). Parameter names can contain
+        #     letters, numbers, and underscores.
+        #
+        #     Parameters can appear anywhere that a literal value is expected.  The same
+        #     parameter name can be used more than once, for example:
+        #
+        #     `"WHERE id > @msg_id AND id < @msg_id + 100"`
+        #
+        #     It is an error to execute a SQL statement with unbound parameters.
+        # @!attribute [rw] param_types
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}]
+        #     It is not always possible for Cloud Spanner to infer the right SQL type
+        #     from a JSON value.  For example, values of type `BYTES` and values
+        #     of type `STRING` both appear in {::Google::Cloud::Spanner::V1::PartitionQueryRequest#params params} as JSON strings.
+        #
+        #     In these cases, `param_types` can be used to specify the exact
+        #     SQL type for some or all of the SQL query parameters. See the
+        #     definition of {::Google::Cloud::Spanner::V1::Type Type} for more information
+        #     about SQL types.
+        # @!attribute [rw] partition_options
+        #   @return [::Google::Cloud::Spanner::V1::PartitionOptions]
+        #     Additional options that affect how many partitions are created.
+        class PartitionQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Spanner::V1::Type]
+          class ParamTypesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#partition_read PartitionRead}
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session used to create the partitions.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionSelector]
+        #     Read only snapshot transactions are supported, read/write and single use
+        #     transactions are not.
+        # @!attribute [rw] table
+        #   @return [::String]
+        #     Required. The name of the table in the database to be read.
+        # @!attribute [rw] index
+        #   @return [::String]
+        #     If non-empty, the name of an index on {::Google::Cloud::Spanner::V1::PartitionReadRequest#table table}. This index is
+        #     used instead of the table primary key when interpreting {::Google::Cloud::Spanner::V1::PartitionReadRequest#key_set key_set}
+        #     and sorting result rows. See {::Google::Cloud::Spanner::V1::PartitionReadRequest#key_set key_set} for further information.
+        # @!attribute [rw] columns
+        #   @return [::Array<::String>]
+        #     The columns of {::Google::Cloud::Spanner::V1::PartitionReadRequest#table table} to be returned for each row matching
+        #     this request.
+        # @!attribute [rw] key_set
+        #   @return [::Google::Cloud::Spanner::V1::KeySet]
+        #     Required. `key_set` identifies the rows to be yielded. `key_set` names the
+        #     primary keys of the rows in {::Google::Cloud::Spanner::V1::PartitionReadRequest#table table} to be yielded, unless {::Google::Cloud::Spanner::V1::PartitionReadRequest#index index}
+        #     is present. If {::Google::Cloud::Spanner::V1::PartitionReadRequest#index index} is present, then {::Google::Cloud::Spanner::V1::PartitionReadRequest#key_set key_set} instead names
+        #     index keys in {::Google::Cloud::Spanner::V1::PartitionReadRequest#index index}.
+        #
+        #     It is not an error for the `key_set` to name rows that do not
+        #     exist in the database. Read yields nothing for nonexistent rows.
+        # @!attribute [rw] partition_options
+        #   @return [::Google::Cloud::Spanner::V1::PartitionOptions]
+        #     Additional options that affect how many partitions are created.
+        class PartitionReadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information returned for each partition returned in a
+        # PartitionResponse.
+        # @!attribute [rw] partition_token
+        #   @return [::String]
+        #     This token can be passed to Read, StreamingRead, ExecuteSql, or
+        #     ExecuteStreamingSql requests to restrict the results to those identified by
+        #     this partition token.
+        class Partition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#partition_query PartitionQuery}
+        # or {::Google::Cloud::Spanner::V1::Spanner::Client#partition_read PartitionRead}
+        # @!attribute [rw] partitions
+        #   @return [::Array<::Google::Cloud::Spanner::V1::Partition>]
+        #     Partitions created by this request.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::Transaction]
+        #     Transaction created by this request.
+        class PartitionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#read Read} and
+        # {::Google::Cloud::Spanner::V1::Spanner::Client#streaming_read StreamingRead}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the read should be performed.
+        # @!attribute [rw] transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionSelector]
+        #     The transaction to use. If none is provided, the default is a
+        #     temporary read-only transaction with strong concurrency.
+        # @!attribute [rw] table
+        #   @return [::String]
+        #     Required. The name of the table in the database to be read.
+        # @!attribute [rw] index
+        #   @return [::String]
+        #     If non-empty, the name of an index on {::Google::Cloud::Spanner::V1::ReadRequest#table table}. This index is
+        #     used instead of the table primary key when interpreting {::Google::Cloud::Spanner::V1::ReadRequest#key_set key_set}
+        #     and sorting result rows. See {::Google::Cloud::Spanner::V1::ReadRequest#key_set key_set} for further information.
+        # @!attribute [rw] columns
+        #   @return [::Array<::String>]
+        #     Required. The columns of {::Google::Cloud::Spanner::V1::ReadRequest#table table} to be returned for each row matching
+        #     this request.
+        # @!attribute [rw] key_set
+        #   @return [::Google::Cloud::Spanner::V1::KeySet]
+        #     Required. `key_set` identifies the rows to be yielded. `key_set` names the
+        #     primary keys of the rows in {::Google::Cloud::Spanner::V1::ReadRequest#table table} to be yielded, unless {::Google::Cloud::Spanner::V1::ReadRequest#index index}
+        #     is present. If {::Google::Cloud::Spanner::V1::ReadRequest#index index} is present, then {::Google::Cloud::Spanner::V1::ReadRequest#key_set key_set} instead names
+        #     index keys in {::Google::Cloud::Spanner::V1::ReadRequest#index index}.
+        #
+        #     If the {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field is empty, rows are yielded
+        #     in table primary key order (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is empty) or index key order
+        #     (if {::Google::Cloud::Spanner::V1::ReadRequest#index index} is non-empty).  If the {::Google::Cloud::Spanner::V1::ReadRequest#partition_token partition_token} field is not
+        #     empty, rows will be yielded in an unspecified order.
+        #
+        #     It is not an error for the `key_set` to name rows that do not
+        #     exist in the database. Read yields nothing for nonexistent rows.
+        # @!attribute [rw] limit
+        #   @return [::Integer]
+        #     If greater than zero, only the first `limit` rows are yielded. If `limit`
+        #     is zero, the default is no limit. A limit cannot be specified if
+        #     `partition_token` is set.
+        # @!attribute [rw] resume_token
+        #   @return [::String]
+        #     If this request is resuming a previously interrupted read,
+        #     `resume_token` should be copied from the last
+        #     {::Google::Cloud::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
+        #     enables the new read to resume where the last read left off. The
+        #     rest of the request parameters must exactly match the request
+        #     that yielded this token.
+        # @!attribute [rw] partition_token
+        #   @return [::String]
+        #     If present, results will be restricted to the specified partition
+        #     previously created using PartitionRead().    There must be an exact
+        #     match for the values of fields common to this message and the
+        #     PartitionReadRequest message used to create this partition_token.
+        class ReadRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the transaction runs.
+        # @!attribute [rw] options
+        #   @return [::Google::Cloud::Spanner::V1::TransactionOptions]
+        #     Required. Options for the new transaction.
+        class BeginTransactionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the transaction to be committed is running.
+        # @!attribute [rw] transaction_id
+        #   @return [::String]
+        #     Commit a previously-started transaction.
+        # @!attribute [rw] single_use_transaction
+        #   @return [::Google::Cloud::Spanner::V1::TransactionOptions]
+        #     Execute mutations in a temporary transaction. Note that unlike
+        #     commit of a previously-started transaction, commit with a
+        #     temporary transaction is non-idempotent. That is, if the
+        #     `CommitRequest` is sent to Cloud Spanner more than once (for
+        #     instance, due to retries in the application, or in the
+        #     transport library), it is possible that the mutations are
+        #     executed more than once. If this is undesirable, use
+        #     {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction} and
+        #     {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit} instead.
+        # @!attribute [rw] mutations
+        #   @return [::Array<::Google::Cloud::Spanner::V1::Mutation>]
+        #     The mutations to be executed when this transaction commits. All
+        #     mutations are applied atomically, in the order they appear in
+        #     this list.
+        class CommitRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit}.
+        # @!attribute [rw] commit_timestamp
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The Cloud Spanner timestamp at which the transaction committed.
+        class CommitResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#rollback Rollback}.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Required. The session in which the transaction to roll back is running.
+        # @!attribute [rw] transaction_id
+        #   @return [::String]
+        #     Required. The transaction to roll back.
+        class RollbackRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end