класс ActiveRecord::ConnectionAdapters::TableDefinition

Родительский класс:: Object
Подключённые модули:: ActiveRecord::ConnectionAdapters::ColumnMethods

Определение таблицы адаптеров подключения Active Record

Представляет схему таблицы SQL в абстрактном виде. Этот класс предоставляет методы для работы с представлением схемы.

В файлах миграций объект t в create_table фактически имеет этот тип:

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

  def down
    ...
  end
end

Атрибуты

as [R]

check_constraints [R]

Публичные методы класса

new ( conn, name, temporary: false, if_not_exists: false, options: nil, as: nil, comment: nil, ** ) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 363
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
  @check_constraints = []
  @temporary = temporary
  @if_not_exists = if_not_exists
  @options = options
  @as = as
  @name = name
  @comment = comment
end

Публичные методы экземпляра

[] (name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 413
def [](name)
  @columns_hash[name.to_s]
end

Возвращает ColumnDefinition для столбца с именем name.

belongs_to (*args, **options)

Псевдоним для: references

check_constraint (expression, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 517
def check_constraint(expression, **options)
  check_constraints << new_check_constraint_definition(expression, options)
end

column (name, type, index: nil, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 484
def column(name, type, index: nil, **options)
  name = name.to_s
  type = type.to_sym if type

  raise_on_duplicate_column(name)
  @columns_hash[name] = new_column_definition(name, type, **options)

  if index
    index_options = index.is_a?(Hash) ? index : {}
    index(name, **index_options)
  end

  self
end

Создаёт новый столбец таблицы. Доступные параметры см. в описании connection.add_column.

Дополнительные параметры:

:index — создаёт индекс для столбца. Значением может быть true или хеш параметров.

Этот метод возвращает self.

Примеры

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

Примеры краткой записи

Вместо непосредственного вызова column можно также использовать краткие определения для типов по умолчанию. В них имя метода соответствует типу, а не передаваемому параметру, и в одном выражении можно определить несколько столбцов.

Вместо обычных вызовов 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

можно также использовать следующую краткую запись:

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

Для каждого из типов, перечисленных выше, есть краткий метод. Кроме того, метод TableDefinition#timestamps добавляет created_at и updated_at в качестве столбцов типа datetime.

TableDefinition#references добавляет столбец _id с соответствующим именем, а если указан параметр :polymorphic — ещё и соответствующий столбец _type. Если :polymorphic — это хеш параметров, они будут использованы при создании столбца _type. Параметр :index также создаёт индекс, аналогично вызову add_index. Таким образом, вместо следующего:

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]

можно использовать 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

columns () Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 410
def columns; @columns_hash.values; end

Возвращает массив объектов ColumnDefinition для столбцов таблицы.

foreign_key (to_table, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 513
def foreign_key(to_table, **options)
  foreign_keys << new_foreign_key_definition(to_table, options)
end

index (column_name, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 509
def index(column_name, **options)
  indexes << [column_name, options]
end

Добавляет параметры индекса в хеш indexes с ключом, соответствующим имени столбца. В основном это используется для отслеживания индексов, которые нужно создать после таблицы.

index(:account_id, name: 'index_projects_on_account_id')

references (*args, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 543
def references(*args, **options)
  args.each do |ref_name|
    ReferenceDefinition.new(ref_name, **options).add_to(self)
  end
end

Добавляет ссылку.

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

Описание доступных параметров см. в connection.add_reference.

Также имеет псевдоним: belongs_to

remove_column (name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 501
def remove_column(name)
  @columns_hash.delete name.to_s
end

Удаляет из таблицы столбец name.

remove_column(:account_id)

set_primary_key (table_name, id, primary_key, **options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 387
def set_primary_key(table_name, id, primary_key, **options)
  if id && !as
    pk = primary_key || Base.get_primary_key(table_name.to_s.singularize)

    if id.is_a?(Hash)
      options.merge!(id.except(:type))
      id = id.fetch(:type, :primary_key)
    end

    if pk.is_a?(Array)
      primary_keys(pk)
    else
      primary_key(pk, id, **options)
    end
  end
end

timestamps (**options) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 525
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

Добавляет в таблицу столбцы :datetime и :created_at :updated_at. См. connection.add_timestamps.

t.timestamps null: false