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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 761
def add_foreign_key(from_table, to_table, options = {})
  return unless supports_foreign_keys?

  options[:column] ||= foreign_key_column_for(to_table)

  options = {
    column: options[:column],
    primary_key: options[:primary_key],
    name: foreign_key_name(from_table, options),
    on_delete: options[:on_delete],
    on_update: options[:on_update]
  }
  at = create_alter_table from_table
  at.add_foreign_key to_table, options

  execute schema_creation.accept(at)
end

Добавляет новый внешний ключ. `from_table` — таблица со столбцом ключа, `to_table` содержит связанный первичный ключ.

Имя внешнего ключа будет сгенерировано по шаблону: fk_rails_<identifier>. `name` — строка длиной 10 символов, которая детерминированно генерируется из from_table и column. Пользовательское имя может быть задано с помощью опции :name.

Создание простого внешнего ключа

add_foreign_key :articles, :authors

генерирует:

ALTER TABLE "articles" ADD CONSTRAINT articles_author_id_fk FOREIGN KEY ("author_id") REFERENCES "authors" ("id")

Создание внешнего ключа на определённом столбце

add_foreign_key :articles, :users, column: :author_id, primary_key: :lng_id

генерирует:

ALTER TABLE "articles" ADD CONSTRAINT fk_rails_58ca3d3a82 FOREIGN KEY ("author_id") REFERENCES "users" ("lng_id")

Создание каскадного внешнего ключа

add_foreign_key :articles, :authors, on_delete: :cascade

генерирует:

ALTER TABLE "articles" ADD CONSTRAINT articles_author_id_fk FOREIGN KEY ("author_id") REFERENCES "authors" ("id") ON DELETE CASCADE

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

:column

Имя столбца внешнего ключа в `from_table`. По умолчанию to_table.singularize + "_id"

:primary_key

Имя столбца первичного ключа в `to_table`. По умолчанию id.

:name

Имя ограничения. По умолчанию fk_rails_<identifier>.

:on_delete

Действие, выполняемое при удалении строки в `to_table`. Допустимые значения: :nullify, :cascade: и :restrict

:on_update

Действие, выполняемое при изменении строки в `to_table`. Допустимые значения: :nullify, :cascade: и :restrict

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

Добавляет новый индекс в таблицу. `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

Примечание: Частичные индексы поддерживаются только для PostgreSQL и SQLite 3.8.0+.

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

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 667
def add_reference(table_name, ref_name, options = {})
  polymorphic = options.delete(:polymorphic)
  index_options = options.delete(:index)
  type = options.delete(:type) || :integer
  foreign_key_options = options.delete(:foreign_key)

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

  add_column(table_name, "#{ref_name}_id", type, options)
  add_column(table_name, "#{ref_name}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
  add_index(table_name, polymorphic ? %w[type id].map{ |t| "#{ref_name}_#{t}" } : "#{ref_name}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
  if foreign_key_options
    to_table = Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
    add_foreign_key(table_name, to_table, foreign_key_options.is_a?(Hash) ? foreign_key_options : {})
  end
end

Добавляет ссылку. Столбец ссылки по умолчанию имеет тип целое число, опция `type` может быть использована для указания другого типа. Дополнительно добавляет столбец `type` если задана опция `polymorphic`. `references` и `polymorphic` допустимы.

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

:type

Тип столбца ссылки. По умолчанию :integer.

:index

Добавить соответствующий индекс. По умолчанию false.

:foreign_key

Добавить соответствующий внешний ключ. По умолчанию false.

:polymorphic

Добавлять дополнительный столбец `type`. По умолчанию false.

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

add_reference(:products, :user)

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

add_reference(:products, :user, type: :string)

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

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

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

Добавляет столбцы времени (`created_at` и `updated_at`) в `table_name`. Дополнительные опции (например, `null: false`) передаются в add_column.

add_timestamps(:suppliers, null: false)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 438
def change_column(table_name, column_name, type, options = {})
  raise NotImplementedError, "change_column is not implemented"
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 451
def change_column_default(table_name, column_name, default)
  raise NotImplementedError, "change_column_default 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 471
def change_column_null(table_name, column_name, null, default = nil)
  raise NotImplementedError, "change_column_null 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 634
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 835
def initialize_schema_migrations_table
  ActiveRecord::SchemaMigration.create_table
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 428
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_column(:suppliers, :qualification)

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

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

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

remove_columns(:suppliers, :qualification, :experience)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 793
def remove_foreign_key(from_table, options_or_to_table = {})
  return unless supports_foreign_keys?

  if options_or_to_table.is_a?(Hash)
    options = options_or_to_table
  else
    options = { column: foreign_key_column_for(options_or_to_table) }
  end

  fk_name_to_delete = options.fetch(:name) do
    fk_to_delete = foreign_keys(from_table).detect {|fk| fk.column == options[:column].to_s }

    if fk_to_delete
      fk_to_delete.name
    else
      raise ArgumentError, "Table '#{from_table}' has no foreign key on column '#{options[:column]}'"
    end
  end

  at = create_alter_table from_table
  at.drop_foreign_key fk_name_to_delete

  execute schema_creation.accept(at)
end

Удаляет заданный внешний ключ из таблицы.

Удаляет внешний ключ на accounts.branch_id.

remove_foreign_key :accounts, :branches

Удаляет внешний ключ на accounts.owner_id.

remove_foreign_key :accounts, column: :owner_id

Удаляет внешний ключ с именем special_fk_name в таблице accounts.

remove_foreign_key :accounts, name: :special_fk_name

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 592
def remove_index(table_name, options = {})
  remove_index!(table_name, index_name_for_remove(table_name, options))
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 702
def remove_reference(table_name, ref_name, options = {})
  if options[:foreign_key]
    to_table = Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
    remove_foreign_key(table_name, to_table)
  end

  remove_column(table_name, "#{ref_name}_id")
  remove_column(table_name, "#{ref_name}_type") if options[:polymorphic]
end

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

Удалить ссылку

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

Удалить полиморфную ссылку

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

Удалить ссылку с внешним ключом

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 917
def remove_timestamps(table_name, options = {})
  remove_column table_name, :updated_at
  remove_column table_name, :created_at
end

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

remove_timestamps(:suppliers)

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

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

rename_column(:suppliers, :description, :name)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 606
def rename_index(table_name, old_name, new_name)
  validate_index_length!(table_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

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

Переименовать индекс 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 385
def rename_table(table_name, new_name)
  raise NotImplementedError, "rename_table is not implemented"
end

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

rename_table('octopuses', 'octopi')

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

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

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

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

table_exists?(:developers)