google-cloud-spanner-v1 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4610272e5422dc8368b89645333c01fa798e78ea8359043d12695bab6b4bfa7f
-  data.tar.gz: bd5b5632db6325712fa906766729d255a01aae6dd0c963dc9f2ca44daea6fef7
+  metadata.gz: 3dc249a88987a01cb292039eff91ea84e35fccdc84015c7c84cdcbd34858178c
+  data.tar.gz: 5d899e990abc7f2b9a87913116e9cdccc367f544e50aef6b9e9bc125226b34a4
 SHA512:
-  metadata.gz: f6c0b55b0e66dd390d5a38fec079eac186f73b72db9c0ea1e0c15e81a4c0ca7021dc445d6906abe6cf718e81b9a2e55b45486f3a604be8c5cc454195c95c07f9
-  data.tar.gz: c0a44ad939537df90173bc109d7e021c144f81c15d37a37c1feb30bc5d867a85fb28281606f9f2a9cfba48a0f8e1d92ddfe2c20b62410a51250562c03cf0450e
+  metadata.gz: edcff63203e85d4d5d641ac7fb8dbc122d46ee661026054aa970bc9059fa41ccce7fccc277f8e257e19ed4cde8bf3fc23118915de6e5c21d708af634ffd9d236
+  data.tar.gz: ca00243b49bdb011daff75922cd1b150acca227e4f1dfe0686cffdfc19ddc6dda8b2702e424ef1c15d3269b20859a5278d42c00402c072610e2f29baf4b3b8ec

data/lib/google/cloud/spanner/v1/spanner/client.rb

@@ -686,8 +686,9 @@ module Google
             #     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.
+            #     parameter name (for example, `@firstName`). Parameter names must conform
+            #     to the naming requirements of identifiers as specified at
+            #     https://cloud.google.com/spanner/docs/lexical#identifiers.
             #
             #     Parameters can appear anywhere that a literal value is expected.  The same
             #     parameter name can be used more than once, for example:
@@ -820,8 +821,9 @@ module Google
             #     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.
+            #     parameter name (for example, `@firstName`). Parameter names must conform
+            #     to the naming requirements of identifiers as specified at
+            #     https://cloud.google.com/spanner/docs/lexical#identifiers.
             #
             #     Parameters can appear anywhere that a literal value is expected.  The same
             #     parameter name can be used more than once, for example:
@@ -1322,6 +1324,12 @@ module Google
             # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
             # the transaction from the beginning, re-using the same session.
             #
+            # On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
+            # for example, if the client job experiences a 1+ hour networking failure.
+            # At that point, Cloud Spanner has lost track of the transaction outcome and
+            # we recommend that you perform another read from the database to see the
+            # state of things as they are now.
+            #
             # @overload commit(request, options = nil)
             #   Pass arguments to `commit` via a request object, either of type
             #   {::Google::Cloud::Spanner::V1::CommitRequest} or an equivalent Hash.
@@ -1332,7 +1340,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload commit(session: nil, transaction_id: nil, single_use_transaction: nil, mutations: nil)
+            # @overload commit(session: nil, transaction_id: nil, single_use_transaction: nil, mutations: nil, return_commit_stats: nil)
             #   Pass arguments to `commit` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1355,6 +1363,10 @@ module Google
             #     The mutations to be executed when this transaction commits. All
             #     mutations are applied atomically, in the order they appear in
             #     this list.
+            #   @param return_commit_stats [::Boolean]
+            #     If `true`, then statistics related to the transaction will be included in
+            #     the {::Google::Cloud::Spanner::V1::CommitResponse#commit_stats CommitResponse}. Default value is
+            #     `false`.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Spanner::V1::CommitResponse]

data/lib/google/cloud/spanner/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Spanner
       module V1
-        VERSION = "0.2.3"
+        VERSION = "0.3.0"
       end
     end
   end

data/lib/google/spanner/v1/spanner_pb.rb

@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
@@ -133,6 +134,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.spanner.v1.CommitRequest" do
       optional :session, :string, 1
       repeated :mutations, :message, 4, "google.spanner.v1.Mutation"
+      optional :return_commit_stats, :bool, 5
       oneof :transaction do
         optional :transaction_id, :bytes, 2
         optional :single_use_transaction, :message, 3, "google.spanner.v1.TransactionOptions"
@@ -140,6 +142,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.spanner.v1.CommitResponse" do
       optional :commit_timestamp, :message, 1, "google.protobuf.Timestamp"
+      optional :commit_stats, :message, 2, "google.spanner.v1.CommitResponse.CommitStats"
+    end
+    add_message "google.spanner.v1.CommitResponse.CommitStats" do
+      optional :mutation_count, :int64, 1
     end
     add_message "google.spanner.v1.RollbackRequest" do
       optional :session, :string, 1
@@ -175,6 +181,7 @@ module Google
         BeginTransactionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.BeginTransactionRequest").msgclass
         CommitRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.CommitRequest").msgclass
         CommitResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.CommitResponse").msgclass
