google-cloud-spanner 2.0.0 → 2.5.0

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

@@ -0,0 +1,87 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/spanner/commit_response/commit_stats"
+
+module Google
+  module Cloud
+    module Spanner
+      ##
+      # CommitResponse is a timestamp at which the transaction committed
+      # with additional attributes of commit stats.
+      #
+      # @example
+      #   require "google/cloud/spanner"
+      #
+      #   spanner = Google::Cloud::Spanner.new
+      #
+      #   db = spanner.client "my-instance", "my-database"
+      #
+      #   timestamp = db.commit do |c|
+      #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
+      #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+      #   end
+      #
+      #   puts timestamp
+      #
+      # @example With commit stats.
+      #   require "google/cloud/spanner"
+      #
+      #   spanner = Google::Cloud::Spanner.new
+      #
+      #   db = spanner.client "my-instance", "my-database"
+      #
+      #   commit_options = { return_commit_stats: true }
+      #   commit_resp = db.commit commit_options: commit_options do |c|
+      #     c.update "users", [{ id: 1, name: "Charlie", active: false }]
+      #     c.insert "users", [{ id: 2, name: "Harvey",  active: true }]
+      #   end
+      #
+      #   puts commit_resp.timestamp
+      #   puts commit_resp.stats.mutation_count
+      #
+      class CommitResponse
+        ##
+        # @private Creates a new CommitResponse instance.
+        def initialize grpc
+          @grpc = grpc
+        end
+
+        ##
+        # The timestamp at which the transaction committed.
+        # @return [Time]
+        def timestamp
+          Convert.timestamp_to_time @grpc.commit_timestamp
+        end
+
+        ##
+        # Additional statistics about a commit.
+        # @return [CommitStats, nil] Commit stats or nil if not stats not
+        #   present.
+        def stats
+          CommitStats.from_grpc @grpc.commit_stats if @grpc.commit_stats
+        end
+
+        ##
+        # @private
+        # Creates a new Commit responsee instance from a
+        # `Google::Cloud::Spanner::V1::CommitResponse`.
+        def self.from_grpc grpc
+          new grpc
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/commit_response/commit_stats.rb

@@ -0,0 +1,51 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/spanner/convert"
+
+module Google
+  module Cloud
+    module Spanner
+      class CommitResponse
+        ##
+        # # CommitStats
+        #
+        # Statistical information of a transaction commit.
+        #
+        class CommitStats
+          ##
+          # @private Creates a new CommitStats instance.
+          def initialize grpc
+            @grpc = grpc
+          end
+
+          # The total number of the mutations for the transaction.
+          # @return [Integer]
+          def mutation_count
+            @grpc.mutation_count
+          end
+
+          ##
+          # @private
+          # Creates a new CommitStats instance from a
+          # `Google::Cloud::Spanner::V1::CommitResponse::CommitStats`.
+          def self.from_grpc grpc
+            new grpc
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,6 +17,7 @@ require "time"
 require "date"
 require "stringio"
 require "base64"
+require "bigdecimal"
 require "google/cloud/spanner/data"
 
 module Google
@@ -67,6 +68,9 @@ module Google
               Google::Protobuf::Value.new bool_value: false
             when Integer
               Google::Protobuf::Value.new string_value: obj.to_s
+            # BigDecimal must be put before Numeric.
+            when BigDecimal
+              Google::Protobuf::Value.new string_value: obj.to_s("F")
             when Numeric
               if obj == Float::INFINITY
                 Google::Protobuf::Value.new string_value: "Infinity"
@@ -125,6 +129,9 @@ module Google
               :BOOL
             when Integer
               :INT64
+            # BigDecimal must be put before Numeric.
+            when BigDecimal
+              :NUMERIC
             when Numeric
               :FLOAT64
             when Time
@@ -214,6 +221,8 @@ module Google
               end
             when :STRUCT
               Data.from_grpc value.list_value.values, type.struct_type.fields
+            when :NUMERIC
+              BigDecimal value.string_value
             end
           end
 

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

@@ -139,9 +139,10 @@ module Google
         #
         def to_a skip_dup_check: nil
           values.map do |value|
-            if value.is_a? Data
+            case value
+            when Data
               value.to_h skip_dup_check: skip_dup_check
-            elsif value.is_a? Array
+            when Array
               value.map do |v|
                 v.is_a?(Data) ? v.to_h(skip_dup_check: skip_dup_check) : v
               end
@@ -169,9 +170,7 @@ module Google
         #   or indexes and corresponding values.
         #
         def to_h skip_dup_check: nil
-          unless skip_dup_check
-            raise DuplicateNameError if fields.duplicate_names?
-          end
+          raise DuplicateNameError if !skip_dup_check && fields.duplicate_names?
 
           Hash[keys.zip to_a(skip_dup_check: skip_dup_check)]
         end

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

@@ -85,6 +85,18 @@ module Google
           @grpc.name.split("/")[5]
         end
 
+        # The version retention period for a database.
+        # @return [String]
+        def version_retention_period
+          @grpc.version_retention_period
+        end
+
+        # The earliest available version time for a database.
+        # @return [Time]
+        def earliest_version_time
+          Convert.timestamp_to_time @grpc.earliest_version_time
+        end
+
         ##
         # The full path for the database resource. Values are of the form
         # `projects/<project_id>/instances/<instance_id>/databases/<database_id>`.
