activerecord-spanner-adapter 2.0.0 → 2.2.0

data/lib/active_record/connection_adapters/spanner_adapter.rb

@@ -71,6 +71,9 @@ module ActiveRecord
       # Determines whether or not to log query binds when executing statements
       class_attribute :log_statement_binds, instance_writer: false, default: false
 
+      attr_accessor :default_sequence_kind
+      attr_accessor :use_client_side_id_for_mutations
+
       def initialize config_or_deprecated_connection, deprecated_logger = nil,
                      deprecated_connection_options = nil, deprecated_config = nil
         if config_or_deprecated_connection.is_a? Hash
@@ -86,6 +89,25 @@ module ActiveRecord
         end
         # Spanner does not support unprepared statements
         @prepared_statements = true
+        # The default for default_sequence_kind will be changed to BIT_REVERSED_POSITIVE
+        # in the next major version. The default value is currently DISABLED to prevent
+        # breaking changes to existing code.
+        @default_sequence_kind = @config.fetch :default_sequence_kind, "DISABLED"
+        @use_auto_increment = @default_sequence_kind&.casecmp? "AUTO_INCREMENT"
+        @auto_increment_disabled = @default_sequence_kind&.casecmp? "DISABLED"
+        @use_client_side_id_for_mutations = self.class.type_cast_config_to_boolean(
+          @config.fetch(:use_client_side_id_for_mutations, false)
+        )
+      end
+
+      def use_auto_increment?
+        "AUTO_INCREMENT".casecmp?(@default_sequence_kind || "")
+      end
+
+      def use_identity?
+        !use_auto_increment? \
+        && @default_sequence_kind \
+        && !@default_sequence_kind.casecmp?("DISABLED")
       end
 
       def max_identifier_length
@@ -128,7 +150,8 @@ module ActiveRecord
       end
 
       # Spanner Connection API
-      delegate :ddl_batch, :ddl_batch?, :start_batch_ddl, :abort_batch, :run_batch, to: :@connection
+      delegate :ddl_batch, :ddl_batch?, :start_batch_ddl, :abort_batch, :run_batch,
+               :isolation_level, :isolation_level=, to: :@connection
 
       def current_spanner_transaction
         @connection.current_transaction
@@ -148,6 +171,10 @@ module ActiveRecord
         false
       end
 
+      def supports_transaction_isolation?
+        true
+      end
+
       def supports_foreign_keys?
         true
       end

data/lib/activerecord_spanner_adapter/base.rb

@@ -35,7 +35,7 @@ module ActiveRecord
       return super if active_transaction?
 
       # Only use mutations to create new records if the primary key is generated client-side.
-      isolation = sequence_name ? nil : :buffered_mutations
+      isolation = has_auto_generated_primary_key? ? nil : :buffered_mutations
       transaction isolation: isolation do
         return super
       end
@@ -53,6 +53,21 @@ module ActiveRecord
       !(buffered_mutations? || (primary_key && values.is_a?(Hash))) || !spanner_adapter?
     end
 
+    def self.has_auto_generated_primary_key?
+      return true if sequence_name
+      pk = primary_key
+      if pk.is_a? Array
+        return pk.any? do |col|
+          columns_hash[col].auto_incremented_by_db?
+        end
+      end
+      columns_hash[pk].auto_incremented_by_db?
+    end
+
+    def self.is_auto_generated? col
+      columns_hash[col]&.auto_incremented_by_db?
+    end
+
     def self._internal_insert_record values
       if ActiveRecord.gem_version < VERSION_7_2
         _insert_record values
@@ -73,10 +88,13 @@ module ActiveRecord
         return super
       end
 
-      # 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}."
+      # Mutations cannot be used in combination with an auto-generated primary key,
+      # as mutations do not support a THEN RETURN clause.
+      if buffered_mutations? \
+        && has_auto_generated_primary_key? \
+        && !_has_all_primary_key_values?(primary_key, values) \
+        && !connection.use_client_side_id_for_mutations
+        raise StatementInvalid, "Mutations cannot be used to create records that use an auto-generated primary key."
       end
 
       return _buffer_record values, :insert, returning if buffered_mutations?
@@ -85,7 +103,7 @@ module ActiveRecord
     end
 
     def self._insert_record_dml values, returning
-      primary_key_value = _set_primary_key_value values
+      primary_key_value = _set_primary_key_value values, false
       if ActiveRecord::VERSION::MAJOR >= 7
         im = Arel::InsertManager.new arel_table
         im.insert(values.transform_keys { |name| arel_table[name] })
@@ -97,11 +115,11 @@ module ActiveRecord
       _convert_primary_key result, returning
     end
 
-    def self._set_primary_key_value values
+    def self._set_primary_key_value values, is_mutation
       if primary_key.is_a? Array
-        _set_composite_primary_key_values primary_key, values
+        _set_composite_primary_key_values primary_key, values, is_mutation
       else
-        _set_single_primary_key_value primary_key, values
+        _set_single_primary_key_value primary_key, values, is_mutation
       end
     end
 
@@ -192,9 +210,9 @@ module ActiveRecord
     def self._buffer_record values, method, returning
       primary_key_value =
         if primary_key.is_a? Array
-          _set_composite_primary_key_values primary_key, values
+          _set_composite_primary_key_values primary_key, values, true
         else
-          _set_single_primary_key_value primary_key, values
+          _set_single_primary_key_value primary_key, values, true
         end
 
       metadata = TableMetadata.new self, arel_table
@@ -213,13 +231,25 @@ module ActiveRecord
       _convert_primary_key primary_key_value, returning
     end
 
-    def self._set_composite_primary_key_values primary_key, values
+    def self._has_all_primary_key_values? primary_key, values
+      if primary_key.is_a? Array
+        all = TrueClass
+        primary_key.each do |key|
+          all &&= values.key? key
+        end
+        all
+      else
+        values.key? primary_key
+      end
+    end
+
+    def self._set_composite_primary_key_values primary_key, values, is_mutation
       primary_key.map do |col|
-        _set_composite_primary_key_value col, values
+        _set_composite_primary_key_value col, values, is_mutation
       end
     end
 
-    def self._set_composite_primary_key_value primary_key, values
+    def self._set_composite_primary_key_value primary_key, values, is_mutation
       value = values[primary_key]
       type = ActiveModel::Type::BigInteger.new
 
@@ -228,6 +258,8 @@ module ActiveRecord
         value = value.value
       end
 
+      return value if is_auto_generated?(primary_key) \
+        && !(is_mutation && connection.use_client_side_id_for_mutations)
       return value unless prefetch_primary_key?
 
       if value.nil?
@@ -244,10 +276,11 @@ module ActiveRecord
       value
     end
 
-    def self._set_single_primary_key_value primary_key, values
+    def self._set_single_primary_key_value primary_key, values, is_mutation
       primary_key_value = values[primary_key] || values[primary_key.to_sym]
 
-      return primary_key_value if sequence_name
+      return primary_key_value if has_auto_generated_primary_key? \
+        && !(is_mutation && connection.use_client_side_id_for_mutations)
       return primary_key_value unless prefetch_primary_key?
 
       if primary_key_value.nil?

data/lib/activerecord_spanner_adapter/connection.rb

@@ -14,10 +14,12 @@ module ActiveRecordSpannerAdapter
     attr_reader :database_id
     attr_reader :spanner
     attr_accessor :current_transaction
+    attr_accessor :isolation_level
 
     def initialize config
       @instance_id = config[:instance]
       @database_id = config[:database]
+      @isolation_level = config[:isolation_level]
       @spanner = self.class.spanners config
     end
 
@@ -42,6 +44,9 @@ module ActiveRecordSpannerAdapter
     # Call this method if you drop and recreate a database with the same name
     # to prevent the cached information to be used for the new database.
     def self.reset_information_schemas!
+      @information_schemas.each_value do |info_schema|
+        info_schema.connection.disconnect!
+      end
       @information_schemas = {}
     end
 
@@ -271,7 +276,7 @@ module ActiveRecordSpannerAdapter
 
     def begin_transaction isolation = nil
       raise "Nested transactions are not allowed" if current_transaction&.active?
-      self.current_transaction = Transaction.new self, isolation
+      self.current_transaction = Transaction.new self, isolation || @isolation_level
       current_transaction.begin
       current_transaction
     end

data/lib/activerecord_spanner_adapter/information_schema.rb

@@ -66,7 +66,8 @@ module ActiveRecordSpannerAdapter
     def table_columns table_name, column_name: nil, schema_name: ""
       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 << " CAST(COLUMN_DEFAULT AS STRING) AS COLUMN_DEFAULT, ORDINAL_POSITION,"
+      sql << " IS_IDENTITY"
       sql << " FROM INFORMATION_SCHEMA.COLUMNS"
       sql << " WHERE TABLE_NAME=%<table_name>s"
       sql << " AND TABLE_SCHEMA=%<schema_name>s"
@@ -114,7 +115,8 @@ module ActiveRecordSpannerAdapter
         default: default,
         default_function: default_function,
         generated: row["GENERATION_EXPRESSION"].present?,
-        primary_key: primary_key
+        primary_key: primary_key,
+        is_identity: row["IS_IDENTITY"] == "YES"
     end
 
     def table_column table_name, column_name, schema_name: ""

data/lib/activerecord_spanner_adapter/table/column.rb

@@ -19,6 +19,7 @@ module ActiveRecordSpannerAdapter
       attr_accessor :generated
       attr_accessor :primary_key
       attr_accessor :nullable
+      attr_accessor :is_identity
 
       def initialize \
           table_name,
@@ -32,7 +33,8 @@ module ActiveRecordSpannerAdapter
           default: nil,
           default_function: nil,
           generated: nil,
-          primary_key: false
+          primary_key: false,
+          is_identity: false
         @schema_name = schema_name.to_s
         @table_name = table_name.to_s
         @name = name.to_s
@@ -45,6 +47,7 @@ module ActiveRecordSpannerAdapter
         @default_function = default_function
         @generated = generated == true
         @primary_key = primary_key
+        @is_identity = is_identity
       end
 
       def spanner_type

data/lib/activerecord_spanner_adapter/transaction.rb

@@ -55,11 +55,12 @@ module ActiveRecordSpannerAdapter
         when :pdml
           @grpc_transaction = @connection.session.create_pdml
         else
+          grpc_isolation = _transaction_isolation_level_to_grpc @isolation
           @begin_transaction_selector = Google::Cloud::Spanner::V1::TransactionSelector.new \
             begin: Google::Cloud::Spanner::V1::TransactionOptions.new(
-              read_write: Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite.new
+              read_write: Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite.new,
+              isolation_level: grpc_isolation
             )
-
         end
         @state = :STARTED
       rescue Google::Cloud::NotFoundError => e
@@ -75,6 +76,15 @@ module ActiveRecordSpannerAdapter
       end
     end
 
+    def _transaction_isolation_level_to_grpc isolation
+      case isolation
+      when :serializable
+        Google::Cloud::Spanner::V1::TransactionOptions::IsolationLevel::SERIALIZABLE
+      when :repeatable_read
+        Google::Cloud::Spanner::V1::TransactionOptions::IsolationLevel::REPEATABLE_READ
+      end
+    end
+
     # Forces a BeginTransaction RPC for a read/write transaction. This is used by a
     # connection if the first statement of a transaction failed.
     def force_begin_read_write

data/lib/activerecord_spanner_adapter/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Google LLC
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -15,35 +15,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.25'
 - !ruby/object:Gem::Dependency
-  name: grpc
+  name: google-cloud-spanner-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.3
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.3
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -53,7 +53,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -357,6 +357,14 @@ files:
 - examples/snippets/array-data-type/db/migrate/01_create_tables.rb
 - examples/snippets/array-data-type/db/seeds.rb
 - examples/snippets/array-data-type/models/entity_with_array_types.rb
+- examples/snippets/auto-generated-primary-key/README.md
+- examples/snippets/auto-generated-primary-key/Rakefile
+- examples/snippets/auto-generated-primary-key/application.rb
+- examples/snippets/auto-generated-primary-key/config/database.yml
+- examples/snippets/auto-generated-primary-key/db/migrate/01_create_tables.rb
+- examples/snippets/auto-generated-primary-key/db/seeds.rb
+- examples/snippets/auto-generated-primary-key/models/album.rb
+- examples/snippets/auto-generated-primary-key/models/singer.rb
 - examples/snippets/bin/create_emulator_instance.rb
 - examples/snippets/bit-reversed-sequence/README.md
 - examples/snippets/bit-reversed-sequence/Rakefile
@@ -431,6 +439,14 @@ files:
 - examples/snippets/interleaved-tables/models/album.rb
 - examples/snippets/interleaved-tables/models/singer.rb
 - examples/snippets/interleaved-tables/models/track.rb
+- examples/snippets/isolation-level/README.md
+- examples/snippets/isolation-level/Rakefile
+- examples/snippets/isolation-level/application.rb
+- examples/snippets/isolation-level/config/database.yml
+- examples/snippets/isolation-level/db/migrate/01_create_tables.rb
+- examples/snippets/isolation-level/db/seeds.rb
+- examples/snippets/isolation-level/models/album.rb
+- examples/snippets/isolation-level/models/singer.rb
 - examples/snippets/migrations/README.md
 - examples/snippets/migrations/Rakefile
 - examples/snippets/migrations/application.rb
@@ -571,7 +587,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Rails ActiveRecord connector for Google Spanner Database
 test_files: []