123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::Table

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
PostgreSQL::Table
Inherits: Object
Defined in: activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb

Overview

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.rename_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

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(table_name, base) ⇒ Table

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 432



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


  







Instance Attribute Details



  

    #name   (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 430



attr_reader :name


  







Instance Method Details



  

    #belongs_to(*args)  
  



  

    

Alias for #references.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 548



alias :belongs_to :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.



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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 488



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


  








  

    #change_default(column_name, default)  
  



  

    

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



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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 496



def change_default(column_name, default)
  @base.change_column_default(name, column_name, default)
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.



Creating a simple column



t.column(:name, :string)


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 442



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


  








  

    #column_exists?(column_name, type = nil, options = {})  ⇒ Boolean 
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 447



def column_exists?(column_name, type = nil, options = {})
  @base.column_exists?(name, column_name, type, options)
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



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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 460



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


  








  

    #index_exists?(column_name, options = {})  ⇒ Boolean 
  



  

    

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


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 465



def index_exists?(column_name, options = {})
  @base.index_exists?(name, column_name, options)
end


  








  

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



  

    

Adds a reference.



t.references(:user)
t.belongs_to(:supplier, foreign_key: true)



See SchemaStatements#add_reference for details of the options you can use.


  



  [ GitHub ]


  

  


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



def references(*args)
  options = args.extract_options!
  args.each do |ref_name|
    @base.add_reference(name, ref_name, options)
  end
end


  








  

    #remove(*column_names)  
  



  

    

Removes the column(s) from the table definition.



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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 504



def remove(*column_names)
  @base.remove_columns(name, *column_names)
end


  








  

    #remove_belongs_to(*args)  
  



  

    

Alias for #remove_references.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 563



alias :remove_belongs_to :remove_references


  








  

    #remove_index(options = {})  
  



  

    

Removes the given index from the table.



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


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 518



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


  








  

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



  

    

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



t.remove_references(:user)
t.remove_belongs_to(:supplier, polymorphic: true)



See SchemaStatements#remove_reference


  



  [ GitHub ]


  

  


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



def remove_references(*args)
  options = args.extract_options!
  args.each do |ref_name|
    @base.remove_reference(name, ref_name, options)
  end
end


  








  

    #remove_timestamps(options = {})  
  



  

    

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



t.remove_timestamps


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 525



def remove_timestamps(options = {})
  @base.remove_timestamps(name, options)
end


  








  

    #rename(column_name, new_column_name)  
  



  

    

Renames a column.



t.rename(:description, :name)


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 532



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


  








  

    #rename_index(index_name, new_index_name)  
  



  

    

Renames the given index on the table.



t.rename_index(:user_id, :)


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 472



def rename_index(index_name, new_index_name)
  @base.rename_index(name, index_name, new_index_name)
end


  








  

    #timestamps(options = {})  
  



  

    

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



t.timestamps null: false


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 479



def timestamps(options = {})
  @base.add_timestamps(name, options)
end