activerecord-spanner-adapter 2.0.0 → 2.1.0

data/examples/snippets/auto-generated-primary-key/README.md

@@ -0,0 +1,140 @@
+# Sample - Auto-generated Primary Keys
+
+This example shows how to use an IDENTITY column to generate the primary key of a model.
+
+See https://cloud.google.com/spanner/docs/primary-key-default-value#identity-columns for more information
+about IDENTITY columns in Cloud Spanner.
+
+## Requirements
+Using IDENTITY for generating primary key values in ActiveRecord has the following requirements:
+1. You must use __ActiveRecord version 7.1 or higher__.
+2. Your database configuration must include a `default_sequence_kind` value like this:
+
+```yaml
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  default_sequence_kind: BIT_REVERSED_POSITIVE
+  pool: 5
+  timeout: 5000
+  schema_dump: false
+```
+
+## Creating Tables with IDENTITY in ActiveRecord
+You can create an IDENTITY column using migrations in ActiveRecord by using the `:primary_key` type
+for the column. Note that this only generates an IDENTITY column if you have included the option
+`default_sequence_kind: BIT_REVERSED_POSITIVE` as shown above.
+
+Any default `id` column that is added by ActiveRecord will also use the `:primary_key` type and use
+an IDENTITY column.
+
+```ruby
+# The default `id` column that is added by ActiveRecord will automatically use
+# an IDENTITY column.
+create_table :singers do |t|
+  t.string :first_name
+  t.string :last_name
+end
+
+# You can also explicitly create a primary key column with a different name. Use
+# the :primary_key type to generate an IDENTITY column.
+create_table :singers, id: false, primary_key: :singerid do |t|
+  # Use the ':primary_key' data type to create an auto-generated primary key column.
+  t.column :singerid, :primary_key, primary_key: true, null: false
+  t.string :first_name
+  t.string :last_name
+end
+```
+
+## Example Data Model
+This example uses the following table schema:
+
+```sql
+CREATE TABLE `singers` (
+    `singerid` INT64 NOT NULL GENERATED BY DEFAULT AS IDENTITY (BIT_REVERSED_POSITIVE),
+    `first_name` STRING(MAX),
+    `last_name` STRING(MAX)
+) PRIMARY KEY (`singerid`)
+
+CREATE TABLE `albums` (
+    `singerid` INT64 NOT NULL,
+    `albumid` INT64 NOT NULL GENERATED BY DEFAULT AS IDENTITY (BIT_REVERSED_POSITIVE),
+    `title` STRING(MAX)
+) PRIMARY KEY (`singerid`, `albumid`), INTERLEAVE IN PARENT `singers`
+```
+
+This schema can be created in ActiveRecord 7.1 and later as follows:
+
+```ruby
+# Execute the entire migration as one DDL batch.
+connection.ddl_batch do
+  create_table :singers, id: false, primary_key: :singerid do |t|
+    # Use the ':primary_key' data type to create an auto-generated primary key column.
+    t.column :singerid, :primary_key, primary_key: true, null: false
+    t.string :first_name
+    t.string :last_name
+  end
+
+  create_table :albums, primary_key: [:singerid, :albumid], id: false do |t|
+    # Interleave the `albums` table in the parent table `singers`.
+    t.interleave_in :singers
+    t.integer :singerid, null: false
+    # Use the ':primary_key' data type to create an auto-generated primary key column.
+    t.column :albumid, :primary_key, null: false
+    t.string :title
+  end
+end
+```
+
+## Auto-generated Primary Keys and Mutations
+
+Using primary keys that are auto-generated by an IDENTITY column is not
+supported in combination with mutations, because Spanner must return the
+generated primary key value after a row was inserted using a `THEN RETURN`
+clause. This is not supported for mutations.
+
+A workaround for this is to explicitly set a value for the primary key of
+a row before inserting it:
+
+```ruby
+ActiveRecord::Base.transaction isolation: :buffered_mutations do
+  # Assign the singer a random id value. This value will be included in the insert mutation.
+  singer = Singer.create id: SecureRandom.uuid.gsub("-", "").hex & 0x7FFFFFFFFFFFFFFF,
+                         first_name: "Melissa", last_name: "Garcia"
+end
+```
+
+You can also instruct the Spanner ActiveRecord provider to automatically include a
+primary key value when you use mutations. The primary key value assignment can then
+be omitted from your code. Add `use_client_side_id_for_mutations: true` to your
+configuration for this:
+
+```yaml
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  default_sequence_kind: BIT_REVERSED_POSITIVE
+  use_client_side_id_for_mutations: true
+  pool: 5
+  timeout: 5000
+  schema_dump: false
+```
+
+## Running the Sample
+
+The sample will automatically start a Spanner Emulator in a docker container and execute the sample
+against that emulator. The emulator will automatically be stopped when the application finishes.
+
+Run the application with the following commands:
+
+```bash
+export AR_VERSION="~> 7.1.2"
+bundle install
+bundle exec rake run
+```

data/examples/snippets/auto-generated-primary-key/Rakefile

@@ -0,0 +1,13 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../config/environment"
+require "sinatra/activerecord/rake"
+
+desc "Sample showing how to work with auto-generated-primary keys."
+task :run do
+  Dir.chdir("..") { sh "bundle exec rake run[auto-generated-primary-key]" }
+end

data/examples/snippets/auto-generated-primary-key/application.rb

@@ -0,0 +1,86 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require "io/console"
+require_relative "../config/environment"
+require_relative "models/singer"
+require_relative "models/album"
+
+class Application
+  def self.run
+    # Create a new singer.
+    singer = create_new_singer
+
+    # Create a new album.
+    album = create_new_album singer
+
+    # Verify that the album exists.
+    find_album singer.singerid, album.albumid
+
+    # List all singers, albums and tracks.
+    list_singers_albums
+
+    # Create a new singer using mutations.
+    # This requires us to set a primary key value manually.
+    # You can also instruct the Spanner Ruby ActiveRecord provider to that automatically
+    # by including this in your database configuration:
+    #   use_client_side_id_for_mutations: true
+    create_new_singer_using_mutations
+  end
+
+  def self.find_album singerid, albumid
+    album = Album.find [singerid, albumid]
+    puts "Found album: #{album.title}"
+  end
+
+  def self.list_singers_albums
+    puts ""
+    puts "Listing all singers with corresponding albums"
+    Singer.all.order("last_name, first_name").each do |singer|
+      puts "#{singer.first_name} #{singer.last_name} has #{singer.albums.count} albums:"
+      singer.albums.order("title").each do |album|
+        puts "  #{album.title}"
+      end
+    end
+  end
+
+  def self.create_new_singer
+    # Create a new singer. The singerid is generated by an IDENTITY column in the database and returned.
+    puts ""
+    singer = Singer.create first_name: "Melissa", last_name: "Garcia"
+    puts "Created a new singer '#{singer.first_name} #{singer.last_name}' with id #{singer.singerid}"
+
+    singer
+  end
+
+  def self.create_new_album singer
+    # Create a new album.
+    puts ""
+    puts "Creating a new album for #{singer.first_name} #{singer.last_name}"
+    # The albumid is not generated by the database.
+    album = singer.albums.build albumid: 1, title: "New Title"
+    album.save!
+
+    album
+  end
+
+  def self.create_new_singer_using_mutations
+    # Create a new singer using mutations. Mutations do not support THEN RETURN clauses,
+    # so we must specify a value for the primary key before inserting the row.
+    puts ""
+    singer = nil
+    ActiveRecord::Base.transaction isolation: :buffered_mutations do
+      # Assign the singer a random id value. This value will be included in the insert mutation.
+      singer = Singer.create id: SecureRandom.uuid.gsub("-", "").hex & 0x7FFFFFFFFFFFFFFF,
+                             first_name: "Melissa", last_name: "Garcia"
+    end
+    puts "Inserted a new singer '#{singer.first_name} #{singer.last_name}' using mutations with id #{singer.singerid}"
+
+    singer
+  end
+end
+
+Application.run

