google-cloud-spanner 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed2386d9ad779724db65c4f41c42e78271e5cd94fe6785bb576083057b8cfae
-  data.tar.gz: 19a748cfaf89324614928996273a424aa0416d3804c60aa86eb6404736f2c30e
+  metadata.gz: 1e9faf33e2e5945db9c82ec262ec12b68c703cdfa42413d1c2da9605bcacca88
+  data.tar.gz: dabf39029f6106cc4f3a6d126e32a46e77cf06120f41a4ecf7c0ab4460cfb6c5
 SHA512:
-  metadata.gz: bd287ff170bdd0c48aad7407b8a7cf92af5e0cc1479396a477c579e01d15de61c5f8d1e935fd54bff9ed035f35f66788aaec17b26a96695374d203644702fa88
-  data.tar.gz: 4fe37f4d9e0b166a941fb631704e43e54a698e1eba6b74d7c16b2afc7fc6dc9e5b39e947e3f3a99d2035302f8eb2949913fca2e35fb922942f2f74599c125ecf
+  metadata.gz: a0e446f217517f5feeb2f342694d57a83981e782a6d2586ba4182b18d06c536aa24c2a2527a064d76af5e317d57ce313b6ad689422a92f2a138ade9410ef5571
+  data.tar.gz: a3ee7508a48f04a77e4b42ee809a6bdcd3134e7b25fb27349283e27e61754ae34d05d7c9a98b0fc6c66bed1deda69dd828e0fd4626c120ba9d95500b145cd1cf

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

@@ -21,6 +21,7 @@ require "google/cloud/spanner/session"
 require "google/cloud/spanner/transaction"
 require "google/cloud/spanner/snapshot"
 require "google/cloud/spanner/range"
+require "google/cloud/spanner/column_value"
 require "google/cloud/spanner/convert"
 
 module Google
@@ -936,6 +937,35 @@ module Google
                     exclude_end: exclude_end
         end
 
+        ##
+        # Creates a column value object representing setting a field's value to
+        # the timestamp of the commit. (See {ColumnValue.commit_timestamp})
+        #
+        # This placeholder value can only be used for timestamp columns that
+        # have set the option "(allow_commit_timestamp=true)" in the schema.
+        #
+        # @return [ColumnValue] The commit timestamp column value object.
+        #
+        # @example
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   # create column value object
+        #   commit_timestamp = db.commit_timestamp
+        #
+        #   db.commit do |c|
+        #     c.insert "users", [
+        #       { id: 5, name: "Murphy", updated_at: commit_timestamp }
+        #     ]
+        #   end
+        #
+        def commit_timestamp
+          ColumnValue.commit_timestamp
+        end
+
         ##
         # Closes the client connection and releases resources.
         #

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

@@ -0,0 +1,115 @@
+# Copyright 2018 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.
+
+
+module Google
+  module Cloud
+    module Spanner
+      ##
+      # # ColumnValue
+      #
+      # Represents a change to be made to a row's column value by the Spanner
+      # API.
+      #
+      # @example
+      #   require "google/cloud/spanner"
+      #
+      #   spanner = Google::Cloud::Spanner.new
+      #
+      #   db = spanner.client "my-instance", "my-database"
+      #
+      #   # create column value object
+      #   commit_timestamp = db.commit_timestamp
+      #
+      #   db.commit do |c|
+      #     c.insert "users", [
+      #       { id: 5, name: "Murphy", updated_at: commit_timestamp }
+      #     ]
+      #   end
+      #
+      class ColumnValue
+        ##
+        # @private Creates a column value object representing changes made to
+        # fields in document data.
+        def initialize type
+          @type = type
+        end
+
+        ##
+        # @private
+        # The type of change to make to a row's column value.
+        #
+        # @return [Symbol] The type of the column value.
+        #
+        # @example
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   # create column value object
+        #   commit_timestamp = db.commit_timestamp
+        #
+        #   db.commit do |c|
+        #     c.insert "users", [
+        #       { id: 5, name: "Murphy", updated_at: commit_timestamp }
+        #     ]
+        #   end
+        #
+        def type
+          @type
+        end
+
+        ##
+        # Creates a column value object representing setting a field's value to
+        # the timestamp of the commit. (See {Client#commit_timestamp} and
+        # {Transaction#commit_timestamp})
+        #
+        # This placeholder value can only be used for timestamp columns that
+        # have set the option "(allow_commit_timestamp=true)" in the schema.
+        #
+        # @return [ColumnValue] The commit timestamp column value object.
+        #
+        # @example
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   # create column value object
+        #   commit_timestamp = \
+        #     Google::Cloud::Spanner::ColumnValue.commit_timestamp
+        #
+        #   db.commit do |c|
+        #     c.insert "users", [
+        #       { id: 5, name: "Murphy", updated_at: commit_timestamp }
+        #     ]
+        #   end
+        #
+        def self.commit_timestamp
+          new :commit_timestamp
+        end
+
+        ##
+        # @private The actual value that is sent to Spanner for the field.
+        def to_column_value
+          # We only have one ColumnValue, so hard-code this for now.
+          "spanner.commit_timestamp()"
+        end
+      end
+    end
+  end
+end

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

@@ -37,6 +37,7 @@ module Google
           end
 
           def raw_to_value_and_type obj, type = nil
+            obj = obj.to_column_value if obj.respond_to? :to_column_value
             if NilClass === obj
               if type
                 if type.is_a?(Array) && type.count == 1
@@ -115,6 +116,8 @@ module Google
           end
 
           def raw_to_value obj
+            obj = obj.to_column_value if obj.respond_to? :to_column_value
+
             if NilClass === obj
               Google::Protobuf::Value.new null_value: :NULL_VALUE
             elsif String === obj

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

@@ -503,6 +503,32 @@ module Google
                     exclude_end: exclude_end
         end
 
+        ##
+        # Creates a column value object representing setting a field's value to
+        # the timestamp of the commit. (See {Client#commit_timestamp})
+        #
+        # This placeholder value can only be used for timestamp columns that
+        # have set the option "(allow_commit_timestamp=true)" in the schema.
+        #
+        # @return [ColumnValue] The commit timestamp column value object.
+        #
+        # @example
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   db.transaction do |tx|
+        #     tx.insert "users", [
+        #       { id: 5, name: "Murphy", updated_at: tx.commit_timestamp }
+        #     ]
+        #   end
+        #
+        def commit_timestamp
+          ColumnValue.commit_timestamp
+        end
+
         ##
         # @private
         # Keeps the transaction current by creating a new transaction.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "1.3.1".freeze
+      VERSION = "1.4.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -228,6 +228,7 @@ files:
 - lib/google/cloud/spanner/batch_client.rb
 - lib/google/cloud/spanner/batch_snapshot.rb
 - lib/google/cloud/spanner/client.rb
+- lib/google/cloud/spanner/column_value.rb
 - lib/google/cloud/spanner/commit.rb
 - lib/google/cloud/spanner/convert.rb
 - lib/google/cloud/spanner/credentials.rb