Parent

Files

Class Index [+]

Quicksearch

ActiveRecord::ConnectionAdapters::Table

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

Public Class Methods

new(table_name, base) click to toggle source
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 573
573:       def initialize(table_name, base)
574:         @table_name = table_name
575:         @base = base
576:       end

Public Instance Methods

belongs_to(*args) click to toggle source
Alias for: references
change(column_name, type, options = {}) click to toggle source

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)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 623
623:       def change(column_name, type, options = {})
624:         @base.change_column(@table_name, column_name, type, options)
625:       end
change_default(column_name, default) click to toggle source

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

Examples
 t.change_default(:qualification, 'new')
 t.change_default(:authorized, 1)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 631
631:       def change_default(column_name, default)
632:         @base.change_column_default(@table_name, column_name, default)
633:       end
column(column_name, type, options = {}) click to toggle source

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)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 583
583:       def column(column_name, type, options = {})
584:         @base.add_column(@table_name, column_name, type, options)
585:       end
column_exists?(column_name, type = nil, options = nil) click to toggle source

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

     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 588
588:       def column_exists?(column_name, type = nil, options = nil)
589:         @base.column_exists?(@table_name, column_name, type, options)
590:       end
index(column_name, options = {}) click to toggle source

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')
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 602
602:       def index(column_name, options = {})
603:         @base.add_index(@table_name, column_name, options)
604:       end
index_exists?(column_name, options = {}) click to toggle source

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

     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 607
607:       def index_exists?(column_name, options = {})
608:         @base.index_exists?(@table_name, column_name, options)
609:       end
references(*args) click to toggle source

Adds a reference. Optionally adds a type column. references and belongs_to are acceptable.

Examples
 t.references(:goat)
 t.references(:goat, :polymorphic => true)
 t.belongs_to(:goat)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 678
678:       def references(*args)
679:         options = args.extract_options!
680:         polymorphic = options.delete(:polymorphic)
681:         args.each do |col|
682:           @base.add_column(@table_name, "#{col}_id", :integer, options)
683:           @base.add_column(@table_name, "#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) unless polymorphic.nil?
684:         end
685:       end
Also aliased as: belongs_to
remove(*column_names) click to toggle source

Removes the column(s) from the table definition.

Examples
 t.remove(:qualification)
 t.remove(:qualification, :experience)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 639
639:       def remove(*column_names)
640:         @base.remove_column(@table_name, column_names)
641:       end
remove_belongs_to(*args) click to toggle source
Alias for: remove_references
remove_index(options = {}) click to toggle source

Removes the given index from the table.

Examples
Remove the suppliers_name_index in the suppliers table
  t.remove_index :name
Remove the index named accounts_branch_id_index in the accounts table
  t.remove_index :column => :branch_id
Remove the index named accounts_branch_id_party_id_index in the accounts table
  t.remove_index :column => [:branch_id, :party_id]
Remove the index named by_branch_party in the accounts table
  t.remove_index :name => :by_branch_party
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 654
654:       def remove_index(options = {})
655:         @base.remove_index(@table_name, options)
656:       end
remove_references(*args) click to toggle source

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)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 694
694:       def remove_references(*args)
695:         options = args.extract_options!
696:         polymorphic = options.delete(:polymorphic)
697:         args.each do |col|
698:           @base.remove_column(@table_name, "#{col}_id")
699:           @base.remove_column(@table_name, "#{col}_type") unless polymorphic.nil?
700:         end
701:       end
Also aliased as: remove_belongs_to
remove_timestamps() click to toggle source

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

Example
 t.remove_timestamps
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 661
661:       def remove_timestamps
662:         @base.remove_timestamps(@table_name)
663:       end
rename(column_name, new_column_name) click to toggle source

Renames a column.

Example
 t.rename(:description, :name)
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 668
668:       def rename(column_name, new_column_name)
669:         @base.rename_column(@table_name, column_name, new_column_name)
670:       end
timestamps() click to toggle source

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

Example
 t.timestamps
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 614
614:       def timestamps
615:         @base.add_timestamps(@table_name)
616:       end

Private Instance Methods

native() click to toggle source
     # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 732
732:         def native
733:           @base.native_database_types
734:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.