Class: ActiveRecord::ConnectionAdapters::TableDefinition

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

Overview

Represents the schema of an SQL table in an abstract way. This class provides methods for manipulating the schema representation.

Inside migration files, the t object in create_table is actually of this type:

class SomeMigration < ActiveRecord::Migration
  def up
    create_table :foo do |t|
      puts t.class  # => "ActiveRecord::ConnectionAdapters::TableDefinition"
    end
  end

  def down
    ...
  end
end

The table definitions The Columns are stored as a ColumnDefinition in the columns attribute.

Direct Known Subclasses

PostgreSQLAdapter::TableDefinition

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(types, name, temporary, options) ⇒ TableDefinition

Returns a new instance of TableDefinition.



57
58
59
60
61
62
63
64
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 57

def initialize(types, name, temporary, options)
  @columns_hash = {}
  @indexes = {}
  @native = types
  @temporary = temporary
  @options = options
  @name = name
end

Instance Attribute Details

#indexes ⇒ Object

An array of ColumnDefinition objects, representing the column changes that have been defined.



54
55
56
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 54

def indexes
  @indexes
end

#name ⇒ Object (readonly)

Returns the value of attribute name



55
56
57
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 55

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options



55
56
57
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 55

def options
  @options
end

#temporary ⇒ Object (readonly)

Returns the value of attribute temporary



55
56
57
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 55

def temporary
  @temporary
end

Instance Method Details

#[](name) ⇒ Object

Returns a ColumnDefinition for the column with name name.



75
76
77
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 75

def [](name)
  @columns_hash[name.to_s]
end

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

Instantiates a new column for the table. The type parameter is normally one of the migrations native types, which is one of the following: :primary_key, :string, :text, :integer, :float, :decimal, :datetime, :timestamp, :time, :date, :binary, :boolean.

You may use a type not in this list as long as it is supported by your database (for example, “polygon” in MySQL), but this will not be database agnostic and should usually be avoided.

Available options are (none of these exists by default):

  • :limit - Requests a maximum column length. This is number of characters for :string and :text columns and number of bytes for :binary and :integer columns.

  • :default - The column’s default value. Use nil for NULL.

  • :null - Allows or disallows NULL values in the column. This option could have been named :null_allowed.

  • :precision - Specifies the precision for a :decimal column.

  • :scale - Specifies the scale for a :decimal column.

For clarity’s sake: the precision is the number of significant digits, while the scale is the number of digits that can be stored following the decimal point. For example, the number 123.45 has a precision of 5 and a scale of 2. A decimal with a precision of 5 and a scale of 2 can range from -999.99 to 999.99.

Please be aware of different RDBMS implementations behavior with :decimal columns:

  • The SQL standard says the default scale should be 0, :scale <= :precision, and makes no comments about the requirements of :precision.

  • MySQL: :precision [1..63], :scale [0..30]. Default is (10,0).

  • PostgreSQL: :precision [1..infinity], :scale [0..infinity]. No default.

  • SQLite2: Any :precision and :scale may be used. Internal storage as strings. No default.

  • SQLite3: No restrictions on :precision and :scale, but the maximum supported :precision is 16. No default.

  • Oracle: :precision [1..38], :scale [-84..127]. Default is (38,0).

  • DB2: :precision [1..63], :scale [0..62]. Default unknown.

  • Firebird: :precision [1..18], :scale [0..18]. Default (9,0). Internal types NUMERIC and DECIMAL have different storage rules, decimal being better.

  • FrontBase?: :precision [1..38], :scale [0..38]. Default (38,0). WARNING Max :precision/:scale for NUMERIC is 19, and DECIMAL is 38.

  • SqlServer?: :precision [1..38], :scale [0..38]. Default (38,0).

  • Sybase: :precision [1..38], :scale [0..38]. Default (38,0).

  • OpenBase?: Documentation unclear. Claims storage in double.

This method returns self.

Examples

# Assuming +td+ is an instance of TableDefinition
td.column(:granted, :boolean)
# granted BOOLEAN

td.column(:picture, :binary, limit: 2.megabytes)
# => picture BLOB(2097152)

td.column(:sales_stage, :string, limit: 20, default: 'new', null: false)
# => sales_stage VARCHAR(20) DEFAULT 'new' NOT NULL

td.column(:bill_gates_money, :decimal, precision: 15, scale: 2)
# => bill_gates_money DECIMAL(15,2)

td.column(:sensor_reading, :decimal, precision: 30, scale: 20)
# => sensor_reading DECIMAL(30,20)

