class ActiveRecord::ConnectionAdapters::Table
Represents an SQL table in an abstract way for updating a table. Also see TableDefinition
and connection.create_table
Available transformations are:
change_table :table do |t| t.primary_key t.column t.index t.rename_index t.timestamps t.change t.change_default t.change_null t.rename t.references t.belongs_to t.check_constraint 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_foreign_key t.remove_references t.remove_belongs_to t.remove_index t.remove_check_constraint t.remove_timestamps end
Attributes
Public Class Methods
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 593 def initialize(table_name, base) @name = table_name @base = base end
Public Instance Methods
Changes the column's definition according to the new options.
t.change(:name, :string, limit: 80) t.change(:description, :text)
See TableDefinition#column
for details of the options you can use.
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 667 def change(column_name, type, **options) @base.change_column(name, column_name, type, **options) end
Sets a new default value for a column.
t.change_default(:qualification, 'new') t.change_default(:authorized, 1) t.change_default(:status, from: nil, to: "draft")
See connection.change_column_default
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 678 def change_default(column_name, default_or_changes) @base.change_column_default(name, column_name, default_or_changes) end
Sets or removes a NOT NULL constraint on a column.
t.change_null(:qualification, true) t.change_null(:qualification, false, 0)
See connection.change_column_null
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 688 def change_null(column_name, null, default = nil) @base.change_column_null(name, column_name, null, default) end
Adds a check constraint.
t.check_constraint("price > 0", name: "price_check")
See connection.add_check_constraint
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 792 def check_constraint(*args) @base.add_check_constraint(name, *args) end
Adds a new column to the named table.
t.column(:name, :string)
See TableDefinition#column
for details of the options you can use.
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 603 def column(column_name, type, index: nil, **options) @base.add_column(name, column_name, type, **options) if index index_options = index.is_a?(Hash) ? index : {} index(column_name, **index_options) end end
Checks to see if a column exists.
t.string(:name) unless t.column_exists?(:name, :string)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 616 def column_exists?(column_name, type = nil, **options) @base.column_exists?(name, column_name, type, **options) end
Adds a foreign key to the table using a supplied table name.
t.foreign_key(:authors) t.foreign_key(:authors, column: :author_id, primary_key: "id")
See connection.add_foreign_key
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 764 def foreign_key(*args, **options) @base.add_foreign_key(name, *args, **options) end
Checks to see if a foreign key exists.
t.foreign_key(:authors) unless t.foreign_key_exists?(:authors)
See connection.foreign_key_exists?
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 783 def foreign_key_exists?(*args, **options) @base.foreign_key_exists?(name, *args, **options) end
Adds a new index to the table. column_name
can be a single Symbol, or an Array of Symbols.
t.index(:name) t.index([:branch_id, :party_id], unique: true) t.index([:branch_id, :party_id], unique: true, name: 'by_branch_party')
See connection.add_index for details of the options you can use.
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 628 def index(column_name, **options) @base.add_index(name, column_name, **options) end
Checks to see if an index exists.
unless t.index_exists?(:branch_id) t.index(:branch_id) end
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 639 def index_exists?(column_name, options = {}) @base.index_exists?(name, column_name, options) end
Adds a reference.
t.references(:user) t.belongs_to(:supplier, foreign_key: true)
See connection.add_reference for details of the options you can use.
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 738 def references(*args, **options) args.each do |ref_name| @base.add_reference(name, ref_name, **options) end end
Removes the column(s) from the table definition.
t.remove(:qualification) t.remove(:qualification, :experience)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 698 def remove(*column_names, **options) @base.remove_columns(name, *column_names, **options) end
Removes the given check constraint from the table.
t.remove_check_constraint(name: "price_check")
See connection.remove_check_constraint
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 801 def remove_check_constraint(*args) @base.remove_check_constraint(name, *args) end
Removes the given foreign key from the table.
t.remove_foreign_key(:authors) t.remove_foreign_key(column: :author_id)
See connection.remove_foreign_key
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 774 def remove_foreign_key(*args, **options) @base.remove_foreign_key(name, *args, **options) end
Removes the given index from the table.
t.remove_index(:branch_id) t.remove_index(column: [:branch_id, :party_id]) t.remove_index(name: :by_branch_party) t.remove_index(:branch_id, name: :by_branch_party)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 710 def remove_index(column_name = nil, **options) @base.remove_index(name, column_name, **options) end
Removes a reference. Optionally removes a type
column.
t.remove_references(:user) t.remove_belongs_to(:supplier, polymorphic: true)
See connection.remove_reference
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 751 def remove_references(*args, **options) args.each do |ref_name| @base.remove_reference(name, ref_name, **options) end end
Removes the timestamp columns (created_at
and updated_at
) from the table.
t.remove_timestamps
See connection.remove_timestamps
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 719 def remove_timestamps(**options) @base.remove_timestamps(name, **options) end
Renames a column.
t.rename(:description, :name)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 728 def rename(column_name, new_column_name) @base.rename_column(name, column_name, new_column_name) end
Renames the given index on the table.
t.rename_index(:user_id, :account_id)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 648 def rename_index(index_name, new_index_name) @base.rename_index(name, index_name, new_index_name) end
Adds timestamps (created_at
and updated_at
) columns to the table.
t.timestamps(null: false)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 657 def timestamps(**options) @base.add_timestamps(name, **options) end