модуль ActiveRecord::ConnectionAdapters::SchemaStatements

Добавляет новый столбец в указанную таблицу. Смотрите ActiveRecord::ConnectionAdapters::TableDefinition#column для подробностей об опциях.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 372
def add_column(table_name, column_name, type, options = {})
  at = create_alter_table table_name
  at.add_column(column_name, type, options)
  execute schema_creation.accept at
end

Добавляет новый индекс в таблицу. column_name может быть одним символом или массивом символов.

Индекс будет назван по таблице и имени(ям) столбца(ов), если вы не передадите :name в качестве опции.

Создание простого индекса

add_index(:suppliers, :name)

генерирует:

CREATE INDEX suppliers_name_index ON suppliers(name)

Создание уникального индекса

add_index(:accounts, [:branch_id, :party_id], unique: true)

генерирует:

CREATE UNIQUE INDEX accounts_branch_id_party_id_index ON accounts(branch_id, party_id)

Создание индекса с именем

add_index(:accounts, [:branch_id, :party_id], unique: true, name: 'by_branch_party')

генерирует:

CREATE UNIQUE INDEX by_branch_party ON accounts(branch_id, party_id)

Создание индекса со специфической длиной ключа

add_index(:accounts, :name, name: 'by_name', length: 10)

генерирует:

CREATE INDEX by_name ON accounts(name(10))

add_index(:accounts, [:name, :surname], name: 'by_name_surname', length: {name: 10, surname: 15})

генерирует:

CREATE INDEX by_name_surname ON accounts(name(10), surname(15))

Примечание: SQLite не поддерживает длину индекса.

Создание индекса с порядком сортировки (desc или asc, asc по умолчанию)

add_index(:accounts, [:branch_id, :party_id, :surname], order: {branch_id: :desc, party_id: :asc})

генерирует:

CREATE INDEX by_branch_desc_party ON accounts(branch_id DESC, party_id ASC, surname)

Примечание: MySQL ещё не поддерживает порядок индекса (он принимает синтаксис, но игнорирует его).

Создание частичного индекса

add_index(:accounts, [:branch_id, :party_id], unique: true, where: "active")

генерирует:

CREATE UNIQUE INDEX index_accounts_on_branch_id_and_party_id ON accounts(branch_id, party_id) WHERE active

Создание индекса со специфическим методом

add_index(:developers, :name, using: 'btree')

генерирует:

CREATE INDEX index_developers_on_name ON developers USING btree (name) -- PostgreSQL
CREATE INDEX index_developers_on_name USING btree ON developers (name) -- MySQL

Примечание: поддерживается только PostgreSQL и MySQL

Создание индекса со специфическим типом

add_index(:developers, :name, type: :fulltext)

генерирует:

CREATE FULLTEXT INDEX index_developers_on_name ON developers (name) -- MySQL

Примечание: поддерживается только MySQL. Поддерживается: :fulltext и :spatial в таблицах MyISAM.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 535
def add_index(table_name, column_name, options = {})
  index_name, index_type, index_columns, index_options = add_index_options(table_name, column_name, options)
  execute "CREATE #{index_type} INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{index_columns})#{index_options}"
end

Добавляет ссылку. Дополнительно добавляет столбец type, если предоставлена опция :polymorphic. add_reference и add_belongs_to допустимы.

Создание столбца user_id

add_reference(:products, :user)

Создание столбцов supplier_id и supplier_type

add_belongs_to(:products, :supplier, polymorphic: true)

Создание столбцов supplier_id, supplier_type и соответствующего индекса

