google-cloud-spanner 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8ec17cc028b816dfb1ddb1255c3bd3fd6c2c66baa30b77fd27eb946b2808bd
-  data.tar.gz: d5cd3782cb7840717fc478f882c99a1db02b5a99b72cd8fb832905e0eecbfcb0
+  metadata.gz: 39a33a615e75cde66aa1d0ebf4631f34d5b139fa0a5c9fe203a20a4f157c5534
+  data.tar.gz: 415409aa55971910e5c337a6d88a2ee0e78671a3cde9ab0ebf3170edab8151ca
 SHA512:
-  metadata.gz: ef2ebdb0b63e720d95d661bdd8d7359d0da83448e16a098fc5f61df8068305ba02b69b47b085ed3404ab9315ce7289b5b68086a0635360f537c7c41836b5a89c
-  data.tar.gz: 3e510b6720968f06a6faf0726afcf67d8afe113005377e4f4782a9f5ba03fda5a45cc035b9f06bfcabc3d3eca210aa00230333c8acab2e557bd2582530380566
+  metadata.gz: a83fc9125b21861b192099c025596c0224eb3b2d4c7904809a52062358c35d621510ef0e8d2b9ecd583609514d440e19927130fcdf56242ea2a6765a5ce83a03
+  data.tar.gz: 0e5a053289cb6393d62533836eda651217e60388d43931613245ac3b55ddb3d17b8c98cbb866fc0efec703bba398ccb7f18b38fb6129c11b03306bb8419f823f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.9.0 / 2021-07-26
+
+#### Features
+
+* support request tagging ([#8163](https://www.github.com/googleapis/google-cloud-ruby/issues/8163))
+
 ### 2.8.1 / 2021-07-08
 
 #### Documentation

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

@@ -236,6 +236,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -403,6 +407,21 @@ module Google
         #     puts "User #{row[:id]} is #{row[:name]}"
         #   end
         #
+        # @example Query using tag for request query statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Read-Users" }
+        #   results = db.execute_query "SELECT * FROM users",
+        #                              request_options: request_options
+        #
+        #   results.rows.each do |row|
+        #     puts "User #{row[:id]} is #{row[:name]}"
+        #   end
+        #
         def execute_query sql, params: nil, types: nil, single_use: nil,
                           query_options: nil, request_options: nil,
                           call_options: nil
@@ -410,7 +429,8 @@ module Google
           ensure_service!
 
           params, types = Convert.to_input_params_and_types params, types
-
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
           single_use_tx = single_use_transaction single_use
           results = nil
           @pool.with_session do |session|
@@ -580,6 +600,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -657,12 +681,27 @@ module Google
         #    "UPDATE users SET friends = NULL WHERE active = @active",
         #    params: { active: false }, request_options: request_options
         #
+        # @example Query using tag for request query statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Update-Users" }
+        #   row_count = db.execute_partition_update \
+        #     "UPDATE users SET friends = NULL WHERE active = false",
+        #     request_options: request_options
+        #
         def execute_partition_update sql, params: nil, types: nil,
                                      query_options: nil, request_options: nil,
                                      call_options: nil
           ensure_service!
 
           params, types = Convert.to_input_params_and_types params, types
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
+
           results = nil
           @pool.with_session do |session|
             results = session.execute_query \
@@ -761,6 +800,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -840,6 +883,22 @@ module Google
         #     puts "User #{row[:id]} is #{row[:name]}"
         #   end
         #
+        # @example Read using tag for read statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Read-Users-All" }
+        #   results = db.read "users", [:id, :name],
+        #                     request_options: request_options
+        #
+        #   results.rows.each do |row|
+        #     puts "User #{row[:id]} is #{row[:name]}"
+        #   end
+        #
         def read table, columns, keys: nil, index: nil, limit: nil,
                  single_use: nil, request_options: nil, call_options: nil
           validate_single_use_args! single_use
@@ -847,8 +906,10 @@ module Google
 
           columns = Array(columns).map(&:to_s)
           keys = Convert.to_key_set keys
-
           single_use_tx = single_use_transaction single_use
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
+
           results = nil
           @pool.with_session do |session|
             results = session.read \
@@ -914,6 +975,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the format:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -954,7 +1018,23 @@ module Google
         #   db.upsert "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Upsert using tag for transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "Bulk-Upsert" }
+        #   db.upsert "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def upsert table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.upsert table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -999,7 +1079,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1015,6 +1094,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1055,7 +1137,23 @@ module Google
         #   db.insert "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Insert using tag for transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkInsert-Users" }
+        #   db.insert "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def insert table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.insert table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -1099,7 +1197,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1115,6 +1212,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1155,7 +1255,22 @@ module Google
         #   db.update "users", [{ id: 1, name: "Charlie", active: false }],
         #                      request_options: request_options
         #
+        # @example Updte using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkUpdate-Users" }
+        #   db.update "users", [{ id: 1, name: "Charlie", active: false },
+        #                       { id: 2, name: "Harvey",  active: true }],
+        #                      request_options: request_options
+        #
         def update table, rows, commit_options: nil, request_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.update table, rows, commit_options: commit_options,
                            request_options: request_options
@@ -1201,7 +1316,6 @@ module Google
         #
         #   See [Data
         #   types](https://cloud.google.com/spanner/docs/data-definition-language#data_types).
-        #
         # @param [Hash] commit_options A hash of commit options.
         #   e.g., return_commit_stats. Commit options are optional.
         #   The following options can be provided:
@@ -1217,6 +1331,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1257,6 +1374,18 @@ module Google
         #   db.replace "users", [{ id: 1, name: "Charlie", active: false }],
         #                       request_options: request_options
         #
+        # @example Replace using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkReplace-Users" }
+        #   db.replace "users", [{ id: 1, name: "Charlie", active: false },
+        #                        { id: 2, name: "Harvey",  active: true }],
+        #                       request_options: request_options
+        #
         def replace table, rows, commit_options: nil, request_options: nil
           @pool.with_session do |session|
             session.replace table, rows, commit_options: commit_options,
@@ -1299,6 +1428,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1348,8 +1480,21 @@ module Google
         #   request_options = { priority: :PRIORITY_MEDIUM }
         #   db.delete "users", [1, 2, 3], request_options: request_options
         #
+        # @example Delete using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkDelete-Users" }
+        #   db.delete "users", [1, 2, 3], request_options: request_options
+        #
         def delete table, keys = [], commit_options: nil, request_options: nil,
                    call_options: nil
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.delete table, keys, commit_options: commit_options,
                            request_options: request_options,
@@ -1387,6 +1532,9 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A tag used for statistics collection
+        #     about transaction. A tag must be a valid identifier of the
+        #     format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1447,10 +1595,26 @@ module Google
         #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
         #   end
         #
+        # @example Commit using tag for transaction statistics collection.
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   request_options = { tag: "BulkManipulate-Users" }
+        #   db.commit request_options: request_options do |c|
+        #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #   end
+        #
         def commit commit_options: nil, request_options: nil,
                    call_options: nil, &block
           raise ArgumentError, "Must provide a block" unless block_given?
 
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_session do |session|
             session.commit(
               commit_options: commit_options, request_options: request_options,
@@ -1494,6 +1658,11 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String)A tag used for statistics collection
+        #     about transaction. The value of a transaction tag should be the
+        #     same for all requests belonging to the same transaction. A tag must
+        #     be a valid identifier of the format: `[a-zA-Z][a-zA-Z0-9_\-]{0,49}`
+        #
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -1585,6 +1754,30 @@ module Google
         #                               request_options: request_options
         #   end
         #
+        # @example Tags for request and transaction statistics collection.
+        #
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   # Transaction tag will be set to "Users-Txn"
+        #   db.transaction request_options: { tag: "Users-Txn" } do |tx|
+        #     # The transaction tag set as "Users-Txn"
+        #     # The request tag set as "Users-Txn-1"
+        #     request_options = { tag: "Users-Txn-1" }
+        #     results = tx.execute_query "SELECT * FROM users",
+        #                                request_options: request_options
+        #
+        #     results.rows.each do |row|
+        #       puts "User #{row[:id]} is #{row[:name]}"
+        #     end
+        #
+        #     # The transaction tag set as "Users-Txn"
+        #     tx.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #   end
+        #
         def transaction deadline: 120, commit_options: nil,
                         request_options: nil, call_options: nil
           ensure_service!
@@ -1596,39 +1789,48 @@ module Google
           backoff = 1.0
           start_time = current_time
 
+          request_options = Convert.to_request_options \
+            request_options, tag_type: :transaction_tag
+
           @pool.with_transaction do |tx|
-            Thread.current[:transaction_id] = tx.transaction_id
-            yield tx
-            commit_resp = @project.service.commit \
-              tx.session.path, tx.mutations,
-              transaction_id: tx.transaction_id,
-              commit_options: commit_options,
-              request_options: request_options,
-              call_options: call_options
-            resp = CommitResponse.from_grpc commit_resp
-            commit_options ? resp : resp.timestamp
-          rescue GRPC::Aborted, Google::Cloud::AbortedError => e
-            # Re-raise if deadline has passed
-            if current_time - start_time > deadline
-              if e.is_a? GRPC::BadStatus
-                e = Google::Cloud::Error.from_error e
+            if request_options
+              tx.transaction_tag = request_options[:transaction_tag]
+            end
+
+            begin
+              Thread.current[:transaction_id] = tx.transaction_id
+              yield tx
+              commit_resp = @project.service.commit \
+                tx.session.path, tx.mutations,
+                transaction_id: tx.transaction_id,
+                commit_options: commit_options,
+                request_options: request_options,
+                call_options: call_options
+              resp = CommitResponse.from_grpc commit_resp
+              commit_options ? resp : resp.timestamp
+            rescue GRPC::Aborted, Google::Cloud::AbortedError => e
+              # Re-raise if deadline has passed
+              if current_time - start_time > deadline
+                if e.is_a? GRPC::BadStatus
+                  e = Google::Cloud::Error.from_error e
+                end
+                raise e
               end
+              # Sleep the amount from RetryDelay, or incremental backoff
+              sleep(delay_from_aborted(e) || backoff *= 1.3)
+              # Create new transaction on the session and retry the block
+              tx = tx.session.create_transaction
+              retry
+            rescue StandardError => e
+              # Rollback transaction when handling unexpected error
+              tx.session.rollback tx.transaction_id
+              # Return nil if raised with rollback.
+              return nil if e.is_a? Rollback
+              # Re-raise error.
               raise e
+            ensure
+              Thread.current[:transaction_id] = nil
             end
-            # Sleep the amount from RetryDelay, or incremental backoff
-            sleep(delay_from_aborted(e) || backoff *= 1.3)
-            # Create new transaction on the session and retry the block
-            tx = tx.session.create_transaction
-            retry
-          rescue StandardError => e
-            # Rollback transaction when handling unexpected error
-            tx.session.rollback tx.transaction_id
-            # Return nil if raised with rollback.
-            return nil if e.is_a? Rollback
-            # Re-raise error.
-            raise e
-          ensure
-            Thread.current[:transaction_id] = nil
           end
         end
 

data/lib/google/cloud/spanner/convert.rb

@@ -324,6 +324,25 @@ module Google
 
             [input_params, input_param_types]
           end
+
+          ##
+          # Build request options by replacing tag to respecitve statistics
+          # collection tag type.
+          #
+          # @param [Hash] options Common request options.
+          #   * `:tag` (String) A tag used for statistics collection.
+          #
+          # @param [Symbol] tag_type Request tag type.
+          #   Possible values are `request_tag`, `transaction_tag`
+          # @return [Hash, nil]
+          #
+          def to_request_options options, tag_type: nil
+            return unless options
+
+            return options unless options.key? :tag
+
+            options.transform_keys { |k| k == :tag ? tag_type : k }
+          end
         end
 
         # rubocop:enable all

data/lib/google/cloud/spanner/service.rb

@@ -441,13 +441,18 @@ module Google
           service.rollback request, opts
         end
 
-        def begin_transaction session_name, call_options: nil
+        def begin_transaction session_name, request_options: nil,
+                              call_options: nil
           tx_opts = V1::TransactionOptions.new(
             read_write: V1::TransactionOptions::ReadWrite.new
           )
           opts = default_options session_name: session_name,
                                  call_options: call_options
-          request = { session: session_name, options: tx_opts }
+          request = {
+            session: session_name,
+            options: tx_opts,
+            request_options: request_options
+          }
           service.begin_transaction request, opts
         end
 

data/lib/google/cloud/spanner/session.rb

@@ -167,6 +167,23 @@ module Google
         #     available optimizer version.
         #   * `:optimizer_statistics_package` (String) Statistics package to
         #     use. Empty to use the database default.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -349,6 +366,23 @@ module Google
         #   transactions.
         # @param [Integer] seqno A per-transaction sequence number used to
         #   identify this request.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -413,6 +447,23 @@ module Google
         # @param [Google::Cloud::Spanner::V1::TransactionSelector] transaction The
         #   transaction selector value to send. Only used for single-use
         #   transactions.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -506,6 +557,23 @@ module Google
         #     {CommitResponse}. Default value is `false`
         #
         # transaction. Default it is `false`.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -605,6 +673,23 @@ module Google
         #     then statistics related to the transaction will be included in
         #     {CommitResponse}. Default value is `false`
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -696,6 +781,23 @@ module Google
         #     then statistics related to the transaction will be included in
         #     {CommitResponse}. Default value is `false`
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -786,6 +888,23 @@ module Google
         #     then statistics related to the transaction will be included in
         #     {CommitResponse}. Default value is `false`
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -878,6 +997,23 @@ module Google
         #     then statistics related to the transaction will be included in
         #     {CommitResponse}. Default value is `false`.
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -950,6 +1086,23 @@ module Google
         #     then statistics related to the transaction will be included in
         #     {CommitResponse}. Default value is `false`
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:request_tag` (String) A per-request tag which can be applied
+        #     to queries or reads, used for statistics collection. Both
+        #     request_tag and transaction_tag can be specified for a read or
+        #     query that belongs to a transaction. This field is ignored for
+        #     requests where it's not applicable (e.g. CommitRequest).
+        #     `request_tag` must be a valid identifier of the form:
+        #     `[a-zA-Z][a-zA-Z0-9_\-]` between 2 and 64 characters in length.
+        #   * `:transaction_tag` (String) A tag used for statistics collection
+        #     about this transaction. Both request_tag and transaction_tag can
+        #     be specified for a read or query that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests
+        #     belonging to the same transaction. If this request doesn't belong
+        #     to any transaction, transaction_tag will be ignored.
+        #     `transaction_tag` must be a valid identifier of the format:
+        #     [a-zA-Z][a-zA-Z0-9_\-]{0,49}
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:

data/lib/google/cloud/spanner/transaction.rb

@@ -77,6 +77,9 @@ module Google
         # @private The Session object.
         attr_accessor :session
 
+        # @private Transaction tag for statistics collection.
+        attr_accessor :transaction_tag
+
         def initialize
           @commit = Commit.new
           @seqno = 0
@@ -167,6 +170,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -333,6 +340,7 @@ module Google
           @seqno += 1
 
           params, types = Convert.to_input_params_and_types params, types
+          request_options = build_request_options request_options
           session.execute_query sql, params: params, types: types,
                                      transaction: tx_selector, seqno: @seqno,
                                      query_options: query_options,
@@ -419,6 +427,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -525,6 +537,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -597,6 +613,8 @@ module Google
         def batch_update request_options: nil, call_options: nil, &block
           ensure_session!
           @seqno += 1
+
+          request_options = build_request_options request_options
           session.batch_update tx_selector, @seqno,
                                request_options: request_options,
                                call_options: call_options, &block
@@ -626,6 +644,10 @@ module Google
         #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
         #     `:PRIORITY_HIGH`. If priority not set then default is
         #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -663,7 +685,7 @@ module Google
 
           columns = Array(columns).map(&:to_s)
           keys = Convert.to_key_set keys
-
+          request_options = build_request_options request_options
           session.read table, columns, keys: keys, index: index, limit: limit,
                                        transaction: tx_selector,
                                        request_options: request_options,
@@ -1097,6 +1119,20 @@ module Google
           V1::TransactionSelector.new id: transaction_id
         end
 
+        ##
+        # @private Build request options. If transaction tag is set
+        #   then add into request options.
+        def build_request_options options
+          options = Convert.to_request_options options, tag_type: :request_tag
+
+          if transaction_tag
+            options ||= {}
+            options[:transaction_tag] = transaction_tag
+          end
+
+          options
+        end
+
         ##
         # @private Raise an error unless an active connection to the service is
         # available.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "2.8.1".freeze
+      VERSION = "2.9.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core