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

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

Добавить новый type столбец с именем column_name к table_name.

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

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

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

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

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

• :null - Разрешает или запрещает значения NULL в столбце.

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

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

• :comment - Указывает комментарий для столбца. Этот параметр игнорируется некоторыми бэкендами.

Примечание: Точность — это общее количество значащих цифр, а масштаб — количество цифр, которые могут быть сохранены после десятичной точки. Например, число 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..бесконечность]. Значение по умолчанию отсутствует.

• 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).

Примеры

add_column(:users, :picture, :binary, limit: 2.megabytes)
# ALTER TABLE "users" ADD "picture" blob(2097152)

add_column(:articles, :status, :string, limit: 20, default: 'draft', null: false)
# ALTER TABLE "articles" ADD "status" varchar(20) DEFAULT 'draft' NOT NULL

add_column(:answers, :bill_gates_money, :decimal, precision: 15, scale: 2)
# ALTER TABLE "answers" ADD "bill_gates_money" decimal(15,2)

add_column(:measurements, :sensor_reading, :decimal, precision: 30, scale: 20)
# ALTER TABLE "measurements" ADD "sensor_reading" decimal(30,20)

# While :scale defaults to zero on most databases, it
# probably wouldn't hurt to include it.
add_column(:measurements, :huge_integer, :decimal, precision: 30)
# ALTER TABLE "measurements" ADD "huge_integer" decimal(30)

# Defines a column that stores an array of a type.
add_column(:users, :skills, :text, array: true)
# ALTER TABLE "users" ADD "skills" text[]

# Defines a column with a database-specific type.
add_column(:shapes, :triangle, 'polygon')
# ALTER TABLE "shapes" ADD "triangle" polygon

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

  options = foreign_key_options(from_table, to_table, options)
  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>. identifier — строка длиной 10 символов, которая генерируется детерминированно из from_table и column. Можно указать имя вручную с помощью параметра :name.

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

add_foreign_key :articles, :authors

генерирует:

ALTER TABLE "articles" ADD CONSTRAINT fk_rails_e74ce85cbc 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 fk_rails_e74ce85cbc 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

Действие, выполняемое ON DELETE. Допустимые значения — :nullify, :cascade и :restrict

:on_update

Действие, выполняемое ON UPDATE. Допустимые значения — :nullify, :cascade и :restrict

:validate

(Только Postgres) Указывает, будет ли ограничение проверяться. Значение по умолчанию — true.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 763
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 поддерживает порядок сортировки индекса начиная с версии 8.0.1 (более ранние версии принимали синтаксис, но игнорировали его).

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

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, using: 'gist', opclass: :gist_trgm_ops)
# CREATE INDEX developers_on_name ON developers USING gist (name gist_trgm_ops) -- PostgreSQL

add_index(:developers, [:name, :city], using: 'gist', opclass: { city: :gist_trgm_ops })
# CREATE INDEX developers_on_name_and_city ON developers USING gist (name, city gist_trgm_ops) -- PostgreSQL

add_index(:developers, [:name, :city], using: 'gist', opclass: :gist_trgm_ops)
# CREATE INDEX developers_on_name_and_city ON developers USING gist (name gist_trgm_ops, city gist_trgm_ops) -- PostgreSQL

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

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

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

генерирует:

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 873
def add_reference(table_name, ref_name, **options)
  ReferenceDefinition.new(ref_name, options).add_to(update_table_definition(table_name, self))
end

Добавляет ссылку. Столбец ссылки по умолчанию — bigint, опция :type может быть использована для указания другого типа. По желанию добавляется столбец _type, если указана опция :polymorphic. add_reference и add_belongs_to допустимы.

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

:type

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

:index

Добавить соответствующий индекс. По умолчанию true. См. add_index для использования этой опции.

:foreign_key

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

:polymorphic

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

:null

Разрешить значения NULL для столбца. По умолчанию true.

Создать столбец user_id типа bigint

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)

Создать столбец supplier_id с уникальным индексом

add_reference(:products, :supplier, index: { unique: true })

Создать столбец supplier_id с именованным индексом

add_reference(:products, :supplier, index: { name: "my_supplier_index" })

Создать столбец supplier_id и соответствующее внешнее ключевое ограничение

add_reference(:products, :supplier, foreign_key: true)

Создать столбец supplier_id и внешнее ключевое ограничение для таблицы firms