@@ -400,6 +412,11 @@ module Google
         #   366 days from the time the request is received. Required.
         #   Once the `expire_time` has passed, Cloud Spanner will delete the
         #   backup and free the resources used by the backup. Required.
+        # @param [Time] version_time Specifies the time to have an externally
+        #   consistent copy of the database. If no version time is specified,
+        #   it will be automatically set to the backup create time. The version
+        #   time can be as far in the past as specified by the database earliest
+        #   version time. Optional.
         # @return [Google::Cloud::Spanner::Backup::Job] The job representing
         #   the long-running, asynchronous processing of a backup create
         #   operation.
@@ -410,7 +427,11 @@ module Google
         #   spanner = Google::Cloud::Spanner.new
         #   database = spanner.database "my-instance", "my-database"
         #
-        #   job = database.create_backup "my-backup", Time.now + 36000
+        #   backup_id = "my-backup"
+        #   expire_time = Time.now + (24 * 60 * 60) # 1 day from now
+        #   version_time = Time.now - (24 * 60 * 60) # 1 day ago (optional)
+        #
+        #   job = database.create_backup backup_id, expire_time, version_time: version_time
         #
         #   job.done? #=> false
         #   job.reload! # API call
@@ -422,13 +443,14 @@ module Google
         #     backup = job.backup
         #   end
         #
-        def create_backup backup_id, expire_time
+        def create_backup backup_id, expire_time, version_time: nil
           ensure_service!
           grpc = service.create_backup \
             instance_id,
             database_id,
             backup_id,
-            expire_time
+            expire_time,
+            version_time
           Backup::Job.from_grpc grpc, service
         end
 

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

@@ -84,14 +84,23 @@ module Google
           end
 
           ##
-          # The backup contains an externally consistent copy of
-          # `source_database` at the timestamp specified by `create_time`.
-          # received.
+          # The timestamp indicating the creation of the backup.
           # @return [Time]
           def create_time
             Convert.timestamp_to_time @grpc.create_time
           end
 
+          ##
+          # The backup contains an externally consistent copy of
+          # `source_database` at the timestamp specified by
+          # the `version_time` received. If no `version_time` was
+          # given during the creation of the backup, the `version_time`
+          # will be the same as the `create_time`.
+          # @return [Time]
+          def version_time
+            Convert.timestamp_to_time @grpc.version_time
+          end
+
           ##
           # @private Creates a new Database::BackupInfo instance from a
           # `Google::Cloud::Spanner::Admin::Database::V1::BackupInfo`.

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

@@ -130,12 +130,12 @@ module Google
             #     job.database.database_id
             #   end
             #
-            def all
+            def all &block
               return enum_for :all unless block_given?
 
               results = self
               loop do
-                results.each { |r| yield r }
+                results.each(&block)
                 break unless next?
                 grpc.next_page
                 results = self.class.from_grpc grpc, service

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

@@ -71,7 +71,7 @@ module Google
             return nil unless next?
             ensure_service!
             options = { token: token, max: @max }
-            grpc = @service.list_databases @instance_id, options
+            grpc = @service.list_databases @instance_id, **options
             self.class.from_grpc grpc, @service, @max
           end
 
@@ -123,17 +123,17 @@ module Google
           #     puts database.database_id
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next

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

@@ -133,13 +133,14 @@ module Google
         #
         def types
           @grpc_fields.map(&:type).map do |type|
-            if type.code == :ARRAY
+            case type.code
+            when :ARRAY
               if type.array_element_type.code == :STRUCT
                 [Fields.from_grpc(type.array_element_type.struct_type.fields)]
               else
                 [type.array_element_type.code]
               end
-            elsif type.code == :STRUCT
+            when :STRUCT
               Fields.from_grpc type.struct_type.fields
             else
               type.code

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

@@ -73,7 +73,7 @@ module Google
               return nil unless next?
               ensure_service!
               options = { token: token, max: @max }
-              grpc = @service.list_instance_configs options
+              grpc = @service.list_instance_configs(**options)
               self.class.from_grpc grpc, @service, @max
             end
 
@@ -123,17 +123,17 @@ module Google
             #     puts config.instance_config_id
             #   end
             #
-            def all request_limit: nil
+            def all request_limit: nil, &block
               request_limit = request_limit.to_i if request_limit
               unless block_given?
                 return enum_for :all, request_limit: request_limit
               end
               results = self
               loop do
-                results.each { |r| yield r }
+                results.each(&block)
                 if request_limit
                   request_limit -= 1
-                  break if request_limit < 0
+                  break if request_limit.negative?
                 end
                 break unless results.next?
                 results = results.next

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

@@ -71,7 +71,7 @@ module Google
             return nil unless next?
             ensure_service!
             options = { token: token, max: @max }
-            grpc = @service.list_instances options
+            grpc = @service.list_instances(**options)
             self.class.from_grpc grpc, @service, @max
           end
 
@@ -120,17 +120,17 @@ module Google
           #     puts instance.instance_id
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next

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

@@ -45,11 +45,13 @@ module Google
       #
       class Partition
         # @ private
-        attr_reader :execute, :read
+        attr_reader :execute
+        attr_reader :read
 
         ##
         # @private Creates a Partition object.
-        def initialize; end
+        def initialize
+        end
 
         ##
         # Whether the partition was created for an execute_query/query

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