Class: ActiveRecord::ConnectionAdapters::TableDefinition

Inherits:
Object
  • Object
show all
Includes:
ColumnMethods
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb

Overview

Represents the schema of an SQL table in an abstract way. This class provides methods for manipulating the schema representation.

Inside migration files, the t object in create_table is actually of this type:

class SomeMigration < ActiveRecord::Migration[6.0]
  def up
    create_table :foo do |t|
      puts t.class  # => "ActiveRecord::ConnectionAdapters::TableDefinition"
    end
  end

  def down
    ...
  end
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ColumnMethods

#primary_key

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Constructor Details

#initialize(conn, name, temporary: false, if_not_exists: false, options: nil, as: nil, comment: nil) ⇒ TableDefinition


262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 262

def initialize(
  conn,
  name,
  temporary: false,
  if_not_exists: false,
  options: nil,
  as: nil,
  comment: nil
)
  @conn = conn
  @columns_hash = {}
  @indexes = []
  @foreign_keys = []
  @primary_keys = nil
  @temporary = temporary
  @if_not_exists = if_not_exists
  @options = options
  @as = as
  @name = name
  @comment = comment
end

Instance Attribute Details

#asObject (readonly)

Returns the value of attribute as


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def as
  @as
end

#commentObject (readonly)

Returns the value of attribute comment


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def comment
  @comment
end

#foreign_keysObject (readonly)

Returns the value of attribute foreign_keys


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def foreign_keys
  @foreign_keys
end

#if_not_existsObject (readonly)

Returns the value of attribute if_not_exists


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def if_not_exists
  @if_not_exists
end

#indexesObject (readonly)

Returns the value of attribute indexes


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def indexes
  @indexes
end

#nameObject (readonly)

Returns the value of attribute name


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def name
  @name
end

#optionsObject (readonly)

Returns the value of attribute options


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def options
  @options
end

#temporaryObject (readonly)

Returns the value of attribute temporary


260
261
262
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 260

def temporary
  @temporary
end

Instance Method Details

#[](name) ⇒ Object

Returns a ColumnDefinition for the column with name name.


293
294
295
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 293

def [](name)
  @columns_hash[name.to_s]
end

#column(name, type, **options) ⇒ Object

Instantiates a new column for the table. See connection.add_column for available options.

Additional options are:

  • :index - Create an index for the column. Can be either true or an options hash.

This method returns self.

Examples

# Assuming +td+ is an instance of TableDefinition
td.column(:granted, :boolean, index: true)

Short-hand examples

Instead of calling #column directly, you can also work with the short-hand definitions for the default types. They use the type as the method name instead of as a parameter and allow for multiple columns to be defined in a single statement.

What can be written like this with the regular calls to column:

create_table :products do |t|
  t.column :shop_id,     :integer
  t.column :creator_id,  :integer
  t.column :item_number, :string
  t.column :name,        :string, default: "Untitled"
  t.column :value,       :string, default: "Untitled"
  t.column :created_at,  :datetime
  t.column :updated_at,  :datetime
end
add_index :products, :item_number

can also be written as follows using the short-hand:

create_table :products do |t|
  t.integer :shop_id, :creator_id
  t.string  :item_number, index: true
  t.string  :name, :value, default: "Untitled"
  t.timestamps null: false
end

There's a short-hand method for each of the type values declared at the top. And then there's TableDefinition#timestamps that'll add created_at and updated_at as datetimes.

TableDefinition#references will add an appropriately-named _id column, plus a corresponding _type column if the :polymorphic option is supplied. If :polymorphic is a hash of options, these will be used when creating the _type column. The :index option will also create an index, similar to calling add_index. So what can be written like this:

create_table :taggings do |t|
  t.integer :tag_id, :tagger_id, :taggable_id
  t.string  :tagger_type
  t.string  :taggable_type, default: 'Photo'
end
add_index :taggings, :tag_id, name: 'index_taggings_on_tag_id'
add_index :taggings, [:tagger_id, :tagger_type]

Can also be written as follows using references:

create_table :taggings do |t|
  t.references :tag, index: { name: 'index_taggings_on_tag_id' }
  t.references :tagger, polymorphic: true
  t.references :taggable, polymorphic: { default: 'Photo' }, index: false
end

364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 364

def column(name, type, **options)
  name = name.to_s
  type = type.to_sym if type

  if @columns_hash[name]
    if @columns_hash[name].primary_key?
      raise ArgumentError, "you can't redefine the primary key column '#{name}'. To define a custom primary key, pass { id: false } to create_table."
    else
      raise ArgumentError, "you can't define an already defined column '#{name}'."
    end
  end

  index_options = options.delete(:index)
  index(name, index_options.is_a?(Hash) ? index_options : {}) if index_options
  @columns_hash[name] = new_column_definition(name, type, **options)
  self
end

#columnsObject

Returns an array of ColumnDefinition objects for the columns of the table.


290
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 290

def columns; @columns_hash.values; end

#foreign_key(table_name, **options) ⇒ Object

:nodoc:


396
397
398
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 396

def foreign_key(table_name, **options) # :nodoc:
  foreign_keys << [table_name, options]
end

#index(column_name, options = {}) ⇒ Object

Adds index options to the indexes hash, keyed by column name This is primarily used to track indexes that need to be created after the table

index(:account_id, name: 'index_projects_on_account_id')

392
393
394
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 392

def index(column_name, options = {})
  indexes << [column_name, options]
end

#new_column_definition(name, type, **options) ⇒ Object

:nodoc:


429
430
431
432
433
434
435
436
437
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 429

def new_column_definition(name, type, **options) # :nodoc:
  if integer_like_primary_key?(type, options)
    type = integer_like_primary_key_type(type, options)
  end
  type = aliased_types(type.to_s, type)
  options[:primary_key] ||= type == :primary_key
  options[:null] = false if options[:primary_key]
  create_column_definition(name, type, options)
end

#primary_keys(name = nil) ⇒ Object

:nodoc:


284
285
286
287
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 284

def primary_keys(name = nil) # :nodoc:
  @primary_keys = PrimaryKeyDefinition.new(name) if name
  @primary_keys
end

#references(*args, **options) ⇒ Object Also known as: belongs_to

Adds a reference.

t.references(:user)
t.belongs_to(:supplier, foreign_key: true)
t.belongs_to(:supplier, foreign_key: true, type: :integer)

See connection.add_reference for details of the options you can use.


422
423
424
425
426
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 422

def references(*args, **options)
  args.each do |ref_name|
    ReferenceDefinition.new(ref_name, **options).add_to(self)
  end
end

#remove_column(name) ⇒ Object

remove the column name from the table.

remove_column(:account_id)

384
385
386
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 384

def remove_column(name)
  @columns_hash.delete name.to_s
end

#timestamps(**options) ⇒ Object

Appends :datetime columns :created_at and :updated_at to the table. See connection.add_timestamps

t.timestamps null: false

404
405
406
407
408
409
410
411
412
413
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 404

def timestamps(**options)
  options[:null] = false if options[:null].nil?

  if !options.key?(:precision) && @conn.supports_datetime_with_precision?
    options[:precision] = 6
  end

  column(:created_at, :datetime, **options)
  column(:updated_at, :datetime, **options)
end