+        CommitResponse::CommitStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.CommitResponse.CommitStats").msgclass
         RollbackRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.RollbackRequest").msgclass
       end
     end

data/lib/google/spanner/v1/spanner_services_pb.rb

@@ -134,6 +134,12 @@ module Google
             # transactions. However, it can also happen for a variety of other
             # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
             # the transaction from the beginning, re-using the same session.
+            #
+            # On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
+            # for example, if the client job experiences a 1+ hour networking failure.
+            # At that point, Cloud Spanner has lost track of the transaction outcome and
+            # we recommend that you perform another read from the database to see the
+            # state of things as they are now.
             rpc :Commit, ::Google::Cloud::Spanner::V1::CommitRequest, ::Google::Cloud::Spanner::V1::CommitResponse
             # Rolls back a transaction, releasing any locks it holds. It is a good
             # idea to call this for any transaction that includes one or more

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

@@ -62,10 +62,9 @@ module Google
         end
 
         # A session in the Cloud Spanner API.
-        # @!attribute [rw] name
+        # @!attribute [r] name
         #   @return [::String]
-        #     The name of the session. This is always system-assigned; values provided
-        #     when creating a session are ignored.
+        #     Output only. The name of the session. This is always system-assigned.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The labels for the session.
@@ -77,10 +76,10 @@ module Google
         #      * 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
+        # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The timestamp when the session is created.
-        # @!attribute [rw] approximate_last_use_time
+        # @!attribute [r] 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.
@@ -185,8 +184,9 @@ module Google
         #     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.
+        #     parameter name (for example, `@firstName`). Parameter names must conform
+        #     to the naming requirements of identifiers as specified at
+        #     https://cloud.google.com/spanner/docs/lexical#identifiers.
         #
         #     Parameters can appear anywhere that a literal value is expected.  The same
         #     parameter name can be used more than once, for example:
@@ -259,6 +259,9 @@ module Google
           #     SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
           #     with an invalid optimizer version will fail with a syntax error
           #     (`INVALID_ARGUMENT`) status.
+          #     See
+          #     https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+          #     for more information on managing the query optimizer.
           #
           #     The `optimizer_version` statement hint has precedence over this setting.
           class QueryOptions
@@ -650,6 +653,11 @@ module Google
         #     The mutations to be executed when this transaction commits. All
         #     mutations are applied atomically, in the order they appear in
         #     this list.
+        # @!attribute [rw] return_commit_stats
+        #   @return [::Boolean]
+        #     If `true`, then statistics related to the transaction will be included in
+        #     the {::Google::Cloud::Spanner::V1::CommitResponse#commit_stats CommitResponse}. Default value is
+        #     `false`.
         class CommitRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -659,9 +667,29 @@ module Google
         # @!attribute [rw] commit_timestamp
         #   @return [::Google::Protobuf::Timestamp]
         #     The Cloud Spanner timestamp at which the transaction committed.
+        # @!attribute [rw] commit_stats
+        #   @return [::Google::Cloud::Spanner::V1::CommitResponse::CommitStats]
+        #     The statistics about this Commit. Not returned by default.
+        #     For more information, see
+        #     {::Google::Cloud::Spanner::V1::CommitRequest#return_commit_stats CommitRequest.return_commit_stats}.
         class CommitResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Additional statistics about a commit.
+          # @!attribute [rw] mutation_count
+          #   @return [::Integer]
+          #     The total number of mutations for the transaction. Knowing the
+          #     `mutation_count` value can help you maximize the number of mutations
+          #     in a transaction and minimize the number of API round trips. You can
+          #     also monitor this value to prevent transactions from exceeding the system
+          #     [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+          #     If the number of mutations exceeds the limit, the server returns
+          #     [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+          class CommitStats
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#rollback Rollback}.

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

@@ -24,10 +24,11 @@ module Google
         # # Transactions
         #
         #
-        # Each session can have at most one active transaction at a time. After the
-        # active transaction is completed, the session can immediately be
-        # re-used for the next transaction. It is not necessary to create a
-        # new session for each transaction.
+        # Each session can have at most one active transaction at a time (note that
+        # standalone reads and queries use a transaction internally and do count
+        # towards the one transaction limit). After the active transaction is
+        # completed, the session can immediately be re-used for the next transaction.
+        # It is not necessary to create a new session for each transaction.
         #
         # # Transaction Modes
         #

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

@@ -59,7 +59,7 @@ module Google
           #     SQL queries, it is the column alias (e.g., `"Word"` in the
           #     query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
           #     `"ColName"` in the query `"SELECT ColName FROM Table"`). Some
-          #     columns might have an empty name (e.g., !"SELECT
+          #     columns might have an empty name (e.g., `"SELECT
           #     UPPER(ColName)"`). Note that a query result can contain
           #     multiple fields with the same name.
           # @!attribute [rw] type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common