Class: ActiveRecord::ConnectionAdapters::Table

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/connection_adapters/abstract/schema_definitions.rb

Overview

Represents a 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

Instance Method Summary collapse

Constructor Details

#initialize(table_name, base) ⇒ Table

Returns a new instance of Table.



509
510
511
512
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 509

def initialize(table_name, base)
  @table_name = table_name
  @base = base
end

Instance Method Details

#change(column_name, type, options = {}) ⇒ Object

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)



549
550
551
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 549

def change(column_name, type, options = {})
  @base.change_column(@table_name, column_name, type, options)
end

#change_default(column_name, default) ⇒ Object

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

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



557
558
559
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 557

def change_default(column_name, default)
  @base.change_column_default(@table_name, column_name, default)
end

#column(column_name, type, options = {}) ⇒ Object

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)



519
520
521
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 519

def column(column_name, type, options = {})
  @base.add_column(@table_name, column_name, type, options)
end

#index(column_name, options = {}) ⇒ Object

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')



533
534
535
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 533

def index(column_name, options = {})
  @base.add_index(@table_name, column_name, options)
end

#references(*args) ⇒ Object Also known as: belongs_to

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)



604
605
606
607
608
609
610
611
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 604

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

#remove(*column_names) ⇒ Object

Removes the column(s) from the table definition.

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



565
566
567
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 565

def remove(*column_names)
  @base.remove_column(@table_name, column_names)
end

#remove_index(options = {}) ⇒ Object

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



580
581
582
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 580

def remove_index(options = {})
  @base.remove_index(@table_name, options)
end

#remove_references(*args) ⇒ Object Also known as: remove_belongs_to

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)



620
621
622
623
624
625
626
627
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 620

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

#remove_timestamps ⇒ Object

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

Example
t.remove_timestamps



587
588
589
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 587

def remove_timestamps
  @base.remove_timestamps(@table_name)
end

#rename(column_name, new_column_name) ⇒ Object

Renames a column.

Example
t.rename(:description, :name)



594
595
596
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 594

def rename(column_name, new_column_name)
  @base.rename_column(@table_name, column_name, new_column_name)
end

#timestamps ⇒ Object

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

Example
t.timestamps



540
541
542
 
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 540

def timestamps
  @base.add_timestamps(@table_name)
end