google-cloud-spanner 2.4.0 → 2.8.1

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

@@ -70,7 +70,8 @@ module Google
       #   end
       #
       class Policy
-        attr_reader :etag, :roles
+        attr_reader :etag
+        attr_reader :roles
 
         ##
         # @private Creates a Policy object.
@@ -169,7 +170,7 @@ module Google
                 role: role_name,
                 members: roles[role_name]
               )
-            end
+            end.compact
           )
         end
 

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

@@ -29,7 +29,9 @@ module Google
       # {Google::Cloud::Spanner::Session} instances.
       #
       class Pool
-        attr_accessor :all_sessions, :session_queue, :transaction_queue
+        attr_accessor :all_sessions
+        attr_accessor :session_queue
+        attr_accessor :transaction_queue
 
         def initialize client, min: 10, max: 100, keepalive: 1800,
                        write_ratio: 0.3, fail: true, threads: nil
@@ -38,7 +40,7 @@ module Google
           @max = max
           @keepalive = keepalive
           @write_ratio = write_ratio
-          @write_ratio = 0 if write_ratio < 0
+          @write_ratio = 0 if write_ratio.negative?
           @write_ratio = 1 if write_ratio > 1
           @fail = fail
           @threads = threads || [2, Concurrent.processor_count * 2].max
@@ -143,13 +145,13 @@ module Google
           return new_transaction! if action == :new
         end
 
-        def checkin_transaction tx
+        def checkin_transaction txn
           @mutex.synchronize do
-            unless all_sessions.include? tx.session
+            unless all_sessions.include? txn.session
               raise ArgumentError, "Cannot checkin session"
             end
 
-            transaction_queue.push tx
+            transaction_queue.push txn
 
             @resource.signal
           end
@@ -182,7 +184,7 @@ module Google
           @mutex.synchronize do
             available_count = session_queue.count + transaction_queue.count
             release_count = @min - available_count
-            release_count = 0 if release_count < 0
+            release_count = 0 if release_count.negative?
 
             to_keepalive += (session_queue + transaction_queue).select do |x|
               x.idle_since? @keepalive
@@ -282,10 +284,8 @@ module Google
           @keepalive_task.execute
         end
 
-        def future
-          Concurrent::Future.new executor: @thread_pool do
-            yield
-          end.execute
+        def future &block
+          Concurrent::Future.new(executor: @thread_pool, &block).execute
         end
       end
     end

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

@@ -177,7 +177,10 @@ module Google
         #   configuration. Values can be the `instance_config_id`, the full
         #   path, or an {Instance::Config} object. Required.
         # @param [Integer] nodes The number of nodes allocated to this instance.
-        #   Required.
+        #   Optional. Specify either `nodes` or `processing_units`
+        # @param [Integer] processing_units The number of processing units
+        #   allocated to this instance. Optional. Specify either `nodes`
+        #   or `processing_units`
         # @param [Hash] labels Cloud Labels are a flexible and lightweight
         #   mechanism for organizing cloud resources into groups that reflect a
         #   customer's organizational needs and deployment strategies. Cloud
@@ -195,6 +198,7 @@ module Google
         #
         # @return [Instance::Job] The job representing the long-running,
         #   asynchronous processing of an instance create operation.
+        # @raise [ArgumentError] if both processing_units or nodes are specified.
         #
         # @example
         #   require "google/cloud/spanner"
@@ -217,14 +221,36 @@ module Google
         #     instance = job.instance
         #   end
         #
+        # @example Create instance using processsing units
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   job = spanner.create_instance "my-new-instance",
+        #                                 name: "My New Instance",
+        #                                 config: "regional-us-central1",
+        #                                 processing_units: 500,
+        #                                 labels: { production: :env }
+        #
+        #   job.done? #=> false
+        #   job.reload! # API call
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     instance = job.instance
+        #   end
+        #
         def create_instance instance_id, name: nil, config: nil, nodes: nil,
-                            labels: nil
+                            processing_units: nil, labels: nil
           config = config.path if config.respond_to? :path
+
           # Convert from possible Google::Protobuf::Map
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
           grpc = service.create_instance \
             instance_id, name: name, config: config, nodes: nodes,
-                         labels: labels
+                         processing_units: processing_units, labels: labels
           Instance::Job.from_grpc grpc, service
         end
 
@@ -380,6 +406,13 @@ module Google
         #   These statements execute atomically with the creation of the
         #   database: if there is an error in any statement, the database is not
         #   created. Optional.
+        # @param [Hash] encryption_config An encryption configuration describing
+        #   the encryption type and key resources in Cloud KMS. Optional. The
+        #   following settings can be provided:
+        #
+        #   * `:kms_key_name` (String) The name of KMS key to use which should
+        #     be the full path, e.g., `projects/<project>/locations/<location>\
+        #     /keyRings/<key_ring>/cryptoKeys/<kms_key_name>`
         #
         # @return [Database::Job] The job representing the long-running,
         #   asynchronous processing of a database create operation.
@@ -402,9 +435,32 @@ module Google
         #     database = job.database
         #   end
         #
-        def create_database instance_id, database_id, statements: []
+        # @example Create with encryption config
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   kms_key_name = "projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>"
+        #   encryption_config = { kms_key_name: kms_key_name }
+        #   job = spanner.create_database "my-instance",
+        #                                 "my-new-database",
+        #                                 encryption_config: encryption_config
+        #
+        #   job.done? #=> false
+        #   job.reload! # API call
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     database = job.database
+        #   end
+        #
+        def create_database instance_id, database_id, statements: [],
+                            encryption_config: nil
           grpc = service.create_database instance_id, database_id,
-                                         statements: statements
+                                         statements: statements,
+                                         encryption_config: encryption_config
           Database::Job.from_grpc grpc, service
         end
 
@@ -460,6 +516,8 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     available optimizer version.
+        #   * `:optimizer_statistics_package` (String) Statistics package to
+        #     use. Empty to use the database default.
         #
         # @return [Client] The newly created client.
         #
@@ -524,6 +582,8 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     available optimizer version.
+        #   * `:optimizer_statistics_package` (String) Statistics package to
+        #     use. Empty to use the database default.
         #
         # @return [Client] The newly created client.
         #

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

@@ -251,14 +251,14 @@ module Google
             @service.execute_streaming_sql(
               @session_path,
               @sql,
-              @execute_query_options.merge(resume_token: resume_token)
+              **@execute_query_options.merge(resume_token: resume_token)
             )
           else
             @service.streaming_read_table(
               @session_path,
               @table,
               @columns,
-              @read_options.merge(resume_token: resume_token)
+              **@read_options.merge(resume_token: resume_token)
             )
           end
         end
@@ -268,9 +268,9 @@ module Google
         # Retries a request, by re-executing it from scratch.
         def retry_request
           if @execute_query_options
-            @service.execute_streaming_sql @session_path, @sql, @execute_query_options
+            @service.execute_streaming_sql @session_path, @sql, **@execute_query_options
           else
-            @service.streaming_read_table @session_path, @table, @columns, @read_options
+            @service.streaming_read_table @session_path, @table, @columns, **@read_options
           end
         end
 
@@ -319,14 +319,16 @@ module Google
         def self.execute_query service, session_path, sql, params: nil,
                                types: nil, transaction: nil,
                                partition_token: nil, seqno: nil,
-                               query_options: nil, call_options: nil
+                               query_options: nil, request_options: nil,
+                               call_options: nil
           execute_query_options = {
             transaction: transaction, params: params, types: types,
             partition_token: partition_token, seqno: seqno,
-            query_options: query_options, call_options: call_options
+            query_options: query_options, request_options: request_options,
+            call_options: call_options
           }
           enum = service.execute_streaming_sql session_path, sql,
-                                               execute_query_options
+                                               **execute_query_options
           from_enum(enum, service).tap do |results|
             results.instance_variable_set :@session_path, session_path
             results.instance_variable_set :@sql,          sql
@@ -338,15 +340,17 @@ module Google
         # @private
         def self.read service, session_path, table, columns, keys: nil,
                       index: nil, limit: nil, transaction: nil,
-                      partition_token: nil, call_options: nil
+                      partition_token: nil, request_options: nil,
+                      call_options: nil
           read_options = {
             keys: keys, index: index, limit: limit,
             transaction: transaction,
             partition_token: partition_token,
+            request_options: request_options,
             call_options: call_options
           }
           enum = service.streaming_read_table \
-            session_path, table, columns, read_options
+            session_path, table, columns, **read_options
           from_enum(enum, service).tap do |results|
             results.instance_variable_set :@session_path, session_path
             results.instance_variable_set :@table,        table

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

@@ -28,8 +28,12 @@ module Google
       # @private Represents the gRPC Spanner service, including all the API
       # methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :host, :lib_name,
-                      :lib_version
+        attr_accessor :project
+        attr_accessor :credentials
+        attr_accessor :timeout
+        attr_accessor :host
+        attr_accessor :lib_name
+        attr_accessor :lib_version
 
         ##
         # Creates a new Service instance.
@@ -123,13 +127,15 @@ module Google
         end
 
         def create_instance instance_id, name: nil, config: nil, nodes: nil,
-                            labels: nil, call_options: nil
+                            processing_units: nil, labels: nil,
+                            call_options: nil
           opts = default_options call_options: call_options
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
 
           create_obj = Admin::Instance::V1::Instance.new({
             display_name: name, config: instance_config_path(config),
-            node_count: nodes, labels: labels
+            node_count: nodes, processing_units: processing_units,
+            labels: labels
           }.delete_if { |_, v| v.nil? })
 
           request = {
@@ -140,12 +146,17 @@ module Google
           instances.create_instance request, opts
         end
 
-        def update_instance instance, call_options: nil
+        def update_instance instance, field_mask: nil, call_options: nil
           opts = default_options call_options: call_options
-          mask = Google::Protobuf::FieldMask.new(
-            paths: %w[display_name node_count labels]
-          )
-          request = { instance: instance, field_mask: mask }
+
+          if field_mask.nil? || field_mask.empty?
+            field_mask = %w[display_name node_count labels]
+          end
+
+          request = {
+            instance: instance,
+            field_mask: Google::Protobuf::FieldMask.new(paths: field_mask)
+          }
           instances.update_instance request, opts
         end
 
@@ -210,12 +221,13 @@ module Google
         end
 
         def create_database instance_id, database_id, statements: [],
-                            call_options: nil
+                            call_options: nil, encryption_config: nil
           opts = default_options call_options: call_options
           request = {
             parent: instance_path(instance_id),
             create_statement: "CREATE DATABASE `#{database_id}`",
-            extra_statements: Array(statements)
+            extra_statements: Array(statements),
+            encryption_config: encryption_config
           }
           databases.create_database request, opts
         end
@@ -308,7 +320,8 @@ module Google
         def execute_streaming_sql session_name, sql, transaction: nil,
                                   params: nil, types: nil, resume_token: nil,
                                   partition_token: nil, seqno: nil,
-                                  query_options: nil, call_options: nil
+                                  query_options: nil, request_options: nil,
+                                  call_options: nil
           opts = default_options session_name: session_name,
                                  call_options: call_options
           request =  {
@@ -320,13 +333,14 @@ module Google
             resume_token: resume_token,
             partition_token: partition_token,
             seqno: seqno,
-            query_options: query_options
+            query_options: query_options,
+            request_options: request_options
           }
           service.execute_streaming_sql request, opts
         end
 
         def execute_batch_dml session_name, transaction, statements, seqno,
-                              call_options: nil
+                              request_options: nil, call_options: nil
           opts = default_options session_name: session_name,
                                  call_options: call_options
           statements = statements.map(&:to_grpc)
@@ -334,7 +348,8 @@ module Google
             session: session_name,
             transaction: transaction,
             statements: statements,
-            seqno: seqno
+            seqno: seqno,
+            request_options: request_options
           }
           results = service.execute_batch_dml request, opts
 
@@ -352,14 +367,14 @@ 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,
-                                 call_options: nil
+                                 request_options: nil, call_options: nil
           opts = default_options session_name: session_name,
                                  call_options: call_options
           request = {
             session: session_name, table: table_name, columns: columns,
             key_set: keys, transaction: transaction, index: index,
             limit: limit, resume_token: resume_token,
-            partition_token: partition_token
+            partition_token: partition_token, request_options: request_options
           }
           service.streaming_read request, opts
         end
@@ -397,7 +412,7 @@ module Google
         end
 
         def commit session_name, mutations = [], transaction_id: nil,
-                   commit_options: nil, call_options: nil
+                   commit_options: nil, request_options: nil, call_options: nil
           tx_opts = nil
           if transaction_id.nil?
             tx_opts = V1::TransactionOptions.new(
@@ -408,7 +423,8 @@ module Google
                                  call_options: call_options
           request = {
             session: session_name, transaction_id: transaction_id,
-            single_use_transaction: tx_opts, mutations: mutations
+            single_use_transaction: tx_opts, mutations: mutations,
+            request_options: request_options
           }
 
           if commit_options
@@ -464,7 +480,8 @@ module Google
         end
 
         def create_backup instance_id, database_id, backup_id, expire_time,
-                          version_time, call_options: nil
+                          version_time, call_options: nil,
+                          encryption_config: nil
           opts = default_options call_options: call_options
           backup = {
             database: database_path(instance_id, database_id),
@@ -474,7 +491,8 @@ module Google
           request = {
             parent:    instance_path(instance_id),
             backup_id: backup_id,
-            backup:    backup
+            backup:    backup,
+            encryption_config: encryption_config
           }
           databases.create_backup request, opts
         end
@@ -541,12 +559,13 @@ module Google
 
         def restore_database backup_instance_id, backup_id,
                              database_instance_id, database_id,
-                             call_options: nil
+                             call_options: nil, encryption_config: nil
           opts = default_options call_options: call_options
           request = {
             parent:      instance_path(database_instance_id),
             database_id: database_id,
-            backup:      backup_path(backup_instance_id, backup_id)
+            backup:      backup_path(backup_instance_id, backup_id),
+            encryption_config: encryption_config
           }
           databases.restore_database request, opts
         end

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

@@ -116,6 +116,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -141,6 +142,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`
@@ -163,6 +165,8 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     available optimizer version.
+        #   * `:optimizer_statistics_package` (String) Statistics package to
+        #     use. Empty to use the database default.
         # @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:
@@ -283,7 +287,10 @@ module Google
         #   db = spanner.client "my-instance", "my-database"
         #
         #   results = db.execute_query \
-        #     "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #     "SELECT * FROM users", query_options: {
+        #       optimizer_version: "1",
+        #       optimizer_statistics_package: "auto_20191128_14_47_22UTC"
+        #     }
         #
         #   results.rows.each do |row|
         #     puts "User #{row[:id]} is #{row[:name]}"
@@ -314,7 +321,7 @@ module Google
         #
         def execute_query sql, params: nil, types: nil, transaction: nil,
                           partition_token: nil, seqno: nil, query_options: nil,
-                          call_options: nil
+                          request_options: nil, call_options: nil
           ensure_service!
           if query_options.nil?
             query_options = @query_options
@@ -328,6 +335,7 @@ module Google
                                           partition_token: partition_token,
                                           seqno: seqno,
                                           query_options: query_options,
+                                          request_options: request_options,
                                           call_options: call_options
           @last_updated_at = Time.now
           results
@@ -369,7 +377,8 @@ module Google
         # @return [Array<Integer>] A list with the exact number of rows that
         #   were modified for each DML statement.
         #
-        def batch_update transaction, seqno, call_options: nil
+        def batch_update transaction, seqno, request_options: nil,
+                         call_options: nil
           ensure_service!
 
           raise ArgumentError, "block is required" unless block_given?
@@ -379,6 +388,7 @@ module Google
 
           results = service.execute_batch_dml path, transaction,
                                               batch.statements, seqno,
+                                              request_options: request_options,
                                               call_options: call_options
           @last_updated_at = Time.now
           results
@@ -434,13 +444,15 @@ module Google
         #   end
         #
         def read table, columns, keys: nil, index: nil, limit: nil,
-                 transaction: nil, partition_token: nil, call_options: nil
+                 transaction: nil, partition_token: nil, request_options: nil,
+                 call_options: nil
           ensure_service!
 
           results = Results.read service, path, table, columns,
                                  keys: keys, index: index, limit: limit,
                                  transaction: transaction,
                                  partition_token: partition_token,
+                                 request_options: request_options,
                                  call_options: call_options
           @last_updated_at = Time.now
           results
@@ -542,13 +554,15 @@ module Google
         #   puts commit_resp.timestamp
         #   puts commit_resp.stats.mutation_count
         #
-        def commit transaction_id: nil, commit_options: nil, call_options: nil
+        def commit transaction_id: nil, commit_options: nil,
+                   request_options: nil, call_options: nil
           ensure_service!
           commit = Commit.new
           yield commit
           commit_resp = service.commit path, commit.mutations,
                                        transaction_id: transaction_id,
                                        commit_options: commit_options,
+                                       request_options: request_options,
                                        call_options: call_options
           @last_updated_at = Time.now
           resp = CommitResponse.from_grpc commit_resp
@@ -573,6 +587,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -633,13 +648,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def upsert table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.upsert table, rows
           end
         end
@@ -662,6 +678,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -722,13 +739,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def insert table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.insert table, rows
           end
         end
@@ -750,6 +768,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -810,13 +829,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def update table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.update table, rows
           end
         end
@@ -840,6 +860,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -900,13 +921,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def replace table, *rows, transaction_id: nil, commit_options: nil,
-                    call_options: nil
+                    request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.replace table, rows
           end
         end
@@ -968,13 +990,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def delete table, keys = [], transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.delete table, keys
           end
         end