класс ActiveRecord::ConnectionAdapters::Table
Представляет SQL таблицу абстрактным образом для обновления таблицы. Также см. TableDefinition и connection.create_table
Доступные преобразования:
change_table :table do |t| t.primary_key t.column t.index t.rename_index t.timestamps t.change t.change_default t.rename t.references t.belongs_to t.string t.text t.integer t.bigint t.float t.decimal t.numeric t.datetime t.timestamp t.time t.date t.binary t.boolean t.foreign_key t.json t.virtual t.remove t.remove_references t.remove_belongs_to t.remove_index t.remove_timestamps end
Атрибуты
Публичные методы класса
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 516 def initialize(table_name, base) @name = table_name @base = base end
Публичные методы экземпляра
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 586
def change(column_name, type, options = {})
@base.change_column(name, column_name, type, options)
end Изменяет определение столбца в соответствии с новыми параметрами.
t.change(:name, :string, limit: 80) t.change(:description, :text)
См. ActiveRecord::ConnectionAdapters::TableDefinition#column для подробностей о доступных параметрах.
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 597 def change_default(column_name, default_or_changes) @base.change_column_default(name, column_name, default_or_changes) end
Устанавливает новое значение по умолчанию для столбца.
t.change_default(:qualification, 'new') t.change_default(:authorized, 1) t.change_default(:status, from: nil, to: "draft")
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 526
def column(column_name, type, options = {})
@base.add_column(name, column_name, type, options)
end Добавляет новый столбец в указанную таблицу.
t.column(:name, :string)
См. ActiveRecord::ConnectionAdapters::TableDefinition#column для подробностей о доступных параметрах.
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 535
def column_exists?(column_name, type = nil, options = {})
@base.column_exists?(name, column_name, type, options)
end Проверяет наличие столбца.
t.string(:name) unless t.column_exists?(:name, :string)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 671 def foreign_key(*args) @base.add_foreign_key(name, *args) end
Добавляет внешний ключ.
t.foreign_key(:authors)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 680 def foreign_key_exists?(*args) @base.foreign_key_exists?(name, *args) end
Проверяет наличие внешнего ключа.
t.foreign_key(:authors) unless t.foreign_key_exists?(:authors)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 547
def index(column_name, options = {})
@base.add_index(name, column_name, options)
end Добавляет новый индекс в таблицу. column_name может быть одним символом или массивом символов.
t.index(:name) t.index([:branch_id, :party_id], unique: true) t.index([:branch_id, :party_id], unique: true, name: 'by_branch_party')
См. connection.add_index для подробностей о доступных параметрах.
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 558
def index_exists?(column_name, options = {})
@base.index_exists?(name, column_name, options)
end Проверяет наличие индекса.
unless t.index_exists?(:branch_id) t.index(:branch_id) end
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 646
def references(*args, **options)
args.each do |ref_name|
@base.add_reference(name, ref_name, options)
end
end Добавляет ссылку.
t.references(:user) t.belongs_to(:supplier, foreign_key: true)
См. connection.add_reference для подробностей о доступных параметрах.
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 607 def remove(*column_names) @base.remove_columns(name, *column_names) end
Удаляет столбец(ы) из определения таблицы.
t.remove(:qualification) t.remove(:qualification, :experience)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 618
def remove_index(options = {})
@base.remove_index(name, options)
end Удаляет указанный индекс из таблицы.
t.remove_index(:branch_id) t.remove_index(column: [:branch_id, :party_id]) t.remove_index(name: :by_branch_party)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 659
def remove_references(*args, **options)
args.each do |ref_name|
@base.remove_reference(name, ref_name, options)
end
end Удаляет ссылку. При необходимости удаляет столбец type.
t.remove_references(:user) t.remove_belongs_to(:supplier, polymorphic: true)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 627
def remove_timestamps(options = {})
@base.remove_timestamps(name, options)
end Удаляет столбцы временных меток (created_at и updated_at) из таблицы.
t.remove_timestamps
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 636 def rename(column_name, new_column_name) @base.rename_column(name, column_name, new_column_name) end
Переименовывает столбец.
t.rename(:description, :name)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 567 def rename_index(index_name, new_index_name) @base.rename_index(name, index_name, new_index_name) end
Переименовывает указанный индекс в таблице.
t.rename_index(:user_id, :account_id)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 576
def timestamps(options = {})
@base.add_timestamps(name, options)
end Добавляет столбцы временных меток (created_at и updated_at) в таблицу.
t.timestamps(null: false)
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.