activerecord-spanner-adapter 1.5.1 → 1.6.0

data/lib/activerecord_spanner_adapter/base.rb

@@ -4,6 +4,7 @@
 # license that can be found in the LICENSE file or at
 # https://opensource.org/licenses/MIT.
 
+require "active_record/gem_version"
 require "activerecord_spanner_adapter/relation"
 
 module ActiveRecord
@@ -14,6 +15,8 @@ module ActiveRecord
   end
 
   class Base
+    VERSION_7_1 = Gem::Version.create "7.1.0"
+
     # Creates an object (or multiple objects) and saves it to the database. This method will use mutations instead
     # of DML if there is no active transaction, or if the active transaction has been created with the option
     # isolation: :buffered_mutations.
@@ -30,7 +33,9 @@ module ActiveRecord
       return super unless spanner_adapter?
       return super if active_transaction?
 
-      transaction isolation: :buffered_mutations do
+      # Only use mutations to create new records if the primary key is generated client-side.
+      isolation = sequence_name ? nil : :buffered_mutations
+      transaction isolation: isolation do
         return super
       end
     end
@@ -43,35 +48,67 @@ module ActiveRecord
       spanner_adapter? && connection&.current_spanner_transaction&.isolation == :buffered_mutations
     end
 
-    def self._insert_record values
+    def self._insert_record values, returning = []
       return super unless buffered_mutations? || (primary_key && values.is_a?(Hash))
 
-      return _buffer_record values, :insert if buffered_mutations?
+      # Mutations cannot be used in combination with a sequence, as mutations do not support a THEN RETURN clause.
+      if buffered_mutations? && sequence_name
+        raise StatementInvalid, "Mutations cannot be used to create records that use a sequence " \
+                                     "to generate the primary key. #{self} uses #{sequence_name}."
+      end
 
-      primary_key_value =
-        if primary_key.is_a? Array
-          _set_composite_primary_key_values primary_key, values
-        else
-          _set_single_primary_key_value primary_key, values
-        end
+      return _buffer_record values, :insert, returning if buffered_mutations?
+
+      primary_key_value = _set_primary_key_value values
       if ActiveRecord::VERSION::MAJOR >= 7
         im = Arel::InsertManager.new arel_table
         im.insert(values.transform_keys { |name| arel_table[name] })
       else
         im = arel_table.compile_insert _substitute_values(values)
       end
-      connection.insert(im, "#{self} Create", primary_key || false, primary_key_value)
+      result = connection.insert(im, "#{self} Create", primary_key || false, primary_key_value)
+
+      _convert_primary_key result, returning
     end
 
-    def self._upsert_record values
-      _buffer_record values, :insert_or_update
+    def self._set_primary_key_value values
+      if primary_key.is_a? Array
+        _set_composite_primary_key_values primary_key, values
+      else
+        _set_single_primary_key_value primary_key, values
+      end
+    end
+
+    def self._convert_primary_key primary_key_value, returning
+      # Rails 7.1 and higher supports composite primary keys, and therefore require the provider to return an array
+      # instead of a single value in all cases. The order of the values should be equal to the order of the returning
+      # columns (or the primary key if no returning columns were specified).
+      return primary_key_value if ActiveRecord.gem_version < VERSION_7_1
+      return primary_key_value if primary_key_value.is_a?(Array) && primary_key_value.length == 1
+      return [primary_key_value] unless primary_key_value.is_a? Array
+
+      # Re-order the returned values according to the returning columns if it is not equal to the primary key of the
+      # table.
+      keys = returning || primary_key
+      return primary_key_value if keys == primary_key
+
+      primary_key_values_hash = Hash[primary_key.zip(primary_key_value)]
+      values = []
+      keys.each do |column|
+        values.append primary_key_values_hash[column]
+      end
+      values
+    end
+
+    def self._upsert_record values, returning
+      _buffer_record values, :insert_or_update, returning
     end
 
     def self.insert_all _attributes, **_kwargs
       raise NotImplementedError, "Cloud Spanner does not support skip_duplicates. Use insert! or upsert instead."
     end
 
-    def self.insert_all! attributes, **_kwargs
+    def self.insert_all! attributes, returning: nil, **_kwargs
       return super unless spanner_adapter?
       return super if active_transaction? && !buffered_mutations?
 
@@ -90,7 +127,7 @@ module ActiveRecord
       end
     end
 
-    def self.upsert_all attributes, **_kwargs
+    def self.upsert_all attributes, returning: nil, unique_by: nil, **_kwargs
       return super unless spanner_adapter?
       if active_transaction? && !buffered_mutations?
         raise NotImplementedError, "Cloud Spanner does not support upsert using DML. " \
@@ -102,18 +139,18 @@ module ActiveRecord
       # The mutations will be sent as one batch when the transaction is committed.
       if active_transaction?
         attributes.each do |record|
-          _upsert_record record
+          _upsert_record record, returning
         end
       else
         transaction isolation: :buffered_mutations do
           attributes.each do |record|
-            _upsert_record record
+            _upsert_record record, returning
           end
         end
       end
     end
 
-    def self._buffer_record values, method
+    def self._buffer_record values, method, returning
       primary_key_value =
         if primary_key.is_a? Array
           _set_composite_primary_key_values primary_key, values
@@ -132,10 +169,9 @@ module ActiveRecord
       mutation = Google::Cloud::Spanner::V1::Mutation.new(
         "#{method}": write
       )
-
       connection.current_spanner_transaction.buffer mutation
 
-      primary_key_value
+      _convert_primary_key primary_key_value, returning
     end
 
     def self._set_composite_primary_key_values primary_key, values
@@ -174,6 +210,7 @@ module ActiveRecord
     def self._set_single_primary_key_value primary_key, values
       primary_key_value = values[primary_key] || values[primary_key.to_sym]
 
+      return primary_key_value if sequence_name
       return primary_key_value unless prefetch_primary_key?
 
       if primary_key_value.nil?

data/lib/activerecord_spanner_adapter/information_schema.rb

@@ -15,6 +15,8 @@ module ActiveRecordSpannerAdapter
   class InformationSchema
     include ActiveRecord::ConnectionAdapters::Quoting
 
+    IsRails71OrLater = ActiveRecord.gem_version >= Gem::Version.create("7.1.0")
+
     attr_reader :connection
 
     def initialize connection
@@ -62,6 +64,7 @@ module ActiveRecordSpannerAdapter
     end
 
     def table_columns table_name, column_name: nil
+      primary_keys = table_primary_keys(table_name).map(&:name)
       sql = +"SELECT COLUMN_NAME, SPANNER_TYPE, IS_NULLABLE, GENERATION_EXPRESSION,"
       sql << " CAST(COLUMN_DEFAULT AS STRING) AS COLUMN_DEFAULT, ORDINAL_POSITION"
       sql << " FROM INFORMATION_SCHEMA.COLUMNS"
@@ -75,34 +78,40 @@ module ActiveRecordSpannerAdapter
         table_name: table_name,
         column_name: column_name
       ).map do |row|
-        type, limit = parse_type_and_limit row["SPANNER_TYPE"]
-        column_name = row["COLUMN_NAME"]
-        options = column_options[column_name]
+        _create_column table_name, row, primary_keys, column_options
+      end
+    end
 
-        default = row["COLUMN_DEFAULT"]
-        default_function = row["GENERATION_EXPRESSION"]
+    def _create_column table_name, row, primary_keys, column_options
+      type, limit = parse_type_and_limit row["SPANNER_TYPE"]
+      column_name = row["COLUMN_NAME"]
+      options = column_options[column_name]
+      primary_key = primary_keys.include? column_name
 
-        if /\w+\(.*\)/.match?(default)
-          default_function ||= default
-          default = nil
-        end
+      default = row["COLUMN_DEFAULT"]
+      default_function = row["GENERATION_EXPRESSION"]
 
-        if default && type == "STRING"
-          default = unquote_string default
-        end
+      if default && default.length < 200 && /\w+\(.*\)/.match?(default)
+        default_function ||= default
+        default = nil
+      end
 
-        Table::Column.new \
-          table_name,
-          column_name,
-          type,
-          limit: limit,
-          allow_commit_timestamp: options["allow_commit_timestamp"],
-          ordinal_position: row["ORDINAL_POSITION"],
-          nullable: row["IS_NULLABLE"] == "YES",
-          default: default,
-          default_function: default_function,
-          generated: row["GENERATION_EXPRESSION"].present?
+      if default && type == "STRING"
+        default = unquote_string default
       end
+
+      Table::Column.new \
+        table_name,
+        column_name,
+        type,
+        limit: limit,
+        allow_commit_timestamp: options["allow_commit_timestamp"],
+        ordinal_position: row["ORDINAL_POSITION"],
+        nullable: row["IS_NULLABLE"] == "YES",
+        default: default,
+        default_function: default_function,
+        generated: row["GENERATION_EXPRESSION"].present?,
+        primary_key: primary_key
     end
 
     def table_column table_name, column_name
@@ -114,7 +123,7 @@ module ActiveRecordSpannerAdapter
     # ActiveRecord. The parent primary key columns are filtered out by default to allow interleaved tables to be
     # considered as tables with a single-column primary key by ActiveRecord. The actual primary key of the table will
     # include both the parent primary key columns and the 'own' primary key columns of a table.
-    def table_primary_keys table_name, include_parent_keys = false
+    def table_primary_keys table_name, include_parent_keys = IsRails71OrLater
       sql = +"WITH TABLE_PK_COLS AS ( "
       sql << "SELECT C.TABLE_NAME, C.COLUMN_NAME, C.INDEX_NAME, C.COLUMN_ORDERING, C.ORDINAL_POSITION "
       sql << "FROM INFORMATION_SCHEMA.INDEX_COLUMNS C "

data/lib/activerecord_spanner_adapter/primary_key.rb

@@ -18,7 +18,7 @@ module ActiveRecord
         end
 
         def fetch_primary_and_parent_key
-          return connection.schema_cache.primary_and_parent_keys table_name \
+          return connection.spanner_schema_cache.primary_and_parent_keys table_name \
             if ActiveRecord::Base != self && table_exists?
         end
 

data/lib/activerecord_spanner_adapter/table/column.rb

@@ -9,8 +9,7 @@ module ActiveRecordSpannerAdapter
     class Column
       attr_accessor :table_name, :name, :type, :limit, :ordinal_position,
                     :allow_commit_timestamp, :default, :default_function, :generated,
-                    :primary_key
-      attr_writer :nullable
+                    :primary_key, :nullable
 
       def initialize \
           table_name,
@@ -22,7 +21,8 @@ module ActiveRecordSpannerAdapter
           allow_commit_timestamp: nil,
           default: nil,
           default_function: nil,
-          generated: nil
+          generated: nil,
+          primary_key: false
         @table_name = table_name.to_s
         @name = name.to_s
         @type = type
@@ -33,12 +33,7 @@ module ActiveRecordSpannerAdapter
         @default = default
         @default_function = default_function
         @generated = generated == true
-        @primary_key = false
-      end
-
-      def nullable
-        return false if primary_key
-        @nullable
+        @primary_key = primary_key
       end
 
       def spanner_type

data/lib/activerecord_spanner_adapter/version.rb

@@ -5,5 +5,5 @@
 # https://opensource.org/licenses/MIT.
 
 module ActiveRecordSpannerAdapter
-  VERSION = "1.5.1".freeze
+  VERSION = "1.6.0".freeze
 end

data/lib/arel/visitors/spanner.rb

@@ -139,7 +139,9 @@ module Arel # :nodoc: all
         # Do not generate a query parameter if the value should be set to the PENDING_COMMIT_TIMESTAMP(), as that is
         # not supported as a parameter value by Cloud Spanner.
         return collector << "PENDING_COMMIT_TIMESTAMP()" \
-          if o.value.type.is_a?(ActiveRecord::Type::Spanner::Time) && o.value.value == :commit_timestamp
+            if o.value.respond_to?(:type) \
+              && o.value.type.is_a?(ActiveRecord::Type::Spanner::Time) \
+              && o.value.value == :commit_timestamp
         collector.add_bind(o.value, &bind_block)
       end
       # rubocop:enable Naming/MethodName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-13 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -33,7 +33,7 @@ dependencies:
         version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
@@ -312,6 +312,7 @@ files:
 - acceptance/models/organization.rb
 - acceptance/models/post.rb
 - acceptance/models/singer.rb
+- acceptance/models/table_with_sequence.rb
 - acceptance/models/track.rb
 - acceptance/models/transaction.rb
 - acceptance/schema/schema.rb
@@ -342,6 +343,15 @@ files:
 - examples/snippets/array-data-type/db/seeds.rb
 - examples/snippets/array-data-type/models/entity_with_array_types.rb
 - examples/snippets/bin/create_emulator_instance.rb
+- examples/snippets/bit-reversed-sequence/README.md
+- examples/snippets/bit-reversed-sequence/Rakefile
+- examples/snippets/bit-reversed-sequence/application.rb
+- examples/snippets/bit-reversed-sequence/config/database.yml
+- examples/snippets/bit-reversed-sequence/db/migrate/01_create_tables.rb
+- examples/snippets/bit-reversed-sequence/db/schema.rb
+- examples/snippets/bit-reversed-sequence/db/seeds.rb
+- examples/snippets/bit-reversed-sequence/models/album.rb
+- examples/snippets/bit-reversed-sequence/models/singer.rb
 - examples/snippets/bulk-insert/README.md
 - examples/snippets/bulk-insert/Rakefile
 - examples/snippets/bulk-insert/application.rb
@@ -395,6 +405,16 @@ files:
 - examples/snippets/hints/db/seeds.rb
 - examples/snippets/hints/models/album.rb
 - examples/snippets/hints/models/singer.rb
+- examples/snippets/interleaved-tables-before-7.1/README.md
+- examples/snippets/interleaved-tables-before-7.1/Rakefile
+- examples/snippets/interleaved-tables-before-7.1/application.rb
+- examples/snippets/interleaved-tables-before-7.1/config/database.yml
+- examples/snippets/interleaved-tables-before-7.1/db/migrate/01_create_tables.rb
+- examples/snippets/interleaved-tables-before-7.1/db/schema.rb
+- examples/snippets/interleaved-tables-before-7.1/db/seeds.rb
+- examples/snippets/interleaved-tables-before-7.1/models/album.rb
+- examples/snippets/interleaved-tables-before-7.1/models/singer.rb
+- examples/snippets/interleaved-tables-before-7.1/models/track.rb
 - examples/snippets/interleaved-tables/README.md
 - examples/snippets/interleaved-tables/Rakefile
 - examples/snippets/interleaved-tables/application.rb
@@ -442,6 +462,15 @@ files:
 - examples/snippets/partitioned-dml/db/seeds.rb
 - examples/snippets/partitioned-dml/models/album.rb
 - examples/snippets/partitioned-dml/models/singer.rb
+- examples/snippets/query-logs/README.md
+- examples/snippets/query-logs/Rakefile
+- examples/snippets/query-logs/application.rb
+- examples/snippets/query-logs/config/database.yml
+- examples/snippets/query-logs/db/migrate/01_create_tables.rb
+- examples/snippets/query-logs/db/schema.rb
+- examples/snippets/query-logs/db/seeds.rb
+- examples/snippets/query-logs/models/album.rb
+- examples/snippets/query-logs/models/singer.rb
 - examples/snippets/quickstart/README.md
 - examples/snippets/quickstart/Rakefile
 - examples/snippets/quickstart/application.rb