google-cloud-spanner-v1 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43c68d31b6aa5ec6e23e7d59bf3afd76316a96936fbf26e8e7677e0aec80ffa
-  data.tar.gz: 60257c1d0511defa4a3fb1120ecef5972f32b4966b6c817bdf90926ba96c0451
+  metadata.gz: 6fba6f09fa77e45b73c0fbc08dd22c14a136a70809e998c971d94607189209e5
+  data.tar.gz: 0523b6fd8ec3ce8faf66afb5e258f0c00e21fb34f09c0e436695a24967f85a1a
 SHA512:
-  metadata.gz: 9f248938a41ae032e7ee9fba46f40acaed2d7461744cb346a763ca1c4288e397d253eec298d8141d6656c65fe57f212879e729b69b2fd7bd014c2367d49c9f58
-  data.tar.gz: 39c3b367b8f29a0e942e44caaf6d9b4955fc4c819adbc2762d91a1e22564dc770930bdeb74acbd6f36b394a7bbdb55b81f4d033a611d1d9dc598083a8497c355
+  metadata.gz: 5d3ab71a7be71babeeb5244d091253cc100d0a51b3b8442106dbfb9d13d9adb4cdff91e5606a4a2d354e024c9df6e636ae69f67016cca5b70928caf3965b31e1
+  data.tar.gz: 6cb8b0f889e2a422df8b3faef5f20dc7949df73d3cef904b7fd96643efe6dd9692b9fec96073c80de375c4abf4be63c416628a83267f9411a4bf73c2e2f8ea1d

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

@@ -668,7 +668,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload execute_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil)
+            # @overload execute_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil)
             #   Pass arguments to `execute_sql` 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).
@@ -740,6 +740,8 @@ module Google
             #     Required for DML statements. Ignored for queries.
             #   @param query_options [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions, ::Hash]
             #     Query optimizer configuration to use for the given query.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Spanner::V1::ResultSet]
@@ -803,7 +805,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload execute_streaming_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil)
+            # @overload execute_streaming_sql(session: nil, transaction: nil, sql: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, partition_token: nil, seqno: nil, query_options: nil, request_options: nil)
             #   Pass arguments to `execute_streaming_sql` 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).
@@ -875,6 +877,8 @@ module Google
             #     Required for DML statements. Ignored for queries.
             #   @param query_options [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions, ::Hash]
             #     Query optimizer configuration to use for the given query.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>]
@@ -944,7 +948,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload execute_batch_dml(session: nil, transaction: nil, statements: nil, seqno: nil)
+            # @overload execute_batch_dml(session: nil, transaction: nil, statements: nil, seqno: nil, request_options: nil)
             #   Pass arguments to `execute_batch_dml` 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).
@@ -973,6 +977,8 @@ module Google
             #     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.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Spanner::V1::ExecuteBatchDmlResponse]
@@ -1044,7 +1050,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil)
+            # @overload read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil)
             #   Pass arguments to `read` 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).
@@ -1092,6 +1098,8 @@ module Google
             #     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.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Spanner::V1::ResultSet]
@@ -1155,7 +1163,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload streaming_read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil)
+            # @overload streaming_read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil)
             #   Pass arguments to `streaming_read` 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).
@@ -1203,6 +1211,8 @@ module Google
             #     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.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>]
@@ -1265,7 +1275,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload begin_transaction(session: nil, options: nil)
+            # @overload begin_transaction(session: nil, options: nil, request_options: nil)
             #   Pass arguments to `begin_transaction` 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).
@@ -1274,6 +1284,12 @@ module Google
             #     Required. The session in which the transaction runs.
             #   @param options [::Google::Cloud::Spanner::V1::TransactionOptions, ::Hash]
             #     Required. Options for the new transaction.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
+            #     Priority is ignored for this request. Setting the priority in this
+            #     request_options struct will not do anything. To set the priority for a
+            #     transaction, set it on the reads and writes that are part of this
+            #     transaction instead.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Spanner::V1::Transaction]
@@ -1346,7 +1362,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, return_commit_stats: nil)
+            # @overload commit(session: nil, transaction_id: nil, single_use_transaction: nil, mutations: nil, return_commit_stats: nil, request_options: 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).
@@ -1373,6 +1389,8 @@ module Google
             #     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`.
+            #   @param request_options [::Google::Cloud::Spanner::V1::RequestOptions, ::Hash]
+            #     Common options for this request.
             #
             # @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.5.0"
+        VERSION = "0.6.0"
       end
     end
   end

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

@@ -53,6 +53,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.spanner.v1.DeleteSessionRequest" do
       optional :name, :string, 1
     end
+    add_message "google.spanner.v1.RequestOptions" do
+      optional :priority, :enum, 1, "google.spanner.v1.RequestOptions.Priority"
+      optional :request_tag, :string, 2
+      optional :transaction_tag, :string, 3
+    end
+    add_enum "google.spanner.v1.RequestOptions.Priority" do
+      value :PRIORITY_UNSPECIFIED, 0
+      value :PRIORITY_LOW, 1
+      value :PRIORITY_MEDIUM, 2
+      value :PRIORITY_HIGH, 3
+    end
     add_message "google.spanner.v1.ExecuteSqlRequest" do
       optional :session, :string, 1
       optional :transaction, :message, 2, "google.spanner.v1.TransactionSelector"
@@ -64,6 +75,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :partition_token, :bytes, 8
       optional :seqno, :int64, 9
       optional :query_options, :message, 10, "google.spanner.v1.ExecuteSqlRequest.QueryOptions"
+      optional :request_options, :message, 11, "google.spanner.v1.RequestOptions"
     end
     add_message "google.spanner.v1.ExecuteSqlRequest.QueryOptions" do
       optional :optimizer_version, :string, 1
@@ -79,6 +91,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :transaction, :message, 2, "google.spanner.v1.TransactionSelector"
       repeated :statements, :message, 3, "google.spanner.v1.ExecuteBatchDmlRequest.Statement"
       optional :seqno, :int64, 4
+      optional :request_options, :message, 5, "google.spanner.v1.RequestOptions"
     end
     add_message "google.spanner.v1.ExecuteBatchDmlRequest.Statement" do
       optional :sql, :string, 1
@@ -127,15 +140,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :limit, :int64, 8
       optional :resume_token, :bytes, 9
       optional :partition_token, :bytes, 10
+      optional :request_options, :message, 11, "google.spanner.v1.RequestOptions"
     end
     add_message "google.spanner.v1.BeginTransactionRequest" do
       optional :session, :string, 1
       optional :options, :message, 2, "google.spanner.v1.TransactionOptions"
+      optional :request_options, :message, 3, "google.spanner.v1.RequestOptions"
     end
     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
+      optional :request_options, :message, 6, "google.spanner.v1.RequestOptions"
       oneof :transaction do
         optional :transaction_id, :bytes, 2
         optional :single_use_transaction, :message, 3, "google.spanner.v1.TransactionOptions"
@@ -167,6 +183,8 @@ module Google
         ListSessionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.ListSessionsRequest").msgclass
         ListSessionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.ListSessionsResponse").msgclass
         DeleteSessionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.DeleteSessionRequest").msgclass
+        RequestOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.RequestOptions").msgclass
+        RequestOptions::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.RequestOptions.Priority").enummodule
         ExecuteSqlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.ExecuteSqlRequest").msgclass
         ExecuteSqlRequest::QueryOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.ExecuteSqlRequest.QueryOptions").msgclass
         ExecuteSqlRequest::QueryMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.v1.ExecuteSqlRequest.QueryMode").enummodule

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

@@ -159,6 +159,66 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Common request options for various APIs.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions::Priority]
+        #     Priority for the request.
+        # @!attribute [rw] request_tag
+        #   @return [::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
+        # @!attribute [rw] transaction_tag
+        #   @return [::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}`
+        class RequestOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The relative priority for requests. Note that priority is not applicable
+          # for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
+          #
+          # The priority acts as a hint to the Cloud Spanner scheduler and does not
+          # guarantee priority or order of execution. For example:
+          #
+          # * Some parts of a write operation always execute at `PRIORITY_HIGH`,
+          #   regardless of the specified priority. This may cause you to see an
+          #   increase in high priority workload even when executing a low priority
+          #   request. This can also potentially cause a priority inversion where a
+          #   lower priority request will be fulfilled ahead of a higher priority
+          #   request.
+          # * If a transaction contains multiple operations with different priorities,
+          #   Cloud Spanner does not guarantee to process the higher priority
+          #   operations first. There may be other constraints to satisfy, such as
+          #   order of operations.
+          module Priority
+            # `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
+            PRIORITY_UNSPECIFIED = 0
+
+            # This specifies that the request is low priority.
+            PRIORITY_LOW = 1
+
+            # This specifies that the request is medium priority.
+            PRIORITY_MEDIUM = 2
+
+            # This specifies that the request is high priority.
+            PRIORITY_HIGH = 3
+          end
+        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
@@ -238,6 +298,9 @@ module Google
         # @!attribute [rw] query_options
         #   @return [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions]
         #     Query optimizer configuration to use for the given query.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ExecuteSqlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -269,15 +332,15 @@ module Google
           #     The `optimizer_version` statement hint has precedence over this setting.
           # @!attribute [rw] optimizer_statistics_package
           #   @return [::String]
-          #     Query optimizer statistics package to use.
+          #     An option to control the selection of optimizer statistics package.
           #
           #     This parameter allows individual queries to use a different query
-          #     optimizer statistics.
+          #     optimizer statistics package.
           #
           #     Specifying `latest` as a value instructs Cloud Spanner to use the latest
           #     generated statistics package. If not specified, Cloud Spanner uses
-          #     statistics package set at the database level options, or latest if
-          #     the database option is not set.
+          #     the statistics package set at the database level options, or the latest
+          #     package if the database option is not set.
           #
           #     The statistics package requested by the query has to be exempt from
           #     garbage collection. This can be achieved with the following DDL
@@ -288,10 +351,10 @@ module Google
           #     ```
           #
           #     The list of available statistics packages can be queried from
-          #     `SPANNER_SYS.OPTIMIZER_STATISTICS_PACKAGES`.
+          #     `INFORMATION_SCHEMA.SPANNER_STATISTICS`.
           #
           #     Executing a SQL statement with an invalid optimizer statistics package
-          #     or with statistics package that allows garbage collection fails with
+          #     or with a statistics package that allows garbage collection fails with
           #     an `INVALID_ARGUMENT` error.
           class QueryOptions
             include ::Google::Protobuf::MessageExts
@@ -351,6 +414,9 @@ module Google
         #     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.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ExecuteBatchDmlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -642,6 +708,9 @@ module Google
         #     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.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ReadRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -654,6 +723,13 @@ module Google
         # @!attribute [rw] options
         #   @return [::Google::Cloud::Spanner::V1::TransactionOptions]
         #     Required. Options for the new transaction.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
+        #     Priority is ignored for this request. Setting the priority in this
+        #     request_options struct will not do anything. To set the priority for a
+        #     transaction, set it on the reads and writes that are part of this
+        #     transaction instead.
         class BeginTransactionRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -687,6 +763,9 @@ module Google
         #     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`.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class CommitRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-v1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement