google-cloud-spanner 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ecf7b383ed94a1522a5d90bd7574113f087c5ab
-  data.tar.gz: c4698851d6e116762e2ea65a3e6e74f252af7060
+  metadata.gz: 0d52caffdd789f039f91609da3f8dba633459c82
+  data.tar.gz: ecc7cca28368c261123342f43e9b055f13c22d70
 SHA512:
-  metadata.gz: 6014ed1d974e1524681604fc4da27ff8404308e7e5998ff6b2aa7c69cfc9d599d41a4312755177c33c4c499cc18c8623ce59fe433cebe30ce0dff96c63c73439
-  data.tar.gz: a38b63f7ebada70240457881d43d12df69238ad0562f2a9384647c74cf8ddcec34e286e7946e657c55cfe5d09e467e0ae2655fbe32ac89c4ab2cef26e6e2e7c1
+  metadata.gz: cfd38cc3172d32788a6891d78e44e349b8410c23285bcaa2bd79b582a58a48ce167f45251fec7ceff4df44b8f9fc6484f83d4feb7d744958ca6d8c99b1f2d457
+  data.tar.gz: 41f84f6f1432833bc79ca731f8b99d29ea6edd70bc71ebdc6b34afe7a7b16f0b1709968d2d358aee5ba6df91f052cd6324a53590a6d7c5d8d73e544b42f5b9df

data/lib/google/cloud/spanner.rb

@@ -132,7 +132,7 @@ module Google
     #
     # db = spanner.client "my-instance", "my-database"
     #
-    # results = client.execute "SELECT 1"
+    # results = db.execute "SELECT 1"
     #
     # results.rows.each do |row|
     #   puts row
@@ -160,8 +160,8 @@ module Google
     # db = spanner.client "my-instance", "my-database"
     #
     # db.commit do |c|
-    #   c.update "users", [{ id: 1, name: "Charlie", active: false }]
-    #   c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+    #   c.update "users", [{ id: 1, username: "charlie94", name: "Charlie" }]
+    #   c.insert "users", [{ id: 2, username: "harvey00", name: "Harvey" }]
     # end
     # ```
     #
@@ -232,7 +232,7 @@ module Google
     #   # Read the second album budget.
     #   second_album_result = tx.read "Albums", ["marketing_budget"],
     #                                 keys: [[2, 2]], limit: 1
-    #   second_album_row = second_album_result.first
+    #   second_album_row = second_album_result.rows.first
     #   second_album_budget = second_album_row.values.first
     #
     #   transfer_amount = 200000
@@ -245,7 +245,7 @@ module Google
     #   # Read the first album's budget.
     #   first_album_result = tx.read "Albums", ["marketing_budget"],
     #                                 keys: [[1, 1]], limit: 1
-    #   first_album_row = first_album_result.first
+    #   first_album_row = first_album_result.rows.first
     #   first_album_budget = first_album_row.values.first
     #
     #   # Update the budgets.
@@ -366,12 +366,16 @@ module Google
       def self.new project: nil, keyfile: nil, scope: nil, timeout: nil,
                    client_config: nil
         project ||= Google::Cloud::Spanner::Project.default_project
+        project = project.to_s # Always cast to a string
+        fail ArgumentError, "project is missing" if project.empty?
+
         if keyfile.nil?
           credentials = Google::Cloud::Spanner::Credentials.default scope: scope
         else
           credentials = Google::Cloud::Spanner::Credentials.new(
             keyfile, scope: scope)
         end
+
         Google::Cloud::Spanner::Project.new(
           Google::Cloud::Spanner::Service.new(
             project, credentials, timeout: timeout,

data/lib/google/cloud/spanner/admin/database/v1/database_admin_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

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

@@ -51,13 +51,11 @@ module Google
       class Client
         ##
         # @private Creates a new Spanner Client instance.
-        def initialize project, instance_id, database_id, min: 10, max: 100,
-                       keepalive: 1800, write_ratio: 0.3, fail: true
+        def initialize project, instance_id, database_id, opts = {}
           @project = project
           @instance_id = instance_id
           @database_id = database_id
-          @pool = Pool.new self, min: min, max: max, keepalive: keepalive,
-                                 write_ratio: write_ratio, fail: fail
+          @pool = Pool.new self, opts
         end
 
         # The unique identifier for the project.
@@ -663,6 +661,9 @@ module Google
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+
         ##
         # Creates a transaction for reads and writes that execute atomically at
         # a single logical point in time across columns, rows, and tables in a
@@ -699,8 +700,8 @@ module Google
         #       puts "User #{row[:id]} is #{row[:name]}"
         #     end
         #
-        #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
-        #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #     tx.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
         #   end
         #
         # @example Manually rollback the transaction using {Rollback}:
@@ -710,8 +711,8 @@ module Google
         #   db = spanner.client "my-instance", "my-database"
         #
         #   db.transaction do |tx|
-        #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
-        #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+        #     tx.update "users", [{ id: 1, name: "Charlie", active: false }]
+        #     tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
         #
         #     if something_wrong?
         #       # Rollback the transaction without passing on the error
@@ -722,6 +723,9 @@ module Google
         #
         def transaction deadline: 120, &block
           ensure_service!
+          unless Thread.current[:transaction_id].nil?
+            fail "Nested transactions are not allowed"
+          end
 
           deadline = validate_deadline deadline
           backoff = 1.0
@@ -729,13 +733,19 @@ module Google
 
           @pool.with_transaction do |tx|
             begin
+              Thread.current[:transaction_id] = tx.transaction_id
               block.call tx
               commit_resp = @project.service.commit \
                 tx.session.path, tx.mutations, transaction_id: tx.transaction_id
               return Convert.timestamp_to_time commit_resp.commit_timestamp
-            rescue Google::Cloud::AbortedError => err
+            rescue GRPC::Aborted, Google::Cloud::AbortedError => err
               # Re-raise if deadline has passed
-              raise err if current_time - start_time > deadline
+              if current_time - start_time > deadline
+                if err.is_a? GRPC::BadStatus
+                  err = Google::Cloud::Error.from_error err
+                end
+                raise err
+              end
               # Sleep the amount from RetryDelay, or incremental backoff
               sleep(delay_from_aborted(err) || backoff *= 1.3)
               # Create new transaction on the session and retry the block
@@ -748,10 +758,15 @@ module Google
               return nil if err.is_a? Rollback
               # Re-raise error.
               raise err
+            ensure
+              Thread.current[:transaction_id] = nil
             end
           end
         end
 
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+
         ##
         # Creates a snapshot read-only transaction for reads that execute
         # atomically at a single logical point in time across columns, rows, and
@@ -811,14 +826,24 @@ module Google
                                   read_timestamp: read_timestamp,
                                   staleness: staleness,
                                   exact_staleness: exact_staleness
+
           ensure_service!
+          unless Thread.current[:transaction_id].nil?
+            fail "Nested snapshots are not allowed"
+          end
+
           @pool.with_session do |session|
-            snp_grpc = @project.service.create_snapshot \
-              session.path, strong: strong,
-                            timestamp: (timestamp || read_timestamp),
-                            staleness: (staleness || exact_staleness)
-            snp = Snapshot.from_grpc(snp_grpc, session)
-            yield snp if block_given?
+            begin
+              snp_grpc = @project.service.create_snapshot \
+                session.path, strong: strong,
+                              timestamp: (timestamp || read_timestamp),
+                              staleness: (staleness || exact_staleness)
+              Thread.current[:transaction_id] = snp_grpc.id
+              snp = Snapshot.from_grpc(snp_grpc, session)
+              yield snp if block_given?
+            ensure
+              Thread.current[:transaction_id] = nil
+            end
           end
           nil
         end
@@ -1011,7 +1036,8 @@ module Google
         end
 
         ##
-        # Retrieves the delay value from Google::Cloud::AbortedError
+        # Retrieves the delay value from Google::Cloud::AbortedError or
+        # GRPC::Aborted
         def delay_from_aborted err
           return nil if err.nil?
           if err.respond_to?(:metadata) && err.metadata["retryDelay"]

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

@@ -209,48 +209,6 @@ module Google
             end
           end
 
-          ##
-          # @private Convert an Object to a Google::Protobuf::Value.
-          def object_to_value obj
-            case obj
-            when NilClass then Google::Protobuf::Value.new null_value:
-              :NULL_VALUE
-            when Numeric then Google::Protobuf::Value.new number_value: obj
-            when String then Google::Protobuf::Value.new string_value: obj
-            when TrueClass then Google::Protobuf::Value.new bool_value: true
-            when FalseClass then Google::Protobuf::Value.new bool_value: false
-            when Hash then Google::Protobuf::Value.new struct_value:
-              hash_to_struct(obj)
-            when Array then Google::Protobuf::Value.new list_value:
-              Google::Protobuf::ListValue.new(values:
-                obj.map { |o| object_to_value(o) })
-            else
-              # TODO: Could raise ArgumentError here, or convert to a string
-              Google::Protobuf::Value.new string_value: obj.to_s
-            end
-          end
-
-          ##
-          # @private Convert a Google::Protobuf::Value to an Object.
-          def value_to_object value
-            # TODO: ArgumentError if struct is not a Google::Protobuf::Value
-            if value.kind == :null_value
-              nil
-            elsif value.kind == :number_value
-              value.number_value
-            elsif value.kind == :string_value
-              value.string_value
-            elsif value.kind == :bool_value
-              value.bool_value
-            elsif value.kind == :struct_value
-              struct_to_hash value.struct_value
-            elsif value.kind == :list_value
-              value.list_value.values.map { |v| value_to_object(v) }
-            else
-              nil # just in case
-            end
-          end
-
           def number_to_duration number
             return nil if number.nil?
 

data/lib/google/cloud/spanner/database/job.rb

@@ -72,6 +72,8 @@ module Google
           #   job = spanner.create_database "my-instance",
           #                                 "my-new-database"
           #
+          #   job.done? #=> false
+          #   job.reload!
           #   job.done? #=> true
           #   database = job.database
           #

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

@@ -31,8 +31,8 @@ module Google
       #   db = spanner.client "my-instance", "my-database"
       #
       #   db.transaction do |tx|
-      #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
-      #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+      #     tx.update "users", [{ id: 1, name: "Charlie", active: false }]
+      #     tx.insert "users", [{ id: 2, name: "Harvey",  active: true }]
       #
       #     if something_wrong?
       #       # Rollback the transaction without passing on the error

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

@@ -279,7 +279,7 @@ module Google
         #
         #   spanner = Google::Cloud::Spanner.new
         #   instance = spanner.instance "my-instance"
-        #   database = instance.database "my-database" #=> nil
+        #   database = instance.database "my-database" # nil
         #
         def database database_id
           ensure_service!

data/lib/google/cloud/spanner/instance/job.rb

@@ -78,6 +78,8 @@ module Google
           #                                 nodes: 5,
           #                                 labels: { production: :env }
           #
+          #   job.done? #=> false
+          #   job.reload!
           #   job.done? #=> true
           #   instance = job.instance
           #

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

@@ -158,20 +158,6 @@ module Google
           roles[role_name] ||= []
         end
 
-        ##
-        # Returns a deep copy of the policy.
-        #
-        # @return [Policy]
-        #
-        def deep_dup
-          dup.tap do |p|
-            roles_dup = p.roles.each_with_object({}) do |(k, v), memo|
-              memo[k] = v.dup rescue value
-            end
-            p.instance_variable_set "@roles", roles_dup
-          end
-        end
-
         ##
         # @private Convert the Policy to a Google::Iam::V1::Policy object.
         def to_grpc

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

@@ -33,7 +33,7 @@ module Google
         attr_accessor :all_sessions, :session_queue, :transaction_queue
 
         def initialize client, min: 10, max: 100, keepalive: 1800,
-                       write_ratio: 0.3, fail: true
+                       write_ratio: 0.3, fail: true, threads: nil
           @client = client
           @min = min
           @max = max
@@ -42,6 +42,7 @@ module Google
           @write_ratio = 0 if write_ratio < 0
           @write_ratio = 1 if write_ratio > 1
           @fail = fail
+          @threads = threads || [2, Concurrent.processor_count * 2].max
 
           @mutex = Mutex.new
           @resource = ConditionVariable.new
@@ -86,11 +87,11 @@ module Google
         end
 
         def checkin_session session
-          unless all_sessions.include? session
-            fail ArgumentError, "Cannot checkin session"
-          end
-
           @mutex.synchronize do
+            unless all_sessions.include? session
+              fail ArgumentError, "Cannot checkin session"
+            end
+
             session_queue.push session
 
             @resource.signal
@@ -144,11 +145,11 @@ module Google
         end
 
         def checkin_transaction tx
-          unless all_sessions.include? tx.session
-            fail ArgumentError, "Cannot checkin session"
-          end
-
           @mutex.synchronize do
+            unless all_sessions.include? tx.session
+              fail ArgumentError, "Cannot checkin session"
+            end
+
             transaction_queue.push tx
 
             @resource.signal
@@ -215,10 +216,7 @@ module Google
 
         def init
           # init the thread pool
-          @thread_pool = Concurrent::FixedThreadPool.new(
-            [2, Concurrent.processor_count].max * 2,
-            fallback_policy: :caller_runs
-          )
+          @thread_pool = Concurrent::FixedThreadPool.new @threads
           # init the queues
           @new_sessions_in_process = @min.to_i
           @all_sessions = []

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

@@ -158,7 +158,7 @@ module Google
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new
-        #   instance = spanner.instance "non-existing" #=> nil
+        #   instance = spanner.instance "non-existing" # nil
         #
         def instance instance_id
           ensure_service!
@@ -288,7 +288,7 @@ module Google
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new
-        #   config = spanner.instance_config "non-existing" #=> nil
+        #   config = spanner.instance_config "non-existing" # nil
         #
         def instance_config instance_config_id
           ensure_service!
@@ -355,7 +355,7 @@ module Google
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new
-        #   database = spanner.database "my-instance", "my-database" #=> nil
+        #   database = spanner.database "my-instance", "my-database" # nil
         #
         def database instance_id, database_id
           ensure_service!
@@ -432,6 +432,8 @@ module Google
         #     {SessionLimitError} when the client has allocated the `max` number
         #     of sessions. When `false` the client blocks until a session
         #     becomes available. The default is `true`.
+        #   * `:threads` (Integer) The number of threads in the thread pool. The
+        #     default is twice the number of available CPUs.
         #
         # @return [Client] The newly created client.
         #
@@ -471,7 +473,8 @@ module Google
 
         def valid_session_pool_options opts = {}
           { min: opts[:min], max: opts[:max], keepalive: opts[:keepalive],
-            write_ratio: opts[:write_ratio], fail: opts[:fail]
+            write_ratio: opts[:write_ratio], fail: opts[:fail],
+            threads: opts[:threads]
           }.delete_if { |_k, v| v.nil? }
         end
       end

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

@@ -36,7 +36,7 @@ module Google
       #
       #   results = db.execute "SELECT * FROM users"
       #
-      #   results.types.each do |name, type|
+      #   results.fields.pairs.each do |name, type|
       #     puts "Column #{name} is type {type}"
       #   end
       #

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

@@ -272,24 +272,6 @@ module Google
           end
         end
 
-        def execute_sql session_name, sql, transaction: nil, params: nil
-          input_params = nil
-          input_param_types = nil
-          unless params.nil?
-            input_param_pairs = Convert.to_query_params params
-            input_params = Google::Protobuf::Struct.new(
-              fields: Hash[input_param_pairs.map { |k, v| [k, v.first] }])
-            input_param_types = Hash[
-              input_param_pairs.map { |k, v| [k, v.last] }]
-          end
-          opts = default_options_from_session session_name
-          execute do
-            service.execute_sql \
-              session_name, sql, transaction: transaction, params: input_params,
-                                 param_types: input_param_types, options: opts
-          end
-        end
-
         def streaming_execute_sql session_name, sql, transaction: nil,
                                   params: nil, types: nil, resume_token: nil
           input_params = nil
@@ -310,18 +292,6 @@ module Google
           end
         end
 
-        def read_table session_name, table_name, columns, keys: nil, index: nil,
-                       transaction: nil, limit: nil
-          columns.map!(&:to_s)
-          opts = default_options_from_session session_name
-          execute do
-            service.read \
-              session_name, table_name, columns, key_set(keys),
-              transaction: transaction, index: index, limit: limit,
-              options: opts
-          end
-        end
-
         def streaming_read_table session_name, table_name, columns, keys: nil,
                                  index: nil, transaction: nil, limit: nil,
                                  resume_token: nil

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

@@ -38,11 +38,38 @@ module Google
       #   db = spanner.client "my-instance", "my-database"
       #
       #   db.transaction do |tx|
-      #     results = tx.execute "SELECT * FROM users"
+      #     # Read the second album budget.
+      #     second_album_result = tx.read "Albums", ["marketing_budget"],
+      #                                   keys: [[2, 2]], limit: 1
+      #     second_album_row = second_album_result.rows.first
+      #     second_album_budget = second_album_row.values.first
       #
-      #     results.rows.each do |row|
-      #       puts "User #{row[:id]} is #{row[:name]}"
+      #     transfer_amount = 200000
+      #
+      #     if second_album_budget < 300000
+      #       # Raising an exception will automatically roll back the
+      #       # transaction.
+      #       raise "The second album doesn't have enough funds to transfer"
       #     end
+      #
+      #     # Read the first album's budget.
+      #     first_album_result = tx.read "Albums", ["marketing_budget"],
+      #                                   keys: [[1, 1]], limit: 1
+      #     first_album_row = first_album_result.rows.first
+      #     first_album_budget = first_album_row.values.first
+      #
+      #     # Update the budgets.
+      #     second_album_budget -= transfer_amount
+      #     first_album_budget += transfer_amount
+      #     puts "Setting first album's budget to #{first_album_budget} and " \
+      #          "the second album's budget to #{second_album_budget}."
+      #
+      #     # Update the rows.
+      #     rows = [
+      #       {singer_id: 1, album_id: 1, marketing_budget: first_album_budget},
+      #       {singer_id: 2, album_id: 2, marketing_budget: second_album_budget}
+      #     ]
+      #     tx.update "Albums", rows
       #   end
       #
       class Transaction
@@ -423,7 +450,7 @@ module Google
         #   db = spanner.client "my-instance", "my-database"
         #
         #   db.transaction do |tx|
-        #     users_types = rx.fields_for "users"
+        #     users_types = tx.fields_for "users"
         #     tx.insert "users", [{ id: 1, name: "Charlie", active: false },
         #                         { id: 2, name: "Harvey",  active: true }],
         #               types: users_types

data/lib/google/cloud/spanner/v1/spanner_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "0.21.0"
+      VERSION = "0.22.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -197,16 +197,16 @@ dependencies:
   name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.8
 description: google-cloud-spanner is the official library for Google Cloud Spanner
   API.
 email: