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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 256
def column(name, type, options = {})
  name = name.to_s
  type = type.to_sym
  options = options.dup

  if @columns_hash[name] && @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."
  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

Создает новый столбец для таблицы. Параметр type обычно является одним из типов миграций, которые могут быть следующими: :primary_key, :string, :text, :integer, :float, :decimal, :datetime, :time, :date, :binary, :boolean.

Вы можете использовать тип, не входящий в этот список, если он поддерживается вашей базой данных (например, «polygon» в MySQL), но это не будет работать со всеми базами данных и обычно следует избегать.

Доступные параметры (ни один из них по умолчанию не существует):

• :limit — Запрашивает максимальную длину столбца. Это число символов для столбцов :string и :text и число байтов для столбцов :binary и :integer.

• :default — Значение по умолчанию столбца. Используйте nil для NULL.

• :null — Разрешает или запрещает значения NULL в столбце. Этот параметр мог быть назван :null_allowed.

• :precision — Указывает точность для столбца :decimal.

• :scale — Указывает масштаб для столбца :decimal.

• :index — Создает индекс для столбца. Может быть либо true или объект параметров.

Примечание: Точность — это общее количество значащих цифр, а масштаб — количество цифр, которые могут храниться после десятичной точки. Например, число 123,45 имеет точность 5 и масштаб 2. Десятичное число с точностью 5 и масштабом 2 может принимать значения от -999,99 до 999,99.

Обратите внимание на разное поведение разных СУБД для столбцов :decimal:

• Стандарт SQL гласит, что значение по умолчанию для масштаба должно быть 0, :scale <= :precision, и не содержит комментариев об ограничениях для :precision.

• MySQL: :precision [1..63], :scale [0..30]. Значение по умолчанию (10,0).

• PostgreSQL: :precision [1..бесконечность], :scale [0..бесконечность]. Значение по умолчанию отсутствует.

• SQLite2: Любые :precision и :scale могут использоваться. Внутреннее хранение как строки. Значение по умолчанию отсутствует.

• SQLite3: Нет ограничений на :precision и :scale, но максимальная поддерживаемая :precision составляет 16. Значение по умолчанию отсутствует.

• Oracle: :precision [1..38], :scale [-84..127]. Значение по умолчанию (38,0).

• DB2: :precision [1..63], :scale [0..62]. Значение по умолчанию неизвестно.

• SqlServer?: :precision [1..38], :scale [0..38]. Значение по умолчанию (38,0).

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

Примеры

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

td.column(:picture, :binary, limit: 2.megabytes)
# => picture BLOB(2097152)

td.column(:sales_stage, :string, limit: 20, default: 'new', null: false)
# => sales_stage VARCHAR(20) DEFAULT 'new' NOT NULL

td.column(:bill_gates_money, :decimal, precision: 15, scale: 2)
# => bill_gates_money DECIMAL(15,2)

td.column(:sensor_reading, :decimal, precision: 30, scale: 20)
# => sensor_reading DECIMAL(30,20)

# While <tt>:scale</tt> defaults to zero on most databases, it
# probably wouldn't hurt to include it.
td.column(:huge_integer, :decimal, precision: 30)
# => huge_integer DECIMAL(30)

# Defines a column with a database-specific type.
td.column(:foo, 'polygon')
# => foo polygon

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

Вместо непосредственного вызова 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

Для каждого значения типа, объявленного вверху, есть метод краткой записи. А затем есть #timestamps, которые добавят created_at и updated_at как даты и время.

#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, index: true
  t.references :taggable, polymorphic: { default: 'Photo' }
end

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 287
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 114
def primary_key(name, type = :primary_key, options = {})
  column(name, type, options.merge(:primary_key => true))
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 312
def references(*args)
  options = args.extract_options!
  polymorphic = options.delete(:polymorphic)
  index_options = options.delete(:index)
  foreign_key_options = options.delete(:foreign_key)
  type = options.delete(:type) || :integer

  if polymorphic && foreign_key_options
    raise ArgumentError, "Cannot add a foreign key on a polymorphic relation"
  end

  args.each do |col|
    column("#{col}_id", type, options)
    column("#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
    index(polymorphic ? %w(type id).map { |t| "#{col}_#{t}" } : "#{col}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
    if foreign_key_options
      to_table = Base.pluralize_table_names ? col.to_s.pluralize : col.to_s
      foreign_key(to_table, foreign_key_options.is_a?(Hash) ? foreign_key_options : {})
    end
  end
end

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

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

Подробности о параметрах, которые вы можете использовать, см. в ActiveRecord::ConnectionAdapters::SchemaStatements#add_reference.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 299
def timestamps(*args)
  options = args.extract_options!
  emit_warning_if_null_unspecified(:timestamps, options)
  column(:created_at, :datetime, options)
  column(:updated_at, :datetime, options)
end

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

t.timestamps null: false