google-cloud-spanner 2.16.1 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb26c1ee1cc71cf984fecb01463a35384ee50e68cafd41399c064cc810a298f8
-  data.tar.gz: 5d663434c4a3766acf13c3a03ef851cb81ec839a83bfd4e83340b9b5b22231f4
+  metadata.gz: bc70eb07f76250946af950e0dae045072c767ed0fa1be9c2f983c24f4730679a
+  data.tar.gz: d8faa1c37467724ed5227dcea972c0da233b56e1cf88354ff084c8394792b6ea
 SHA512:
-  metadata.gz: f8638c29b54887f38252cc916f077d4ea5776602d331c0da853215e80b62b06fe176d6a3972b339cb650a3e936c78bab2ea2776fb0f12cc4911fd57f4c1ae33d
-  data.tar.gz: 7bd143477dbc7b67dde5f9a9cd2a6ae6b77a5b9079117bcae3cbf3006321a3476468d79889c7bb0ffe8cca6c9de4674c7d36f8bc878430bdf6934c2b6064f645
+  metadata.gz: 84ceadbf10e41390c371177d5fedfb846ea83e2eabd0017b94f83a08b9ded5fff51de65f64c3cd7ee52112066593a156fb944d8b895f18665f1f90aec53dbf17
+  data.tar.gz: 226d5e9d43e373aa736ea58f0b4fe49ea846f995996f91448fbf387b2ba12e574c91c5bf313d37a0625324b725de46a3eee7092cbded4e23b1c6956a1674c48d

data/AUTHENTICATION.md

@@ -32,7 +32,7 @@ client = Google::Cloud::Spanner.new
 ## Project and Credential Lookup
 
 The google-cloud-spanner library aims to make authentication
-as simple as possible, and provides several mechanisms to configure your system
+as simple as possible and provides several mechanisms to configure your system
 without providing **Project ID** and **Service Account Credentials** directly in
 code.
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.17.0 (2023-06-23)
+
+#### Features
+
+* support data_boost_enabled for partitioned query and read ([#46](https://github.com/googleapis/ruby-spanner/issues/46)) 
+
 ### 2.16.1 (2022-11-02)
 
 #### Documentation

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

@@ -188,6 +188,9 @@ module Google
         #     * `:multiplier` (`Numeric`) - The incremental backoff multiplier.
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
+        # @param [Boolean] data_boost_enabled  If this field is
+        #   set `true`, the request will be executed via offline access.
+        #   Defaults to `false`.
         #
         # @return [Array<Google::Cloud::Spanner::Partition>] The partitions
         #   created by the query partition.
@@ -211,7 +214,7 @@ module Google
         #
         def partition_query sql, params: nil, types: nil,
                             partition_size_bytes: nil, max_partitions: nil,
-                            query_options: nil, call_options: nil
+                            query_options: nil, call_options: nil, data_boost_enabled: false
           ensure_session!
 
           params, types = Convert.to_input_params_and_types params, types
@@ -231,8 +234,9 @@ module Google
                 param_types: types,
                 transaction: tx_selector,
                 partition_token: grpc.partition_token,
-                query_options: query_options
-              }.delete_if { |_, v| v.nil? }
+                query_options: query_options,
+                data_boost_enabled: data_boost_enabled
+              }.compact
             )
             Partition.from_execute_sql_grpc execute_sql_grpc
           end
@@ -277,6 +281,9 @@ module Google
         #     * `:multiplier` (`Numeric`) - The incremental backoff multiplier.
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
+        # @param [Boolean] data_boost_enabled  If this field is
+        #   set `true`, the request will be executed via offline access.
+        #   Defaults to `false`.
         #
         # @return [Array<Google::Cloud::Spanner::Partition>] The partitions
         #   created by the read partition.
@@ -298,7 +305,7 @@ module Google
         #
         def partition_read table, columns, keys: nil, index: nil,
                            partition_size_bytes: nil, max_partitions: nil,