add_reference(:products, :supplier, foreign_key: {to_table: :firms})

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1115
def add_timestamps(table_name, options = {})
  options[:null] = false if options[:null].nil?

  add_column table_name, :created_at, :datetime, options
  add_column table_name, :updated_at, :datetime, options
end

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

add_timestamps(:suppliers, null: true)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 612
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 1177
def change_column_comment(table_name, column_name, comment)
  raise NotImplementedError, "#{self.class} does not support changing column comments"
end

Изменяет комментарий к столбцу или удаляет его, если nil.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 630
def change_column_default(table_name, column_name, default_or_changes)
  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)

Передача хэша, содержащего :from и :to, сделает это изменение обратимым в миграции:

change_column_default(:posts, :state, from: nil, to: "draft")

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

Блок для изменения столбцов в 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, ADD COLUMN birthdate DATETIME ...

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

Поддерживается только для адаптеров MySQL и PostgreSQL, в других случаях игнорируется.

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

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(bigint).

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1172
def change_table_comment(table_name, comment)
  raise NotImplementedError, "#{self.class} does not support changing table comments"
end

Изменяет комментарий к таблице или удаляет его, если nil.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 132
def column_exists?(table_name, column_name, type = nil, options = {})
  column_name = column_name.to_s
  checks = []
  checks << lambda { |c| c.name == column_name }
  checks << lambda { |c| c.type == type } if type
  column_options_keys.each do |attr|
    checks << lambda { |c| c.send(attr) == options[attr] } if options.key?(attr)
  end

  columns(table_name).any? { |c| checks.all? { |check| check[c] } }
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 111
def columns(table_name)
  table_name = table_name.to_s
  column_definitions(table_name).map do |field|
    new_column_from_field(table_name, field)
  end
end

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

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

  column_options.reverse_merge!(null: false, index: false)

  t1_ref, t2_ref = [table_1, table_2].map { |t| t.to_s.singularize }

  create_table(join_table_name, options.merge!(id: false)) do |td|
    td.references t1_ref, column_options
    td.references t2_ref, column_options
    yield td if block_given?
  end
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 bigint NOT NULL,
  part_id bigint NOT NULL,
) ENGINE=InnoDB DEFAULT CHARSET=utf8

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 290
def create_table(table_name, comment: nil, **options)
  td = create_table_definition table_name, options[:temporary], options[:options], options[:as], comment: comment

  if options[:id] != false && !options[:as]
    pk = options.fetch(:primary_key) do
      Base.get_primary_key table_name.to_s.singularize
    end

    if pk.is_a?(Array)
      td.primary_keys pk
    else
      td.primary_key pk, options.fetch(:id, :primary_key), options
    end
  end

  yield td if block_given?

  if options[:force]
    drop_table(table_name, **options, if_exists: true)
  end

  result = execute schema_creation.accept td

  unless supports_indexes_in_create?
    td.indexes.each do |column_name, index_options|
      add_index(table_name, column_name, index_options)
    end
  end

  if supports_comments? && !supports_comments_in_create?
    change_table_comment(table_name, comment) if comment.present?

    td.columns.each do |column|
      change_column_comment(table_name, column.name, column.comment) if column.comment.present?
    end
  end

  result
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. Таблицы связи для ActiveRecord::Base.has_and_belongs_to_many должны устанавливать его в false.

Можно использовать символ (Symbol) для указания типа столбца первичного ключа.

:primary_key

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

Если передаётся массив, создаётся составной первичный ключ.

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

:options

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

:temporary

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

:force

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

:as

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

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

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

генерирует:

CREATE TABLE suppliers (
  id bigint 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 bigint auto_increment PRIMARY KEY,
  name varchar(80)
)

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

create_table(:tags, id: :string) do |t|
  t.column :label, :string
end

генерирует:

CREATE TABLE tags (
  id varchar PRIMARY KEY,
  label varchar
)

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

create_table(:orders, primary_key: [:product_id, :client_id]) do |t|
  t.belongs_to :product
  t.belongs_to :client
end

генерирует:

CREATE TABLE order (
    product_id bigint NOT NULL,
    client_id bigint NOT NULL
);

ALTER TABLE ONLY "orders"
  ADD CONSTRAINT orders_pkey PRIMARY KEY (product_id, client_id);

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

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

генерирует:

CREATE TABLE categories_suppliers (
  category_id bigint,
  supplier_id bigint
)

Создание временной таблицы на основе запроса

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 45
def data_source_exists?(name)
  query_values(data_source_sql(name), "SCHEMA").any? if name.present?
