Object
Represents an SQL table in an abstract way for updating a table. Also see TableDefinition and SchemaStatements#create_table
Available transformations are:
change_table :table do |t| t.column t.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
Changes the column's definition according to the new options. See TableDefinition#column for details of the options you can use.
t.change(:name, :string, :limit => 80) t.change(:description, :text)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 377 def change(column_name, type, options = {}) @base.change_column(@table_name, column_name, type, options) end
Sets a new default value for a column. See SchemaStatements#change_column_default
t.change_default(:qualification, 'new') t.change_default(:authorized, 1)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 385 def change_default(column_name, default) @base.change_column_default(@table_name, column_name, default) end
Adds a new column to the named table. See TableDefinition#column for details of the options you can use.
t.column(:name, :string)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 337 def column(column_name, type, options = {}) @base.add_column(@table_name, column_name, type, options) end
Checks to see if a column exists. See SchemaStatements#column_exists?
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 342 def column_exists?(column_name, type = nil, options = {}) @base.column_exists?(@table_name, column_name, type, options) end
Adds a new index to the table. column_name can be a single Symbol, or an Array of Symbols. See 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 lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 356 def index(column_name, options = {}) @base.add_index(@table_name, column_name, options) end
Checks to see if an index exists. See SchemaStatements#index_exists?
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 361 def index_exists?(column_name, options = {}) @base.index_exists?(@table_name, column_name, options) end
Adds a reference. Optionally adds a type column, if :polymorphic option is provided. references and belongs_to are acceptable.
t.references(:goat) t.references(:goat, :polymorphic => true) t.belongs_to(:goat)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 432 def references(*args) options = args.extract_options! polymorphic = options.delete(:polymorphic) args.each do |col| @base.add_column(@table_name, "#{col}_id", :integer, options) @base.add_column(@table_name, "#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) unless polymorphic.nil? 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 393 def remove(*column_names) @base.remove_column(@table_name, column_names) end
Removes the given index from the table.
t.remove_index :column
t.remove_index :column => :branch_id
t.remove_index :column => [:branch_id, :party_id]
t.remove_index :name => :by_branch_party
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 408 def remove_index(options = {}) @base.remove_index(@table_name, options) end
Removes a reference. Optionally removes a type column. remove_references and remove_belongs_to are acceptable.
t.remove_references(:goat) t.remove_references(:goat, :polymorphic => true) t.remove_belongs_to(:goat)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 448 def remove_references(*args) options = args.extract_options! polymorphic = options.delete(:polymorphic) args.each do |col| @base.remove_column(@table_name, "#{col}_id") @base.remove_column(@table_name, "#{col}_type") unless polymorphic.nil? end end
Removes the timestamp columns (created_at and updated_at) from the table.
t.remove_timestamps
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 415 def remove_timestamps @base.remove_timestamps(@table_name) end
Renames a column.
t.rename(:description, :name)
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 422 def rename(column_name, new_column_name) @base.rename_column(@table_name, column_name, new_column_name) end
Adds timestamps (created_at and updated_at) columns to the table. See SchemaStatements#add_timestamps
t.timestamps
# File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 368 def timestamps @base.add_timestamps(@table_name) end
Generated with the Darkfish Rdoc Generator 2.