-                           call_options: nil
+                           call_options: nil, data_boost_enabled: false
           ensure_session!
 
           columns = Array(columns).map(&:to_s)
@@ -321,8 +328,9 @@ module Google
                 key_set: keys,
                 index: index,
                 transaction: tx_selector,
-                partition_token: grpc.partition_token
-              }.delete_if { |_, v| v.nil? }
+                partition_token: grpc.partition_token,
+                data_boost_enabled: data_boost_enabled
+              }.compact
             )
             Partition.from_read_grpc read_grpc
           end
@@ -804,7 +812,8 @@ module Google
             transaction: partition.execute.transaction,
             partition_token: partition.execute.partition_token,
             query_options: query_options,
-            call_options: call_options
+            call_options: call_options,
+            data_boost_enabled: partition.execute.data_boost_enabled
         end
 
         def execute_partition_read partition, call_options: nil
@@ -814,7 +823,8 @@ module Google
                        index: partition.read.index,
                        transaction: partition.read.transaction,
                        partition_token: partition.read.partition_token,
-                       call_options: call_options
+                       call_options: call_options,
+                       data_boost_enabled: partition.read.data_boost_enabled
         end
       end
     end

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

@@ -1815,7 +1815,11 @@ module Google
                 call_options: call_options
               resp = CommitResponse.from_grpc commit_resp
               commit_options ? resp : resp.timestamp
-            rescue GRPC::Aborted, Google::Cloud::AbortedError => e
+            rescue GRPC::Aborted,
+                   Google::Cloud::AbortedError,
+                   GRPC::Internal,
+                   Google::Cloud::InternalError => e
+              raise e if internal_error_and_not_retryable? e
               # Re-raise if deadline has passed
               if current_time - start_time > deadline
                 if e.is_a? GRPC::BadStatus
@@ -2215,7 +2219,7 @@ module Google
                 min_read_timestamp: bounded_timestamp,
                 max_staleness: bounded_staleness,
                 return_read_timestamp: true
-              }.delete_if { |_, v| v.nil? })))
+              }.compact)))
         end
 
         def pdml_transaction session
@@ -2267,6 +2271,12 @@ module Google
           # Any error indicates the backoff should be handled elsewhere
           nil
         end
+
+        def internal_error_and_not_retryable? error
+          (error.instance_of?(Google::Cloud::InternalError) ||
+          error.instance_of?(GRPC::Internal)) &&
+            !@project.service.retryable?(error)
+        end
       end
     end
   end

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

@@ -94,7 +94,7 @@ module Google
         def upsert table, *rows
           rows = Array(rows).flatten
           return rows if rows.empty?