data/examples/snippets/auto-generated-primary-key/config/database.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: spanner
+  emulator_host: localhost:9010
+  project: test-project
+  instance: test-instance
+  database: testdb
+  default_sequence_kind: BIT_REVERSED_POSITIVE
+  pool: 5
+  timeout: 5000
+  schema_dump: false

data/examples/snippets/auto-generated-primary-key/db/migrate/01_create_tables.rb

@@ -0,0 +1,29 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class CreateTables < ActiveRecord::Migration[7.1]
+  def change
+    connection.default_sequence_kind = "BIT_REVERSED_POSITIVE"
+    # Execute the entire migration as one DDL batch.
+    connection.ddl_batch do
+      create_table :singers, id: false, primary_key: :singerid do |t|
+        # Use the ':primary_key' data type to create an auto-generated primary key column.
+        t.column :singerid, :primary_key, primary_key: true, null: false
+        t.string :first_name
+        t.string :last_name
+      end
+
+      create_table :albums, primary_key: [:singerid, :albumid], id: false do |t|
+        # Interleave the `albums` table in the parent table `singers`.
+        t.interleave_in :singers
+        t.integer :singerid, null: false
+        # Use the ':primary_key' data type to create an auto-generated primary key column.
+        t.column :albumid, :primary_key, null: false
+        t.string :title
+      end
+    end
+  end
+end

data/examples/snippets/auto-generated-primary-key/db/seeds.rb

@@ -0,0 +1,31 @@
+# Copyright 2023 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+require_relative "../../config/environment"
+require_relative "../models/singer"
+require_relative "../models/album"
+
+first_names = %w[Pete Alice John Ethel Trudy Naomi Wendy Ruben Thomas Elly]
+last_names = %w[Wendelson Allison Peterson Johnson Henderson Ericsson Aronson Tennet Courtou]
+
+adjectives = %w[daily happy blue generous cooked bad open]
+nouns = %w[windows potatoes bank street tree glass bottle]
+
+# NOTE: We do not use mutations to insert these rows, because letting the database generate the primary key means that
+# we rely on a `THEN RETURN id` clause in the insert statement. This is only supported for DML statements, and not for
+# mutations.
+ActiveRecord::Base.transaction do
+  singers = []
+  5.times do
+    singers << Singer.create(first_name: first_names.sample, last_name: last_names.sample)
+  end
+
+  albums = []
+  20.times do
+    singer = singers.sample
+    albums << Album.create(title: "#{adjectives.sample} #{nouns.sample}", singer: singer)
+  end
+end

data/examples/snippets/auto-generated-primary-key/models/album.rb

@@ -0,0 +1,11 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Album < ActiveRecord::Base
+  # `albums` is defined as INTERLEAVE IN PARENT `singers`.
+  # The primary key of `singers` is `singerid`.
+  belongs_to :singer, foreign_key: :singerid
+end

data/examples/snippets/auto-generated-primary-key/models/singer.rb

@@ -0,0 +1,11 @@
+# Copyright 2025 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Singer < ActiveRecord::Base
+  # `albums` is defined as INTERLEAVE IN PARENT `singers`.
+  # The primary key of `albums` is (`singerid`, `albumid`).
+  has_many :albums, foreign_key: :singerid
+end

data/lib/active_record/connection_adapters/spanner/column.rb

@@ -19,6 +19,10 @@ module ActiveRecord
           @primary_key = primary_key
         end
 
+        def auto_incremented_by_db?
+          sql_type_metadata.is_identity
+        end
+
         def has_default?
           super && !virtual?
         end

data/lib/active_record/connection_adapters/spanner/schema_creation.rb

