### Home Classes Methods

### In Files

- lib/active_record/connection_adapters/abstract/schema_definitions.rb

### Parent

Object

### Methods

- ::new
- #belongs_to
- #change
- #change_default
- #column
- #column_exists?
- #index
- #index_exists?
- #references
- #remove
- #remove_belongs_to
- #remove_index
- #remove_references
- #remove_timestamps
- #rename
- #timestamps

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- ActiveRecord
- ActiveRecord::ActiveRecordError
- ActiveRecord::AdapterNotFound
- ActiveRecord::AdapterNotSpecified
- ActiveRecord::Aggregations
- ActiveRecord::Aggregations::ClassMethods
- ActiveRecord::AssociationTypeMismatch
- ActiveRecord::Associations
- ActiveRecord::Associations::ClassMethods
- ActiveRecord::AttributeAssignment
- ActiveRecord::AttributeAssignment::ClassMethods
- ActiveRecord::AttributeAssignmentError
- ActiveRecord::AttributeMethods
- ActiveRecord::AttributeMethods::BeforeTypeCast
- ActiveRecord::AttributeMethods::ClassMethods
- ActiveRecord::AttributeMethods::DeprecatedUnderscoreRead
- ActiveRecord::AttributeMethods::DeprecatedUnderscoreRead::ClassMethods
- ActiveRecord::AttributeMethods::Dirty
- ActiveRecord::AttributeMethods::PrimaryKey
- ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods
- ActiveRecord::AttributeMethods::Query
- ActiveRecord::AttributeMethods::Read
- ActiveRecord::AttributeMethods::Read::ClassMethods
- ActiveRecord::AttributeMethods::Serialization
- ActiveRecord::AttributeMethods::Serialization::Attribute
- ActiveRecord::AttributeMethods::Serialization::ClassMethods
- ActiveRecord::AttributeMethods::TimeZoneConversion
- ActiveRecord::AttributeMethods::TimeZoneConversion::ClassMethods
- ActiveRecord::AttributeMethods::Write
- ActiveRecord::AttributeMethods::Write::ClassMethods
- ActiveRecord::AutosaveAssociation
- ActiveRecord::AutosaveAssociation::ClassMethods
- ActiveRecord::Base
- ActiveRecord::Batches
- ActiveRecord::Calculations
- ActiveRecord::Callbacks
- ActiveRecord::Coders
- ActiveRecord::ConfigurationError
- ActiveRecord::ConnectionAdapters
- ActiveRecord::ConnectionAdapters::AbstractAdapter
- ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
- ActiveRecord::ConnectionAdapters::ConnectionHandler
- ActiveRecord::ConnectionAdapters::ConnectionManagement
- ActiveRecord::ConnectionAdapters::ConnectionPool
- ActiveRecord::ConnectionAdapters::DatabaseLimits
- ActiveRecord::ConnectionAdapters::DatabaseStatements
- ActiveRecord::ConnectionAdapters::Mysql2Adapter
- ActiveRecord::ConnectionAdapters::MysqlAdapter
- ActiveRecord::ConnectionAdapters::MysqlAdapter::StatementPool
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::StatementPool
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::TableDefinition
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::Utils
- ActiveRecord::ConnectionAdapters::PostgreSQLColumn
- ActiveRecord::ConnectionAdapters::QueryCache
- ActiveRecord::ConnectionAdapters::Quoting
- ActiveRecord::ConnectionAdapters::SQLiteAdapter
- ActiveRecord::ConnectionAdapters::SQLiteAdapter::ExplainPrettyPrinter
- ActiveRecord::ConnectionAdapters::SQLiteAdapter::StatementPool
- ActiveRecord::ConnectionAdapters::SQLiteAdapter::Version
- ActiveRecord::ConnectionAdapters::SchemaCache
- ActiveRecord::ConnectionAdapters::SchemaStatements
- ActiveRecord::ConnectionAdapters::StatementPool
- ActiveRecord::ConnectionAdapters::Table
- ActiveRecord::ConnectionAdapters::TableDefinition
- ActiveRecord::ConnectionNotEstablished
- ActiveRecord::ConnectionTimeoutError
- ActiveRecord::CounterCache
- ActiveRecord::DangerousAttributeError
- ActiveRecord::Delegation
- ActiveRecord::DynamicFinderMatch
- ActiveRecord::DynamicMatchers
- ActiveRecord::DynamicScopeMatch
- ActiveRecord::Explain
- ActiveRecord::FinderMethods
- ActiveRecord::Fixtures
- ActiveRecord::Fixtures::File
- ActiveRecord::Generators
- ActiveRecord::Generators::Migration
- ActiveRecord::Generators::MigrationGenerator
- ActiveRecord::Generators::ModelGenerator
- ActiveRecord::Generators::ObserverGenerator
- ActiveRecord::Generators::SessionMigrationGenerator
- ActiveRecord::IdentityMap
- ActiveRecord::IdentityMap::Middleware
- ActiveRecord::Inheritance
- ActiveRecord::Inheritance::ClassMethods
- ActiveRecord::Integration
- ActiveRecord::InvalidForeignKey
- ActiveRecord::IrreversibleMigration
- ActiveRecord::Locking
- ActiveRecord::Locking::Optimistic
- ActiveRecord::Locking::Optimistic::ClassMethods
- ActiveRecord::Locking::Pessimistic
- ActiveRecord::LogSubscriber
- ActiveRecord::Migration
- ActiveRecord::Migration::CommandRecorder
- ActiveRecord::MigrationProxy
- ActiveRecord::ModelSchema
- ActiveRecord::ModelSchema::ClassMethods
- ActiveRecord::MultiparameterAssignmentErrors
- ActiveRecord::NestedAttributes
- ActiveRecord::NestedAttributes::ClassMethods
- ActiveRecord::NestedAttributes::TooManyRecords
- ActiveRecord::Observer
- ActiveRecord::Persistence
- ActiveRecord::Persistence::ClassMethods
- ActiveRecord::PreparedStatementInvalid
- ActiveRecord::QueryCache
- ActiveRecord::QueryCache::ClassMethods
- ActiveRecord::QueryMethods
- ActiveRecord::Querying
- ActiveRecord::Railtie
- ActiveRecord::Railties
- ActiveRecord::Railties::ControllerRuntime
- ActiveRecord::Railties::ControllerRuntime::ClassMethods
- ActiveRecord::ReadOnlyRecord
- ActiveRecord::ReadonlyAttributes
- ActiveRecord::ReadonlyAttributes::ClassMethods
- ActiveRecord::RecordInvalid
- ActiveRecord::RecordNotFound
- ActiveRecord::RecordNotSaved
- ActiveRecord::RecordNotUnique
- ActiveRecord::Reflection
- ActiveRecord::Reflection::ClassMethods
- ActiveRecord::Reflection::MacroReflection
- ActiveRecord::Result
- ActiveRecord::Rollback
- ActiveRecord::Sanitization
- ActiveRecord::Sanitization::ClassMethods
- ActiveRecord::Schema
- ActiveRecord::Scoping
- ActiveRecord::Scoping::ClassMethods
- ActiveRecord::Scoping::Default
- ActiveRecord::Scoping::Default::ClassMethods
- ActiveRecord::Scoping::Named
- ActiveRecord::Scoping::Named::ClassMethods
- ActiveRecord::Serialization
- ActiveRecord::SerializationTypeMismatch
- ActiveRecord::SessionStore
- ActiveRecord::SessionStore::Session
- ActiveRecord::SessionStore::SqlBypass
- ActiveRecord::SpawnMethods
- ActiveRecord::StaleObjectError
- ActiveRecord::StatementInvalid
- ActiveRecord::Store
- ActiveRecord::Store::ClassMethods
- ActiveRecord::TestFixtures
- ActiveRecord::TestFixtures::ClassMethods
- ActiveRecord::ThrowResult
- ActiveRecord::Timestamp
- ActiveRecord::Transactions
- ActiveRecord::Transactions::ClassMethods
- ActiveRecord::Translation
- ActiveRecord::UnknownAttributeError
- ActiveRecord::UnknownPrimaryKey
- ActiveRecord::Validations
- ActiveRecord::Validations::AssociatedValidator
- ActiveRecord::Validations::ClassMethods
- ActiveRecord::Validations::UniquenessValidator
- ActiveRecord::WrappedDatabaseException
- Mysql
- Mysql::Result
- Mysql::Stmt
- Mysql::Time
- ArJdbcMySQL
- ArJdbcMySQL::Error