-          rows.delete_if(&:nil?)
+          rows.compact
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
             V1::Mutation.new(
@@ -153,7 +153,7 @@ module Google
         def insert table, *rows
           rows = Array(rows).flatten
           return rows if rows.empty?
-          rows.delete_if(&:nil?)
+          rows.compact
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
             V1::Mutation.new(
@@ -211,7 +211,7 @@ module Google
         def update table, *rows
           rows = Array(rows).flatten
           return rows if rows.empty?
-          rows.delete_if(&:nil?)
+          rows.compact
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
             V1::Mutation.new(
@@ -271,7 +271,7 @@ module Google
         def replace table, *rows
           rows = Array(rows).flatten
           return rows if rows.empty?
-          rows.delete_if(&:nil?)
+          rows.compact
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
             V1::Mutation.new(

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

@@ -30,8 +30,8 @@ module Google
       #
       class Pool
         attr_accessor :all_sessions
-        attr_accessor :session_queue
-        attr_accessor :transaction_queue
+        attr_accessor :session_stack
+        attr_accessor :transaction_stack
 
         def initialize client, min: 10, max: 100, keepalive: 1800,
                        write_ratio: 0.3, fail: true, threads: nil
@@ -48,7 +48,7 @@ module Google
           @mutex = Mutex.new
           @resource = ConditionVariable.new
 
-          # initialize pool and availability queue
+          # initialize pool and availability stack
           init
         end
 
@@ -69,9 +69,9 @@ module Google
 
               # Use LIFO to ensure sessions are used from backend caches, which
               # will reduce the read / write latencies on user requests.
-              read_session = session_queue.pop # LIFO
+              read_session = session_stack.pop # LIFO
               return read_session if read_session
-              write_transaction = transaction_queue.pop # LIFO
+              write_transaction = transaction_stack.pop # LIFO
               return write_transaction.session if write_transaction
 
               if can_allocate_more_sessions?
@@ -94,7 +94,7 @@ module Google
               raise ArgumentError, "Cannot checkin session"
             end
 
-            session_queue.push session
+            session_stack.push session
 
             @resource.signal
           end
@@ -121,9 +121,9 @@ module Google
             loop do
               raise ClientClosedError if @closed
 
-              write_transaction = transaction_queue.pop # LIFO
+              write_transaction = transaction_stack.pop # LIFO
               return write_transaction if write_transaction
-              read_session = session_queue.pop
+              read_session = session_stack.pop
               if read_session
                 action = read_session
                 break
@@ -151,7 +151,7 @@ module Google
               raise ArgumentError, "Cannot checkin session"
             end
 
-            transaction_queue.push txn
+            transaction_stack.push txn
 
             @resource.signal
           end
@@ -182,11 +182,11 @@ module Google
           to_release = []
 
           @mutex.synchronize do
-            available_count = session_queue.count + transaction_queue.count
+            available_count = session_stack.count + transaction_stack.count
             release_count = @min - available_count
             release_count = 0 if release_count.negative?
 
-            to_keepalive += (session_queue + transaction_queue).select do |x|
+            to_keepalive += (session_stack + transaction_stack).select do |x|
               x.idle_since? @keepalive
             end
 
@@ -196,8 +196,8 @@ module Google
 
             # Remove those to be released from circulation
             @all_sessions -= to_release.map(&:session)
-            @session_queue -= to_release
-            @transaction_queue -= to_release
+            @session_stack -= to_release
+            @transaction_stack -= to_release
           end
 
           to_release.each { |x| future { x.release! } }
@@ -210,21 +210,21 @@ module Google
           # init the thread pool
           @thread_pool = Concurrent::ThreadPoolExecutor.new \
             max_threads: @threads
-          # init the queues
+          # init the stacks
           @new_sessions_in_process = 0
-          @transaction_queue = []
+          @transaction_stack = []
           # init the keepalive task
           create_keepalive_task!
-          # init session queue
+          # init session stack
           @all_sessions = @client.batch_create_new_sessions @min
           sessions = @all_sessions.dup
           num_transactions = (@min * @write_ratio).round
           pending_transactions = sessions.shift num_transactions
-          # init transaction queue
+          # init transaction stack
           pending_transactions.each do |transaction|
             future { checkin_transaction transaction.create_transaction }
           end
-          @session_queue = sessions
+          @session_stack = sessions
         end
 
         def shutdown
@@ -238,8 +238,8 @@ module Google
           @mutex.synchronize do
             @all_sessions.each { |s| future { s.release! } }
             @all_sessions = []
-            @session_queue = []
-            @transaction_queue = []
+            @session_stack = []
+            @transaction_stack = []
           end
           # shutdown existing thread pool
           @thread_pool.shutdown

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

@@ -676,7 +676,7 @@ module Google
             min: opts[:min], max: opts[:max], keepalive: opts[:keepalive],
             write_ratio: opts[:write_ratio], fail: opts[:fail],
             threads: opts[:threads]
-          }.delete_if { |_k, v| v.nil? }
+          }.compact
         end
       end
     end

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

@@ -41,8 +41,6 @@ module Google
       #   end
       #
       class Results
-        RST_STREAM_INTERNAL_ERROR = "Received RST_STREAM".freeze
-        EOS_INTERNAL_ERROR = "Received unexpected EOS on DATA frame from server".freeze
         ##
         # The read timestamp chosen for single-use snapshots (read-only
         # transactions).
@@ -177,7 +175,7 @@ module Google
 
               if resumable?(resume_token)
                 should_resume_request = true
-              elsif retryable?(err)
+              elsif @service.retryable?(err)
                 should_retry_request = true
               elsif err.is_a?(Google::Cloud::Error)
                 raise err
@@ -227,22 +225,6 @@ module Google
           resume_token && !resume_token.empty?
         end
 
-        ##
-        # @private
-        # Checks if a request can be retried. This is based on the error returned.
-        # Retryable errors are:
-        #   - Unavailable error
-        #   - Internal EOS error
-        #   - Internal RST_STREAM error
-        def retryable? err
-          err.instance_of?(Google::Cloud::UnavailableError) ||
-            err.instance_of?(GRPC::Unavailable) ||
-            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(EOS_INTERNAL_ERROR)) ||
-            (err.instance_of?(GRPC::Internal) && err.details.include?(EOS_INTERNAL_ERROR)) ||
-            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(RST_STREAM_INTERNAL_ERROR)) ||
-            (err.instance_of?(GRPC::Internal) && err.details.include?(RST_STREAM_INTERNAL_ERROR))
-        end
-
         ##
         # @private
         # Resumes a request, by re-executing it with a resume token.
