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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1152
def add_check_constraint(table_name, expression, **options)
  return unless supports_check_constraints?

  options = check_constraint_options(table_name, expression, options)
  at = create_alter_table(table_name)
  at.add_check_constraint(expression, options)

  execute schema_creation.accept(at)
end

Добавляет новое ограничение проверки в таблицу. expression — это представление String проверяемого булевого условия.

add_check_constraint :products, "price > 0", name: "price_check"

генерирует:

ALTER TABLE "products" ADD CONSTRAINT price_check CHECK (price > 0)

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

:name

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

:validate

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 606
def add_column(table_name, column_name, type, **options)
  return if options[:if_not_exists] == true && column_exists?(table_name, column_name, type)

  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, :datetime, и :time.

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

• :collation — указывает кодировку для столбца :string или :text.

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

• :if_not_exists — указывает, что столбец уже существует, чтобы не пытаться его повторно добавить. Это поможет избежать ошибок дублирования столбцов.

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

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

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

• 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

# Ignores the method call if the column exists
add_column(:shapes, :triangle, 'polygon', if_not_exists: true)

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 835
def add_index(table_name, column_name, **options)
  index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)

  create_index = CreateIndexDefinition.new(index, algorithm, if_not_exists)
  execute schema_creation.accept(create_index)
end

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

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

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

add_index(:suppliers, :name)

генерирует:

CREATE INDEX index_suppliers_on_name ON suppliers(name)

Создание индекса, который уже существует

add_index(:suppliers, :name, if_not_exists: true)

генерирует:

CREATE INDEX IF NOT EXISTS index_suppliers_on_name ON suppliers(name)

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

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

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

генерирует:

CREATE UNIQUE INDEX index_accounts_on_branch_id_and_party_id 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], name: 'by_branch_desc_party', 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.

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

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.

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

add_index(:developers, :name, algorithm: :concurrently)
# CREATE INDEX CONCURRENTLY developers_on_name on developers (name)

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

Одновременное добавление индекса не поддерживается в транзакции.

Для получения дополнительной информации см. раздел “Транзакционные миграции”.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 972
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, передайте true для добавления. В случае, если таблицу объединения нельзя вывести из ассоциации, передайте :to_table с соответствующим именем таблицы.

:polymorphic

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

:null

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

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

add_reference(:products, :user, index: false)

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

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

Создать столбцы supplier_id, supplier_type

add_reference(:products, :supplier, polymorphic: 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 1264
def add_timestamps(table_name, **options)
  options[:null] = false if options[:null].nil?

  if !options.key?(:precision) && supports_datetime_with_precision?
    options[:precision] = 6
  end

  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 663
def change_column(table_name, column_name, type, **options)
  raise NotImplementedError, "change_column is not implemented"
end

Изменяет определение столбца в соответствии с новыми параметрами. См. 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 1347
def change_column_comment(table_name, column_name, comment_or_changes)
  raise NotImplementedError, "#{self.class} does not support changing column comments"
end

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

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

change_column_comment(:posts, :state, from: "old_comment", to: "new_comment")

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

Изменить тип столбца

change_table(:suppliers) do |t|
  t.change :metadata, :json
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

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

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

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

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

change_table_comment(:posts, from: "old_comment", to: "new_comment")

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1134
def check_constraints(table_name)
  raise NotImplementedError
end

Возвращает массив ограничений проверки для данной таблицы. Ограничения проверки представлены как объекты CheckConstraintDefinition.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 135
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.to_sym rescue nil } 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 114
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 381
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 ()

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 296
def create_table(table_name, id: :primary_key, primary_key: nil, force: nil, **options)
  td = create_table_definition(table_name, **extract_table_options!(options))

  if id && !td.as
    pk = primary_key || Base.get_primary_key(table_name.to_s.singularize)

    if id.is_a?(Hash)
      options.merge!(id.except(:type))
      id = id.fetch(:type, :primary_key)
    end

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

  yield td if block_given?

  if force
    drop_table(table_name, force: force, if_exists: true)
  else
    schema_cache.clear_data_source_cache!(table_name.to_s)
  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, if_not_exists: td.if_not_exists)
    end
  end

  if supports_comments? && !supports_comments_in_create?
    if table_comment = td.comment.presence
      change_table_comment(table_name, table_comment)
    end

    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.

:if_not_exists

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

:as

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

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

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

генерирует:

CREATE TABLE suppliers (
  id bigint auto_increment PRIMARY KEY
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 44
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 34
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 401
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 514
def drop_table(table_name, **options)
  schema_cache.clear_data_source_cache!(table_name.to_s)
  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 1116
def foreign_key_exists?(from_table, to_table = nil, **options)
  foreign_key_for(from_table, to_table: to_table, **options).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 1011
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 99
def index_exists?(table_name, column_name, **options)
  checks = []

  if column_name.present?
    column_names = Array(column_name).map(&:to_s)
    checks << lambda { |i| Array(i.columns) == column_names }
  end

  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 919
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 81
def indexes(table_name)
  raise NotImplementedError, "#indexes is not implemented"
end

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 148
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 1175
def remove_check_constraint(table_name, expression = nil, **options)
  return unless supports_check_constraints?

  chk_name_to_delete = check_constraint_for!(table_name, expression: expression, **options).name

  at = create_alter_table(table_name)
  at.drop_check_constraint(chk_name_to_delete)

  execute schema_creation.accept(at)
end

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

remove_check_constraint :products, name: "price_check"

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 651
def remove_column(table_name, column_name, type = nil, **options)
  return if options[:if_exists] == true && !column_exists?(table_name, column_name)

  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. Индексы столбца автоматически удаляются.

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

remove_column(:suppliers, :qualification, if_exists: true)

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

  column_names.each do |column_name|
    remove_column(table_name, column_name, type, **options)
  end
end

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

remove_columns(:suppliers, :qualification, :experience)

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

remove_columns(:suppliers, :qualification, :experience, type: :string, null: false)

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1094
def remove_foreign_key(from_table, to_table = nil, **options)
  return unless supports_foreign_keys?

  fk_name_to_delete = foreign_key_for!(from_table, to_table: to_table, **options).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

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

remove_foreign_key :accounts, to_table: :owners

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

remove_foreign_key :accounts, name: :special_fk_name

Хэш options принимает те же ключи, что и SchemaStatements#add_foreign_key, с добавлением

:to_table

Имя таблицы, содержащей ссылаемый первичный ключ.

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 878
def remove_index(table_name, column_name = nil, **options)
  return if options[:if_exists] && !index_exists?(table_name, column_name, **options)

  index_name = index_name_for_remove(table_name, column_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

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

remove_index :accounts, :branch_id, name: :by_branch_party

Проверяет существование индекса перед попыткой его удалить. Будет молча игнорировать индексы, которые не существуют.

remove_index :accounts, if_exists: true

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

remove_index :accounts, name: :by_branch_party, algorithm: :concurrently

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

Одновременное удаление индекса не поддерживается в транзакции.

Для получения дополнительной информации см. раздел “Транзакционные миграции”.

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 1279
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 709
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 892
def rename_index(table_name, old_name, new_name)
  old_name = old_name.to_s
  new_name = new_name.to_s
  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 498
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 28
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 23
def table_comment(table_name)
  nil
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 59
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 51
def tables
  query_values(data_source_sql(type: "BASE TABLE"), "SCHEMA")
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb, line 74
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 66
def views
  query_values(data_source_sql(type: "VIEW"), "SCHEMA")
end

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