# While <tt>:scale</tt> defaults to zero on most databases, it
# probably wouldn't hurt to include it.
td.column(:huge_integer, :decimal, precision: 30)
# => huge_integer DECIMAL(30)

# Defines a column with a database-specific type.
td.column(:foo, 'polygon')
# => foo polygon

Short-hand examples

Instead of calling column directly, you can also work with the short-hand definitions for the default types. They use the type as the method name instead of as a parameter and allow for multiple columns to be defined in a single statement.

What can be written like this with the regular calls to column:

create_table :products do |t|
  t.column :shop_id,    :integer
  t.column :creator_id, :integer
  t.column :name,       :string, default: "Untitled"
  t.column :value,      :string, default: "Untitled"
  t.column :created_at, :datetime
  t.column :updated_at, :datetime
end

can also be written as follows using the short-hand:

create_table :products do |t|
  t.integer :shop_id, :creator_id
  t.string  :name, :value, default: "Untitled"
  t.timestamps
end

There’s a short-hand method for each of the type values declared at the top. And then there’s TableDefinition#timestamps that’ll add created_at and updated_at as datetimes.

TableDefinition#references will add an appropriately-named _id column, plus a corresponding _type column if the :polymorphic option is supplied. If :polymorphic is a hash of options, these will be used when creating the _type column. The :index option will also create an index, similar to calling add_index. So what can be written like this:

create_table :taggings do |t|
  t.integer :tag_id, :tagger_id, :taggable_id
  t.string  :tagger_type
  t.string  :taggable_type, default: 'Photo'
end
add_index :taggings, :tag_id, name: 'index_taggings_on_tag_id'
add_index :taggings, [:tagger_id, :tagger_type]

Can also be written as follows using references:

create_table :taggings do |t|
  t.references :tag, index: { name: 'index_taggings_on_tag_id' }
  t.references :tagger, polymorphic: true, index: true
  t.references :taggable, polymorphic: { default: 'Photo' }
end



216
217
218
219
220
221
222
223
224
225
226
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 216

def column(name, type, options = {})
  name = name.to_s
  type = type.to_sym

  if primary_key_column_name == name
    raise ArgumentError, "you can't redefine the primary key column '#{name}'. To define a custom primary key, pass { id: false } to create_table."
  end

  @columns_hash[name] = new_column_definition(name, type, options)
  self
end

#columns ⇒ Object 



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

def columns; @columns_hash.values; end

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

Adds index options to the indexes hash, keyed by column name This is primarily used to track indexes that need to be created after the table

index(:account_id, name: 'index_projects_on_account_id')



244
245
246
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 244

def index(column_name, options = {})
  indexes[column_name] = options
end

#new_column_definition(name, type, options) ⇒ Object

:nodoc:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 268

def new_column_definition(name, type, options) # :nodoc:
  column = create_column_definition name, type
  limit = options.fetch(:limit) do
    native[type][:limit] if native[type].is_a?(Hash)
  end

  column.limit       = limit
  column.array       = options[:array] if column.respond_to?(:array)
  column.precision   = options[:precision]
  column.scale       = options[:scale]
  column.default     = options[:default]
  column.null        = options[:null]
  column.first       = options[:first]
  column.after       = options[:after]
  column.primary_key = type == :primary_key || options[:primary_key]
  column
end

#primary_key(name, type = :primary_key, options = {}) ⇒ Object

Appends a primary key definition to the table definition. Can be called multiple times, but this is probably not a good idea.



70
71
72
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 70

def primary_key(name, type = :primary_key, options = {})
  column(name, type, options.merge(:primary_key => true))
end

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



256
257
258
259
260
261
262
263
264
265
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 256

def references(*args)
  options = args.extract_options!
  polymorphic = options.delete(:polymorphic)
  index_options = options.delete(:index)
  args.each do |col|
    column("#{col}_id", :integer, options)
    column("#{col}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
    index(polymorphic ? %w(id type).map { |t| "#{col}_#{t}" } : "#{col}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
  end
end

#remove_column(name) ⇒ Object 



228
229
230
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 228

def remove_column(name)
  @columns_hash.delete name.to_s
end

#timestamps(*args) ⇒ Object

Appends :datetime columns :created_at and :updated_at to the table.



250
251
252
253
254
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 250

def timestamps(*args)
  options = args.extract_options!
  column(:created_at, :datetime, options)
  column(:updated_at, :datetime, options)
end