@@ -320,13 +302,14 @@ module Google
                                types: nil, transaction: nil,
                                partition_token: nil, seqno: nil,
                                query_options: nil, request_options: nil,
-                               call_options: nil
+                               call_options: nil, data_boost_enabled: nil
           execute_query_options = {
             transaction: transaction, params: params, types: types,
             partition_token: partition_token, seqno: seqno,
             query_options: query_options, request_options: request_options,
             call_options: call_options
           }
+          execute_query_options[:data_boost_enabled] = data_boost_enabled unless data_boost_enabled.nil?
           enum = service.execute_streaming_sql session_path, sql,
                                                **execute_query_options
           from_enum(enum, service).tap do |results|
@@ -341,14 +324,16 @@ module Google
         def self.read service, session_path, table, columns, keys: nil,
                       index: nil, limit: nil, transaction: nil,
                       partition_token: nil, request_options: nil,
-                      call_options: nil
+                      call_options: nil, data_boost_enabled: nil
           read_options = {
             keys: keys, index: index, limit: limit,
             transaction: transaction,
             partition_token: partition_token,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            data_boost_enabled: data_boost_enabled
           }
+          read_options[:data_boost_enabled] = data_boost_enabled unless data_boost_enabled.nil?
           enum = service.streaming_read_table \
             session_path, table, columns, **read_options
           from_enum(enum, service).tap do |results|

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

@@ -36,6 +36,9 @@ module Google
         attr_accessor :lib_version
         attr_accessor :quota_project
 
+        RST_STREAM_INTERNAL_ERROR = "Received RST_STREAM".freeze
+        EOS_INTERNAL_ERROR = "Received unexpected EOS on DATA frame from server".freeze
+
         ##
         # Creates a new Service instance.
         def initialize project, credentials, quota_project: nil,
@@ -141,7 +144,7 @@ module Google
             display_name: name, config: instance_config_path(config),
             node_count: nodes, processing_units: processing_units,
             labels: labels
