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
Methods
B
C
I
N
R
T
Class Public methods
new(table_name, base)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 328
328:       def initialize(table_name, base)
329:         @table_name = table_name
330:         @base = base
331:       end
Instance Public methods
belongs_to(*args)

Alias for references

change(column_name, type, options = {})

Changes the column’s definition according to the new options. See TableDefinition#column for details of the options you can use.

Examples
 t.change(:name, :string, :limit => 80)
 t.change(:description, :text)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 378
378:       def change(column_name, type, options = {})
379:         @base.change_column(@table_name, column_name, type, options)
380:       end
change_default(column_name, default)

Sets a new default value for a column. See SchemaStatements#change_column_default

Examples
 t.change_default(:qualification, 'new')
 t.change_default(:authorized, 1)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 386
386:       def change_default(column_name, default)
387:         @base.change_column_default(@table_name, column_name, default)
388:       end
column(column_name, type, options = {})

Adds a new column to the named table. See TableDefinition#column for details of the options you can use.

Example
Creating a simple column
 t.column(:name, :string)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 338
338:       def column(column_name, type, options = {})
339:         @base.add_column(@table_name, column_name, type, options)
340:       end
column_exists?(column_name, type = nil, options = {})

Checks to see if a column exists. See SchemaStatements#column_exists?

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 343
343:       def column_exists?(column_name, type = nil, options = {})
344:         @base.column_exists?(@table_name, column_name, type, options)
345:       end
index(column_name, options = {})

Adds a new index to the table. column_name can be a single Symbol, or an Array of Symbols. See SchemaStatements#add_index

Examples
Creating a simple index
 t.index(:name)
Creating a unique index
 t.index([:branch_id, :party_id], :unique => true)
Creating a named index
 t.index([:branch_id, :party_id], :unique => true, :name => 'by_branch_party')

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 357
357:       def index(column_name, options = {})
358:         @base.add_index(@table_name, column_name, options)
359:       end
index_exists?(column_name, options = {})

Checks to see if an index exists. See SchemaStatements#index_exists?

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 362
362:       def index_exists?(column_name, options = {})
363:         @base.index_exists?(@table_name, column_name, options)
364:       end
references(*args)

Adds a reference. Optionally adds a type column, if :polymorphic option is provided. references and belongs_to are acceptable.

Examples
 t.references(:goat)
 t.references(:goat, :polymorphic => true)
 t.belongs_to(:goat)
This method is also aliased as belongs_to

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 433
433:       def references(*args)
434:         options = args.extract_options!
435:         polymorphic = options.delete(:polymorphic)
436:         args.each do |col|
437:           @base.add_column(@table_name, "#{col}_id", :integer, options)
438:           @base.add_column(@table_name, "#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) unless polymorphic.nil?
439:         end
440:       end
remove(*column_names)

Removes the column(s) from the table definition.

Examples
 t.remove(:qualification)
 t.remove(:qualification, :experience)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 394
394:       def remove(*column_names)
395:         @base.remove_column(@table_name, column_names)
396:       end
remove_belongs_to(*args)

Alias for remove_references

remove_index(options = {})

Removes the given index from the table.

Examples
Remove the index_table_name_on_column in the table_name table
  t.remove_index :column
Remove the index named index_table_name_on_branch_id in the table_name table
  t.remove_index :column => :branch_id
Remove the index named index_table_name_on_branch_id_and_party_id in the table_name table
  t.remove_index :column => [:branch_id, :party_id]
Remove the index named by_branch_party in the table_name table
  t.remove_index :name => :by_branch_party

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 409
409:       def remove_index(options = {})
410:         @base.remove_index(@table_name, options)
411:       end
remove_references(*args)

Removes a reference. Optionally removes a type column. remove_references and remove_belongs_to are acceptable.

Examples
 t.remove_references(:goat)
 t.remove_references(:goat, :polymorphic => true)
 t.remove_belongs_to(:goat)
This method is also aliased as remove_belongs_to

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 449
449:       def remove_references(*args)
450:         options = args.extract_options!
451:         polymorphic = options.delete(:polymorphic)
452:         args.each do |col|
453:           @base.remove_column(@table_name, "#{col}_id")
454:           @base.remove_column(@table_name, "#{col}_type") unless polymorphic.nil?
455:         end
456:       end
remove_timestamps()

Removes the timestamp columns (created_at and updated_at) from the table.

Example
 t.remove_timestamps

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 416
416:       def remove_timestamps
417:         @base.remove_timestamps(@table_name)
418:       end
rename(column_name, new_column_name)

Renames a column.

Example
 t.rename(:description, :name)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 423
423:       def rename(column_name, new_column_name)
424:         @base.rename_column(@table_name, column_name, new_column_name)
425:       end
timestamps()

Adds timestamps (created_at and updated_at) columns to the table. See SchemaStatements#add_timestamps

Example
 t.timestamps

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 369
369:       def timestamps
370:         @base.add_timestamps(@table_name)
371:       end