Spec-Zone.ru › Ruby on Rails 4.1

class ActiveRecord::ConnectionAdapters::Table

Parent:
Объект

Представляет SQL таблицу абстрактным образом для обновления таблицы. Также см. TableDefinition и ActiveRecord::ConnectionAdapters::SchemaStatements#create_table

Доступные преобразования:

change_table :table do |t|
  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.float
  t.decimal
  t.datetime
  t.timestamp
  t.time
  t.date
  t.binary
  t.boolean
  t.remove
  t.remove_references
  t.remove_belongs_to
  t.remove_index
  t.remove_timestamps
end

Публичные методы класса

new(table_name, base) Показать исходный код
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 350
def initialize(table_name, base)
  @table_name = table_name
  @base = base
end

Публичные методы экземпляра

belongs_to(*args)
Псевдоним для: references
change(column_name, type, options = {}) Показать исходный код

Изменяет определение столбца в соответствии с новыми параметрами. Подробную информацию о параметрах, которые вы можете использовать, см. в ActiveRecord::ConnectionAdapters::TableDefinition#column.

t.change(:name, :string, limit: 80)
t.change(:description, :text)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 406
def change(column_name, type, options = {})
  @base.change_column(@table_name, column_name, type, options)
end
change_default(column_name, default) Показать исходный код

Устанавливает новое значение по умолчанию для столбца. См. ActiveRecord::ConnectionAdapters::SchemaStatements#change_column_default

t.change_default(:qualification, 'new')
t.change_default(:authorized, 1)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 414
def change_default(column_name, default)
  @base.change_column_default(@table_name, column_name, default)
end
column(column_name, type, options = {}) Показать исходный код

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

Создание простого столбца
t.column(:name, :string)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 360
def column(column_name, type, options = {})
  @base.add_column(@table_name, column_name, type, options)
end
column_exists?(column_name, type = nil, options = {}) Показать исходный код

Проверяет, существует ли столбец. См. ActiveRecord::ConnectionAdapters::SchemaStatements#column_exists?

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 365
def column_exists?(column_name, type = nil, options = {})
  @base.column_exists?(@table_name, column_name, type, options)
end
index(column_name, options = {}) Показать исходный код

Добавляет новый индекс в таблицу. column_name может быть одним символом или массивом символов. См. ActiveRecord::ConnectionAdapters::SchemaStatements#add_index

Создание простого индекса
t.index(:name)
Создание уникального индекса
t.index([:branch_id, :party_id], unique: true)
Создание индекса с именем
t.index([:branch_id, :party_id], unique: true, name: 'by_branch_party')
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 378
def index(column_name, options = {})
  @base.add_index(@table_name, column_name, options)
end
index_exists?(column_name, options = {}) Показать исходный код

Проверяет, существует ли индекс. См. ActiveRecord::ConnectionAdapters::SchemaStatements#index_exists?

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 383
def index_exists?(column_name, options = {})
  @base.index_exists?(@table_name, column_name, options)
end
references(*args) Показать исходный код

Добавляет ссылку. При необходимости добавляет столбец type, если задан параметр :polymorphic. references и belongs_to допустимы.

t.references(:user)
t.belongs_to(:supplier, polymorphic: true)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 460
def references(*args)
  options = args.extract_options!
  args.each do |ref_name|
    @base.add_reference(@table_name, ref_name, options)
  end
end
Также псевдоним для: belongs_to
remove(*column_names) Показать исходный код

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

t.remove(:qualification)
t.remove(:qualification, :experience)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 422
def remove(*column_names)
  @base.remove_columns(@table_name, *column_names)
end
remove_belongs_to(*args)
Псевдоним для: remove_references
remove_index(options = {}) Показать исходный код

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

Удалить индекс_table_name_on_column в таблице table_name
t.remove_index :column
Удалить индекс с именем index_table_name_on_branch_id в таблице table_name
t.remove_index column: :branch_id
Удалить индекс с именем index_table_name_on_branch_id_and_party_id в таблице table_name
t.remove_index column: [:branch_id, :party_id]
Удалить индекс с именем by_branch_party в таблице table_name
t.remove_index name: :by_branch_party
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 436
def remove_index(options = {})
  @base.remove_index(@table_name, options)
end
remove_references(*args) Показать исходный код

Удаляет ссылку. При необходимости удаляет столбец type. remove_references и remove_belongs_to допустимы.

t.remove_references(:user)
t.remove_belongs_to(:supplier, polymorphic: true)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 474
def remove_references(*args)
  options = args.extract_options!
  args.each do |ref_name|
    @base.remove_reference(@table_name, ref_name, options)
  end
end
Также псевдоним для: remove_belongs_to
remove_timestamps() Показать исходный код

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

t.remove_timestamps
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 443
def remove_timestamps
  @base.remove_timestamps(@table_name)
end
rename(column_name, new_column_name) Показать исходный код

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

t.rename(:description, :name)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 450
def rename(column_name, new_column_name)
  @base.rename_column(@table_name, column_name, new_column_name)
end
rename_index(index_name, new_index_name) Показать исходный код

Переименовывает указанный индекс в таблице.

t.rename_index(:user_id, :account_id)
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 390
def rename_index(index_name, new_index_name)
  @base.rename_index(@table_name, index_name, new_index_name)
end
timestamps(options = {}) Показать исходный код

Добавляет столбцы временных меток (created_at и updated_at) в таблицу. См. ActiveRecord::ConnectionAdapters::SchemaStatements#add_timestamps

t.timestamps
# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 397
def timestamps(options = {})
  @base.add_timestamps(@table_name, options)
end

© 2004–2016 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API