-          }.delete_if { |_, v| v.nil? })
+          }.compact)
 
           request = {
             parent:      project_path,
@@ -326,7 +329,7 @@ module Google
                                   params: nil, types: nil, resume_token: nil,
                                   partition_token: nil, seqno: nil,
                                   query_options: nil, request_options: nil,
-                                  call_options: nil
+                                  call_options: nil, data_boost_enabled: nil
           opts = default_options session_name: session_name,
                                  call_options: call_options
           request =  {
@@ -341,6 +344,7 @@ module Google
             query_options: query_options,
             request_options: request_options
           }
+          request[:data_boost_enabled] = data_boost_enabled unless data_boost_enabled.nil?
           service.execute_streaming_sql request, opts
         end
 
@@ -372,7 +376,8 @@ module Google
         def streaming_read_table session_name, table_name, columns, keys: nil,
                                  index: nil, transaction: nil, limit: nil,
                                  resume_token: nil, partition_token: nil,
-                                 request_options: nil, call_options: nil
+                                 request_options: nil, call_options: nil,
+                                 data_boost_enabled: nil
           opts = default_options session_name: session_name,
                                  call_options: call_options
           request = {
@@ -381,6 +386,7 @@ module Google
             limit: limit, resume_token: resume_token,
             partition_token: partition_token, request_options: request_options
           }
+          request[:data_boost_enabled] = data_boost_enabled unless data_boost_enabled.nil?
           service.streaming_read request, opts
         end
 
@@ -470,7 +476,7 @@ module Google
                 read_timestamp: Convert.time_to_timestamp(timestamp),
                 exact_staleness: Convert.number_to_duration(staleness),
                 return_read_timestamp: true
-              }.delete_if { |_, v| v.nil? }
+              }.compact
             )
           )
           opts = default_options session_name: session_name,
@@ -580,6 +586,21 @@ module Google
           databases.restore_database request, opts
         end
 
+        ##
+        # Checks if a request can be retried. This is based on the error returned.
+        # Retryable errors are:
+        #   - Unavailable error
+        #   - Internal EOS error
+        #   - Internal RST_STREAM error
+        def retryable? err
+          err.instance_of?(Google::Cloud::UnavailableError) ||
+            err.instance_of?(GRPC::Unavailable) ||
+            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(EOS_INTERNAL_ERROR)) ||
+            (err.instance_of?(GRPC::Internal) && err.details.include?(EOS_INTERNAL_ERROR)) ||
+            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(RST_STREAM_INTERNAL_ERROR)) ||
+            (err.instance_of?(GRPC::Internal) && err.details.include?(RST_STREAM_INTERNAL_ERROR))
+        end
+
         def inspect
           "#{self.class}(#{@project})"
         end

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

@@ -338,7 +338,7 @@ module Google
         #
         def execute_query sql, params: nil, types: nil, transaction: nil,
                           partition_token: nil, seqno: nil, query_options: nil,
-                          request_options: nil, call_options: nil
+                          request_options: nil, call_options: nil, data_boost_enabled: nil
           ensure_service!
           if query_options.nil?
             query_options = @query_options
@@ -353,7 +353,8 @@ module Google
                                           seqno: seqno,
                                           query_options: query_options,
                                           request_options: request_options,
-                                          call_options: call_options
+                                          call_options: call_options,
+                                          data_boost_enabled: data_boost_enabled
           @last_updated_at = Time.now
           results
         end
@@ -496,7 +497,7 @@ module Google
         #
         def read table, columns, keys: nil, index: nil, limit: nil,
                  transaction: nil, partition_token: nil, request_options: nil,
-                 call_options: nil
+                 call_options: nil, data_boost_enabled: nil
           ensure_service!
 
           results = Results.read service, path, table, columns,
@@ -504,7 +505,8 @@ module Google
                                  transaction: transaction,
                                  partition_token: partition_token,
                                  request_options: request_options,
-                                 call_options: call_options
+                                 call_options: call_options,
+                                 data_boost_enabled: data_boost_enabled
           @last_updated_at = Time.now
           results
         end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "2.16.1".freeze
+      VERSION = "2.17.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.16.1
+  version: 2.17.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -347,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Spanner API