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

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

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

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

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

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

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

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

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

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

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

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

Обратите внимание на разное поведение различных RDBMS с столбцами :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]. По умолчанию неизвестно.

• Firebird: :precision [1..18], :scale [0..18]. По умолчанию (9,0). Внутренние типы NUMERIC и DECIMAL имеют разные правила хранения, DECIMAL лучше.

• FrontBase?: :precision [1..38], :scale [0..38]. По умолчанию (38,0). ПРЕДУПРЕЖДЕНИЕ Максимальное :precision/:scale для NUMERIC — 19, а для DECIMAL — 38.

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

• Sybase: :precision [1..38], :scale [0..38]. По умолчанию (38,0).

• OpenBase?: Документация неясна. Утверждается, что хранение в double.

Этот метод возвращает 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 :name,       :string, default: "Untitled"
  t.column :value,      :string, default: "Untitled"
  t.column :created_at, :datetime
  t.column :updated_at, :datetime
end

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

create_table :products do |t|
  t.integer :shop_id, :creator_id
  t.string  :name, :value, default: "Untitled"
  t.timestamps
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 214
def column(name, type, options = {})
  name = name.to_s
  type = type.to_sym

  if primary_key_column_name == name
    raise ArgumentError, "you can't redefine the primary key column '#{name}'. To define a custom primary key, pass { id: false } to create_table."
  end

  @columns_hash[name] = new_column_definition(name, type, options)
  self
end

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

index(:account_id, name: 'index_projects_on_account_id')

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 242
def index(column_name, options = {})
  indexes[column_name] = options
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 68
def primary_key(name, type = :primary_key, options = {})
  column(name, type, options.merge(:primary_key => true))
end

Добавляет столбцы :datetime :created_at и :updated_at к таблице.

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