rescue NotImplementedError
  data_sources.include?(name.to_s)
end

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

data_source_exists?(:ebooks)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 35
def data_sources
  query_values(data_source_sql, "SCHEMA")
rescue NotImplementedError
  tables | views
end

Возвращает имена отношений, используемых для поддержки моделей Active Record. Для большинства адаптеров это все таблицы (tables) и представления (views).

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 495
def drop_table(table_name, options = {})
  execute "DROP TABLE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(table_name)}"
end

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

:force

Установить в :cascade , чтобы также удалить зависимые объекты. По умолчанию false.

:if_exists

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1010
def foreign_key_exists?(from_table, options_or_to_table = {})
  foreign_key_for(from_table, options_or_to_table).present?
end

Проверяет, существует ли внешний ключ в таблице для заданного определения внешнего ключа.

# Checks to see if a foreign key exists.
foreign_key_exists?(:accounts, :branches)

# Checks to see if a foreign key on a specified column exists.
foreign_key_exists?(:accounts, column: :owner_id)

# Checks to see if a foreign key with a custom name exists.
foreign_key_exists?(:accounts, name: "special_fk_name")

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

Возвращает массив внешних ключей для заданной таблицы. Внешние ключи представлены объектами ForeignKeyDefinition.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 100
def index_exists?(table_name, column_name, options = {})
  column_names = Array(column_name).map(&:to_s)
  checks = []
  checks << lambda { |i| i.columns == column_names }
  checks << lambda { |i| i.unique } if options[:unique]
  checks << lambda { |i| i.name == options[:name].to_s } if options[:name]

  indexes(table_name).any? { |i| checks.all? { |check| check[i] } }
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 822
def index_name_exists?(table_name, index_name)
  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 82
def indexes(table_name)
  raise NotImplementedError, "#indexes is not implemented"
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 145
def primary_key(table_name)
  pk = primary_keys(table_name)
  pk = pk.first unless pk.size > 1
  pk
end

Возвращает только первичный ключ таблицы.

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

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

remove_column(:suppliers, :qualification)

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 588
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 988
def remove_foreign_key(from_table, options_or_to_table = {})
  return unless supports_foreign_keys?

  fk_name_to_delete = foreign_key_for!(from_table, options_or_to_table).name

  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

Хеш options принимает те же ключи, что и #add_foreign_key.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 786
def remove_index(table_name, options = {})
  index_name = index_name_for_remove(table_name, options)
  execute "DROP INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)}"
end

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

Удаляет индекс на branch_id в таблице accounts, если такой индекс существует ровно один.

remove_index :accounts, :branch_id

Удаляет индекс на branch_id в таблице accounts, если такой индекс существует ровно один.

remove_index :accounts, column: :branch_id

Удаляет индекс на branch_id и 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 893
def remove_reference(table_name, ref_name, foreign_key: false, polymorphic: false, **options)
  if foreign_key
    reference_name = Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
    if foreign_key.is_a?(Hash)
      foreign_key_options = foreign_key
    else
      foreign_key_options = { to_table: reference_name }
    end
    foreign_key_options[:column] ||= "#{ref_name}_id"
    remove_foreign_key(table_name, **foreign_key_options)
  end

  remove_column(table_name, "#{ref_name}_id")
  remove_column(table_name, "#{ref_name}_type") if polymorphic
end

Удаляет ссылку(и). Также удаляет столбец type, если он существует. remove_reference и 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 1126
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 658
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 797
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 (PostgreSQL, 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 479
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 29
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 24
def table_comment(table_name)
  nil
end

Возвращает комментарий к таблице, хранящийся в метаданных базы данных.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 60
def table_exists?(table_name)
  query_values(data_source_sql(table_name, type: "BASE TABLE"), "SCHEMA").any? if table_name.present?
rescue NotImplementedError
  tables.include?(table_name.to_s)
end

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

table_exists?(:developers)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 52
def tables
  query_values(data_source_sql(type: "BASE TABLE"), "SCHEMA")
end

Возвращает массив имён таблиц, определённых в базе данных.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 75
def view_exists?(view_name)
  query_values(data_source_sql(view_name, type: "VIEW"), "SCHEMA").any? if view_name.present?
rescue NotImplementedError
  views.include?(view_name.to_s)
end

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

view_exists?(:ebooks)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 67
def views
  query_values(data_source_sql(type: "VIEW"), "SCHEMA")
end

Возвращает массив имён представлений, определённых в базе данных.