add_reference(:products, :supplier, polymorphic: true, index: true)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 619
def add_reference(table_name, ref_name, options = {})
  polymorphic = options.delete(:polymorphic)
  index_options = options.delete(:index)
  add_column(table_name, "#{ref_name}_id", :integer, options)
  add_column(table_name, "#{ref_name}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
  add_index(table_name, polymorphic ? %w[id type].map{ |t| "#{ref_name}_#{t}" } : "#{ref_name}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
end

Добавляет столбцы временных меток (created_at и updated_at) в указанную таблицу.

add_timestamps(:suppliers)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 725
def add_timestamps(table_name, options = {})
  add_column table_name, :created_at, :datetime, options
  add_column table_name, :updated_at, :datetime, options
end

Изменяет определение столбца в соответствии с новыми опциями. Смотрите ActiveRecord::ConnectionAdapters::TableDefinition#column для подробностей об опциях.

change_column(:suppliers, :name, :string, limit: 80)
change_column(:accounts, :description, :text)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 406
def change_column(table_name, column_name, type, options = {})
  raise NotImplementedError, "change_column is not implemented"
end

Устанавливает новое значение по умолчанию для столбца:

change_column_default(:suppliers, :qualification, 'new')
change_column_default(:accounts, :authorized, 1)

Установление значения по умолчанию на nil фактически удаляет значение по умолчанию:

change_column_default(:users, :email, nil)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 419
def change_column_default(table_name, column_name, default)
  raise NotImplementedError, "change_column_default is not implemented"
end

Устанавливает или удаляет ограничение +NOT NULL+ для столбца. Флаг null указывает, можно ли значение NULL. Например

change_column_null(:users, :nickname, false)

указывает, что псевдонимы не могут быть NULL (добавляет ограничение), тогда как

change_column_null(:users, :nickname, true)

разрешает их NULL (удаляет ограничение).

Метод принимает необязательный четвёртый аргумент для замены существующих +NULL+ на другое значение. Используйте его при включении ограничения, если необходимо, так как в противном случае эти строки не будут допустимы.

Обратите внимание, что четвёртый аргумент не устанавливает значение по умолчанию для столбца.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 439
def change_column_null(table_name, column_name, null, default = nil)
  raise NotImplementedError, "change_column_null is not implemented"
end

Блок для изменения столбцов в table.

# change_table() yields a Table instance
change_table(:suppliers) do |t|
  t.column :name, :string, limit: 60
  # Other column alterations here
end

Хэш options может содержать следующие ключи:

:bulk

Установите это в значение true, чтобы сделать это запросом массового изменения, например

ALTER TABLE `users` ADD COLUMN age INT(11), ADD COLUMN birthdate DATETIME ...

По умолчанию false.

Добавить столбец

change_table(:suppliers) do |t|
  t.column :name, :string, limit: 60
end

Добавить 2 столбца типа integer

change_table(:suppliers) do |t|
  t.integer :width, :height, null: false, default: 0
end

Добавить столбцы created_at/updated_at

change_table(:suppliers) do |t|
  t.timestamps
end

Добавить столбец внешнего ключа

change_table(:suppliers) do |t|
  t.references :company
end

Создаёт столбец company_id(integer).

Добавить столбец полиморфного внешнего ключа

change_table(:suppliers) do |t|
  t.belongs_to :company, polymorphic: true
end

Создаёт столбцы company_type(varchar) и company_id(integer).

Удалить столбец

change_table(:suppliers) do |t|
  t.remove :company
end

Удалить несколько столбцов

change_table(:suppliers) do |t|
  t.remove :company_id
  t.remove :width, :height
end

Удалить индекс

change_table(:suppliers) do |t|
  t.remove_index :company_id
end

Также смотрите Table для подробностей о различных преобразованиях столбцов.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 343
def change_table(table_name, options = {})
  if supports_bulk_alter? && options[:bulk]
    recorder = ActiveRecord::Migration::CommandRecorder.new(self)
    yield update_table_definition(table_name, recorder)
    bulk_change_table(table_name, recorder.commands)
  else
    yield update_table_definition(table_name, self)
  end
end

Проверяет существование столбца в заданной таблице.

# Check a column exists
column_exists?(:suppliers, :name)

# Check a column exists of a particular type
column_exists?(:suppliers, :name, :string)

# Check a column exists with a specific definition
column_exists?(:suppliers, :name, :string, limit: 100)
column_exists?(:suppliers, :name, :string, default: 'default')
column_exists?(:suppliers, :name, :string, null: false)
column_exists?(:suppliers, :tax, :decimal, precision: 8, scale: 2)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 73
def column_exists?(table_name, column_name, type = nil, options = {})
  columns(table_name).any?{ |c| c.name == column_name.to_s &&
                                (!type                     || c.type == type) &&
                                (!options.key?(:limit)     || c.limit == options[:limit]) &&
                                (!options.key?(:precision) || c.precision == options[:precision]) &&
                                (!options.key?(:scale)     || c.scale == options[:scale]) &&
                                (!options.key?(:default)   || c.default == options[:default]) &&
                                (!options.key?(:null)      || c.null == options[:null]) }
end

Возвращает массив объектов Column для указанной таблицы table_name. Смотрите реализацию для подробностей о ожидаемых значениях параметра.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 57
def columns(table_name) end

Создаёт новую таблицу связи с именем, созданным в лексикографическом порядке первых двух аргументов. Эти аргументы могут быть строкой (String) или символом (Symbol).

# Creates a table called 'assemblies_parts' with no id.
create_join_table(:assemblies, :parts)

Вы можете передать хэш options, который может содержать следующие ключи:

:table_name

Устанавливает имя таблицы, переопределяя значение по умолчанию

:column_options

Любые дополнительные параметры, которые нужно добавить к определению столбцов.

:options

Любые дополнительные параметры, которые нужно добавить к определению таблицы.

:temporary

Сделать временную таблицу.

:force

Установить в значение true, чтобы удалить таблицу перед её созданием. По умолчанию значение false.

Обратите внимание, что create_join_table по умолчанию не создаёт никаких индексов; вы можете сами сделать это с помощью блока:

create_join_table :products, :categories do |t|
  t.index :product_id
  t.index :category_id
end

Добавить параметр, специфичный для бэкенда, в сгенерированный SQL (MySQL)

create_join_table(:assemblies, :parts, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8')

генерирует:

CREATE TABLE assemblies_parts (
  assembly_id int NOT NULL,
  part_id int NOT NULL,
) ENGINE=InnoDB DEFAULT CHARSET=utf8

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 247
def create_join_table(table_1, table_2, options = {})
  join_table_name = find_join_table_name(table_1, table_2, options)

  column_options = options.delete(:column_options) || {}
  column_options.reverse_merge!(null: false)

  t1_column, t2_column = [table_1, table_2].map{ |t| t.to_s.singularize.foreign_key }

  create_table(join_table_name, options.merge!(id: false)) do |td|
    td.integer t1_column, column_options
    td.integer t2_column, column_options
    yield td if block_given?
  end
end

Создаёт новую таблицу с именем table_name. table_name может быть строкой (String) или символом (Symbol).

Есть два способа работы с create_table. Вы можете использовать форму с блоком или обычную форму, как в этом примере:

Форма с блоком

# create_table() passes a TableDefinition object to the block.
# This form will not only create the table, but also columns for the
# table.

create_table(:suppliers) do |t|
  t.column :name, :string, limit: 60
  # Other fields here
end

Форма с блоком, с сокращениями

# You can also use the column types as method calls, rather than calling the column method.
create_table(:suppliers) do |t|
  t.string :name, limit: 60
  # Other fields here
end

Обычная форма

# Creates a table called 'suppliers' with no columns.
create_table(:suppliers)
# Add a column to 'suppliers'.
add_column(:suppliers, :name, :string, {limit: 60})

Хэш options может содержать следующие ключи:

:id

Автоматически добавлять столбец первичного ключа. По умолчанию true. Таблицы связи has_and_belongs_to_many должны установить его в false.

:primary_key

Имя первичного ключа, если он должен быть добавлен автоматически. По умолчанию id. Если :id равно false, этот параметр игнорируется.

Обратите внимание, что модели Active Record автоматически определяют свой первичный ключ. Это можно избежать, используя self.primary_key= в модели для явного определения ключа.

:options

Любые дополнительные параметры, которые нужно добавить к определению таблицы.

:temporary

Сделать временную таблицу.

:force

Установить в true, чтобы удалить таблицу перед её созданием. По умолчанию false.

:as

SQL-запрос для создания таблицы. При использовании этого параметра блок игнорируется, а также параметры :id и :primary_key.

Добавить параметр, специфичный для бэкенда, в сгенерированный SQL (MySQL)

create_table(:suppliers, options: 'ENGINE=InnoDB DEFAULT CHARSET=utf8')

генерирует:

CREATE TABLE suppliers (
  id int(11) DEFAULT NULL auto_increment PRIMARY KEY
) ENGINE=InnoDB DEFAULT CHARSET=utf8

Переименовать столбец первичного ключа

create_table(:objects, primary_key: 'guid') do |t|
  t.column :name, :string, limit: 80
end

генерирует:

CREATE TABLE objects (
  guid int(11) DEFAULT NULL auto_increment PRIMARY KEY,
  name varchar(80)
)

Не добавлять столбец первичного ключа

create_table(:categories_suppliers, id: false) do |t|
  t.column :category_id, :integer
  t.column :supplier_id, :integer
end

генерирует:

CREATE TABLE categories_suppliers (
  category_id int,
  supplier_id int
)

Создать временную таблицу на основе запроса

create_table(:long_query, temporary: true,
  as: "SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id")

генерирует:

CREATE TEMPORARY TABLE long_query AS
  SELECT * FROM orders INNER JOIN line_items ON order_id=orders.id

См. также ActiveRecord::ConnectionAdapters::TableDefinition#column для подробной информации о создании столбцов.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 186
def create_table(table_name, options = {})
  td = create_table_definition table_name, options[:temporary], options[:options], options[:as]

  if !options[:as]
    unless options[:id] == false
      pk = options.fetch(:primary_key) {
        Base.get_primary_key table_name.to_s.singularize
      }

      td.primary_key pk, options.fetch(:id, :primary_key), options
    end

    yield td if block_given?
  end

  if options[:force] && table_exists?(table_name)
    drop_table(table_name, options)
  end

  execute schema_creation.accept td
  td.indexes.each_pair { |c,o| add_index table_name, c, o }
end

Удаляет таблицу связи, указанную заданными аргументами. Подробности см. в create_join_table.

Хотя эта команда игнорирует блок, если он задан, его использование может быть полезно в методе change миграции, чтобы его можно было отменить. В этом случае блок будет использован методом create_join_table.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 268
def drop_join_table(table_1, table_2, options = {})
  join_table_name = find_join_table_name(table_1, table_2, options)
  drop_table(join_table_name)
end

Удаляет таблицу из базы данных.

Хотя эта команда игнорирует options и блок, если он задан, его использование может быть полезно в методе change миграции, чтобы его можно было отменить. В этом случае options и блок будут использованы методом create_table.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 366
def drop_table(table_name, options = {})
  execute "DROP TABLE #{quote_table_name(table_name)}"
end

Проверяет наличие индекса в таблице для данного определения индекса.

# Check an index exists
index_exists?(:suppliers, :company_id)

# Check an index on multiple columns exists
index_exists?(:suppliers, [:company_id, :company_type])

# Check a unique index exists
index_exists?(:suppliers, :company_id, unique: true)

# Check an index with a custom name exists
index_exists?(:suppliers, :company_id, name: "idx_company_id")

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 45
def index_exists?(table_name, column_name, options = {})
  column_names = Array(column_name)
  index_name = options.key?(:name) ? options[:name].to_s : index_name(table_name, :column => column_names)
  if options[:unique]
    indexes(table_name).any?{ |i| i.unique && i.name == index_name }
  else
    indexes(table_name).any?{ |i| i.name == index_name }
  end
end

Проверяет наличие индекса с заданным именем.

Аргумент по умолчанию возвращается, если реализация не определяет метод indexes, так как в этом случае невозможно определить правильный ответ.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 598
def index_name_exists?(table_name, index_name, default)
  return default unless respond_to?(:indexes)
  index_name = index_name.to_s
  indexes(table_name).detect { |i| i.name == index_name }
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 655
def initialize_schema_migrations_table
  ActiveRecord::SchemaMigration.create_table
end

Возвращает хэш сопоставлений от абстрактных типов данных к родным типам данных базы данных. Подробности о распознаваемых абстрактных типах данных см. в ActiveRecord::ConnectionAdapters::TableDefinition#column.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 11
def native_database_types
  {}
end

Удаляет столбец из определения таблицы.

remove_column(:suppliers, :qualification)

Параметры type и options будут проигнорированы, если присутствуют. Их использование может быть полезно в методе change миграции, чтобы его можно было отменить. В этом случае type и options будут использованы методом add_column.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 396
def remove_column(table_name, column_name, type = nil, options = {})
  execute "ALTER TABLE #{quote_table_name(table_name)} DROP #{quote_column_name(column_name)}"
end

Удаляет указанные столбцы из определения таблицы.

remove_columns(:suppliers, :qualification, :experience)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 382
def remove_columns(table_name, *column_names)
  raise ArgumentError.new("You must specify at least one column name. Example: remove_columns(:people, :first_name)") if column_names.empty?
  column_names.each do |column_name|
    remove_column(table_name, column_name)
  end
end

Удаляет заданный индекс из таблицы.

Удаляет index_accounts_on_column в таблице accounts.

remove_index :accounts, :column

Удаляет индекс с именем index_accounts_on_branch_id в таблице accounts.

remove_index :accounts, column: :branch_id

Удаляет индекс с именем index_accounts_on_branch_id_and_party_id в таблице accounts.

remove_index :accounts, column: [:branch_id, :party_id]

Удаляет индекс с именем by_branch_party в таблице accounts.

remove_index :accounts, name: :by_branch_party

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 558
def remove_index(table_name, options = {})
  remove_index!(table_name, index_name_for_remove(table_name, options))
end

Удаляет ссылку(и). Также удаляет столбец type, если он существует. remove_reference, remove_references и remove_belongs_to допустимы.

Удаление ссылки

remove_reference(:products, :user, index: true)

Удаление полиморфной ссылки

remove_reference(:products, :supplier, polymorphic: true)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 639
def remove_reference(table_name, ref_name, options = {})
  remove_column(table_name, "#{ref_name}_id")
  remove_column(table_name, "#{ref_name}_type") if options[:polymorphic]
end

Удаляет столбцы временных меток (created_at и updated_at) из определения таблицы.

remove_timestamps(:suppliers)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 734
def remove_timestamps(table_name)
  remove_column table_name, :updated_at
  remove_column table_name, :created_at
end

Переименование столбца.

rename_column(:suppliers, :description, :name)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 447
def rename_column(table_name, column_name, new_column_name)
  raise NotImplementedError, "rename_column is not implemented"
end

Переименование индекса.

Переименование индекса index_people_on_last_name в index_users_on_last_name:

rename_index :people, 'index_people_on_last_name', 'index_users_on_last_name'

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 572
def rename_index(table_name, old_name, new_name)
  # this is a naive implementation; some DBs may support this more efficiently (Postgres, for instance)
  old_index_def = indexes(table_name).detect { |i| i.name == old_name }
  return unless old_index_def
  add_index(table_name, old_index_def.columns, name: new_name, unique: old_index_def.unique)
  remove_index(table_name, name: old_name)
end

Переименование таблицы.

rename_table('octopuses', 'octopi')

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 357
def rename_table(table_name, new_name)
  raise NotImplementedError, "rename_table is not implemented"
end

Усечение псевдонима таблицы в соответствии с ограничениями текущего адаптера.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 16
def table_alias_for(table_name)
  table_name[0...table_alias_length].tr('.', '_')
end

Проверка существования таблицы table_name в базе данных.

table_exists?(:developers)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 24
def table_exists?(table_name)
  tables.include?(table_name.to_s)
end