| Class | ActiveRecord::ConnectionAdapters::Table |
| In: |
vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb
|
| Parent: | Object |
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
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 507
507: def initialize(table_name, base)
508: @table_name = table_name
509: @base = base
510: 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 vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 547
547: def change(column_name, type, options = {})
548: @base.change_column(@table_name, column_name, type, options)
549: 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 vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 555
555: def change_default(column_name, default)
556: @base.change_column_default(@table_name, column_name, default)
557: 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 vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 517
517: def column(column_name, type, options = {})
518: @base.add_column(@table_name, column_name, type, options)
519: 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 vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 531
531: def index(column_name, options = {})
532: @base.add_index(@table_name, column_name, options)
533: end
Adds a reference. Optionally adds a type column. references and belongs_to are acceptable.
t.references(:goat) t.references(:goat, :polymorphic => true) t.belongs_to(:goat)
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 602
602: def references(*args)
603: options = args.extract_options!
604: polymorphic = options.delete(:polymorphic)
605: args.each do |col|
606: @base.add_column(@table_name, "#{col}_id", :integer, options)
607: @base.add_column(@table_name, "#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) unless polymorphic.nil?
608: end
609: end
Removes the column(s) from the table definition.
t.remove(:qualification) t.remove(:qualification, :experience)
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 563
563: def remove(*column_names)
564: @base.remove_column(@table_name, column_names)
565: end
Removes the given index from the table.
t.remove_index :name
t.remove_index :column => :branch_id
t.remove_index :column => [:branch_id, :party_id]
t.remove_index :name => :by_branch_party
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 578
578: def remove_index(options = {})
579: @base.remove_index(@table_name, options)
580: 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 vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 618
618: def remove_references(*args)
619: options = args.extract_options!
620: polymorphic = options.delete(:polymorphic)
621: args.each do |col|
622: @base.remove_column(@table_name, "#{col}_id")
623: @base.remove_column(@table_name, "#{col}_type") unless polymorphic.nil?
624: end
625: end
Removes the timestamp columns (created_at and updated_at) from the table.
t.remove_timestamps
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 585
585: def remove_timestamps
586: @base.remove_timestamps(@table_name)
587: end
Adds timestamps (created_at and updated_at) columns to the table. See SchemaStatements#add_timestamps
t.timestamps
# File vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 538
538: def timestamps
539: @base.add_timestamps(@table_name)
540: end