google-cloud-spanner 1.16.2 → 2.4.0

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

@@ -96,8 +96,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              insert_or_update: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              insert_or_update: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -154,8 +154,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              insert: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              insert: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -211,8 +211,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              update: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              update: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -270,8 +270,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              replace: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              replace: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -306,8 +306,8 @@ module Google
         #
         def delete table, keys = []
           @mutations += [
-            Google::Spanner::V1::Mutation.new(
-              delete: Google::Spanner::V1::Mutation::Delete.new(
+            V1::Mutation.new(
+              delete: V1::Mutation::Delete.new(
                 table: table, key_set: key_set(keys)
               )
             )
@@ -323,20 +323,20 @@ module Google
         protected
 
         def key_set keys
-          return Google::Spanner::V1::KeySet.new all: true if keys.nil?
+          return V1::KeySet.new all: true if keys.nil?
           keys = [keys] unless keys.is_a? Array
-          return Google::Spanner::V1::KeySet.new all: true if keys.empty?
+          return V1::KeySet.new all: true if keys.empty?
           if keys_are_ranges? keys
             key_ranges = keys.map do |r|
               Convert.to_key_range r
             end
-            return Google::Spanner::V1::KeySet.new ranges: key_ranges
+            return V1::KeySet.new ranges: key_ranges
           end
           key_list = keys.map do |key|
             key = [key] unless key.is_a? Array
             Convert.object_to_grpc_value(key).list_value
           end
-          Google::Spanner::V1::KeySet.new keys: key_list
+          V1::KeySet.new keys: key_list
         end
 
         def keys_are_ranges? keys

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
@@ -169,12 +176,12 @@ module Google
             return field.to_grpc_type if field.respond_to? :to_grpc_type
 
             if Array === field
-              Google::Spanner::V1::Type.new(
+              V1::Type.new(
                 code: :ARRAY,
                 array_element_type: grpc_type_for_field(field.first)
               )
             else
-              Google::Spanner::V1::Type.new(code: field)
+              V1::Type.new(code: field)
             end
           end
 
@@ -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
 
@@ -274,24 +283,24 @@ module Google
               range_opts.delete :end_closed
             end
 
-            Google::Spanner::V1::KeyRange.new range_opts
+            V1::KeyRange.new range_opts
           end
 
           def to_key_set keys
-            return Google::Spanner::V1::KeySet.new(all: true) if keys.nil?
+            return V1::KeySet.new(all: true) if keys.nil?
             keys = [keys] unless keys.is_a? Array
-            return Google::Spanner::V1::KeySet.new(all: true) if keys.empty?
+            return V1::KeySet.new(all: true) if keys.empty?
 
             if keys_are_ranges? keys
               key_ranges = keys.map { |r| to_key_range(r) }
-              return Google::Spanner::V1::KeySet.new(ranges: key_ranges)
+              return V1::KeySet.new(ranges: key_ranges)
             end
 
             key_list = keys.map do |key|
               key = [key] unless key.is_a? Array
               object_to_grpc_value(key).list_value
             end
-            Google::Spanner::V1::KeySet.new keys: key_list
+            V1::KeySet.new keys: key_list
           end
 
           def keys_are_ranges? keys

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/spanner/v1/credentials"
+require "google/cloud/spanner/v1/spanner/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   spanner.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Spanner::V1::Credentials
+      class Credentials < Google::Cloud::Spanner::V1::Spanner::Credentials
       end
     end
   end

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

@@ -216,9 +216,9 @@ module Google
         ##
         # @private
         def to_grpc_type
-          Google::Spanner::V1::Type.new(
+          V1::Type.new(
             code: :STRUCT,
-            struct_type: Google::Spanner::V1::StructType.new(
+            struct_type: V1::StructType.new(
               fields: @grpc_fields
             )
           )

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>`.
@@ -229,7 +241,6 @@ module Google
           true
         end
 
-
         # @private
         DATBASE_OPERATION_METADAT_FILTER_TEMPLATE = [
           "(metadata.@type:CreateDatabaseMetadata AND " \
@@ -248,10 +259,10 @@ module Google
         #   response.
         #
         #   The response returns a list of
-        #   {Google::Longrunning::Operation long-running operations} whose names
+        #   `Google::Longrunning::Operation` long-running operations whose names
         #   are prefixed by a database name within the specified instance.
         #   The long-running operation
-        #   {Google::Longrunning::Operation#metadata metadata} field type
+        #   `Google::Longrunning::Operation#metadata` metadata field type
         #   `metadata.type_url` describes the type of the metadata.
         #
         #   The filter expression must specify the field name,
@@ -384,10 +395,9 @@ module Google
             )
           end
 
-          grpc = service.list_database_operations \
-            instance_id,
-            filter: database_filter,
-            page_size: page_size
+          grpc = service.list_database_operations instance_id,
+                                                  filter: database_filter,
+                                                  page_size: page_size
           Database::Job::List.from_grpc grpc, service
         end
 
@@ -402,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.
@@ -412,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
@@ -424,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
 
@@ -573,20 +593,22 @@ module Google
         #
         #   The permissions that can be checked on a database are:
         #
-        #   * pubsub.databases.create
-        #   * pubsub.databases.list
-        #   * pubsub.databases.update
-        #   * pubsub.databases.updateDdl
-        #   * pubsub.databases.get
-        #   * pubsub.databases.getDdl
-        #   * pubsub.databases.getIamPolicy
-        #   * pubsub.databases.setIamPolicy
-        #   * pubsub.databases.beginReadOnlyTransaction
-        #   * pubsub.databases.beginOrRollbackReadWriteTransaction
-        #   * pubsub.databases.read
-        #   * pubsub.databases.select
-        #   * pubsub.databases.write
-        #   * pubsub.databases.drop
+        #  * spanner.databases.beginPartitionedDmlTransaction
+        #  * spanner.databases.create
+        #  * spanner.databases.createBackup
+        #  * spanner.databases.list
+        #  * spanner.databases.update
+        #  * spanner.databases.updateDdl
+        #  * spanner.databases.get
+        #  * spanner.databases.getDdl
+        #  * spanner.databases.getIamPolicy
+        #  * spanner.databases.setIamPolicy
+        #  * spanner.databases.beginReadOnlyTransaction
+        #  * spanner.databases.beginOrRollbackReadWriteTransaction
+        #  * spanner.databases.read
+        #  * spanner.databases.select
+        #  * spanner.databases.write
+        #  * spanner.databases.drop
         #
         # @return [Array<Strings>] The permissions that have access.
         #
@@ -611,7 +633,7 @@ module Google
 
         ##
         # @private Creates a new Database instance from a
-        # Google::Spanner::Admin::Database::V1::Database.
+        # `Google::Cloud::Spanner::Admin::Database::V1::Database`.
         def self.from_grpc grpc, service
           new grpc, service
         end