@@ -8,6 +8,11 @@ module ActiveRecord
   module ConnectionAdapters
     module Spanner
       class SchemaCreation < SchemaCreation
+        def initialize connection
+          super
+          @connection = connection
+        end
+
         private
 
         # rubocop:disable Naming/MethodName, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -128,14 +133,18 @@ module ActiveRecord
           sql
         end
 
-        # rubocop:enable Naming/MethodName, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-
         def add_column_options! column, sql, options
           if options[:null] == false || options[:primary_key] == true
             sql << " NOT NULL"
           end
           if options.key? :default
             sql << " DEFAULT (#{quote_default_expression options[:default], column})"
+          elsif column.type == :primary_key
+            if @connection.use_auto_increment?
+              sql << " AUTO_INCREMENT"
+            elsif @connection.use_identity?
+              sql << " GENERATED BY DEFAULT AS IDENTITY (#{@connection.default_sequence_kind})"
+            end
           end
 
           if !options[:allow_commit_timestamp].nil? &&
@@ -158,6 +167,8 @@ module ActiveRecord
 
           sql
         end
+
+        # rubocop:enable Naming/MethodName, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       end
     end
   end

data/lib/active_record/connection_adapters/spanner/schema_statements.rb

@@ -21,8 +21,6 @@ module ActiveRecord
       # [Schema Doc](https://cloud.google.com/spanner/docs/information-schema)
       #
       module SchemaStatements
-        VERSION_6_1_0 = Gem::Version.create "6.1.0"
-        VERSION_6_0_3 = Gem::Version.create "6.0.3"
         VERSION_7_2 = Gem::Version.create "7.2.0"
 
         def current_database
@@ -125,18 +123,20 @@ module ActiveRecord
             fetch_type_metadata(field.spanner_type,
                                 field.ordinal_position,
                                 field.allow_commit_timestamp,
-                                field.generated),
+                                field.generated,
+                                is_identity: field.is_identity),
             field.nullable,
             field.default_function,
             primary_key: field.primary_key
         end
 
-        def fetch_type_metadata sql_type, ordinal_position = nil, allow_commit_timestamp = nil, generated = nil
+        def fetch_type_metadata sql_type, ordinal_position = nil, allow_commit_timestamp = nil, generated = nil,
+                                is_identity: false
           Spanner::TypeMetadata.new \
             super(sql_type),
             ordinal_position: ordinal_position,
             allow_commit_timestamp: allow_commit_timestamp,
-            generated: generated
+            generated: generated, is_identity: is_identity
         end
 
         def add_column table_name, column_name, type, **options

data/lib/active_record/connection_adapters/spanner/type_metadata.rb

@@ -17,12 +17,15 @@ module ActiveRecord
         attr_reader :ordinal_position
         attr_reader :allow_commit_timestamp
         attr_reader :generated
+        attr_reader :is_identity
 
-        def initialize type_metadata, ordinal_position: nil, allow_commit_timestamp: nil, generated: nil
+        def initialize type_metadata, ordinal_position: nil, allow_commit_timestamp: nil, generated: nil,
+                       is_identity: false
           super type_metadata
           @ordinal_position = ordinal_position
           @allow_commit_timestamp = allow_commit_timestamp
           @generated = generated
+          @is_identity = is_identity
         end
 
         def == other
@@ -30,12 +33,13 @@ module ActiveRecord
             __getobj__ == other.__getobj__ &&
             ordinal_position == other.ordinal_position &&
             allow_commit_timestamp == other.allow_commit_timestamp &&
-            generated == other.generated
+            generated == other.generated &&
+            is_identity == other.is_identity
         end
         alias eql? ==
 
         def hash
-          [TypeMetadata.name, __getobj__, ordinal_position, allow_commit_timestamp, generated].hash
+          [TypeMetadata.name, __getobj__, ordinal_position, allow_commit_timestamp, generated, is_identity].hash
         end
 
         private

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

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/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