No matching classes.

# 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 327
    def initialize(table_name, base)
      @table_name = table_name
      @base = base
    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 377
    def change(column_name, type, options = {})
      @base.change_column(@table_name, column_name, type, options)
    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 385
    def change_default(column_name, default)
      @base.change_column_default(@table_name, column_name, default)
    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 337
    def column(column_name, type, options = {})
      @base.add_column(@table_name, column_name, type, options)
    end

column_exists?(column_name, type = nil, options = {}) 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 342
    def column_exists?(column_name, type = nil, options = {})
      @base.column_exists?(@table_name, column_name, type, options)
    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 356
    def index(column_name, options = {})
      @base.add_index(@table_name, column_name, options)
    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 361
    def index_exists?(column_name, options = {})
      @base.index_exists?(@table_name, column_name, options)
    end

references(*args) click to toggle source

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)

    # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 432
    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

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 393
    def remove(*column_names)
      @base.remove_column(@table_name, *column_names)
    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 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

    # File lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 408
    def remove_index(options = {})
      @base.remove_index(@table_name, options)
    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 448
    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

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 415
    def remove_timestamps
      @base.remove_timestamps(@table_name)
    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 422
    def rename(column_name, new_column_name)
      @base.rename_column(@table_name, column_name, new_column_name)
    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 368
    def timestamps
      @base.add_timestamps(@table_name)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.