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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 397
def column(name, type, index: nil, **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

  @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, а также _type, если указан параметр :polymorphic. Если :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

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

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

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

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

index(:account_id, name: 'index_projects_on_account_id')

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 463
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 для деталей параметров, которые вы можете использовать.

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

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

remove_column(:account_id)

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