2007-02-09 09:04:31 +01:00
require 'date'
2008-10-27 07:47:01 +01:00
require 'set'
2007-02-09 09:04:31 +01:00
require 'bigdecimal'
require 'bigdecimal/util'
2007-01-22 14:43:50 +01:00
module ActiveRecord
module ConnectionAdapters #:nodoc:
# An abstract definition of a column in a table.
class Column
2008-10-27 07:47:01 +01:00
TRUE_VALUES = [ true , 1 , '1' , 't' , 'T' , 'true' , 'TRUE' ] . to_set
2007-12-21 08:48:59 +01:00
module Format
ISO_DATE = / \ A( \ d{4})-( \ d \ d)-( \ d \ d) \ z /
ISO_DATETIME = / \ A( \ d{4})-( \ d \ d)-( \ d \ d) ( \ d \ d):( \ d \ d):( \ d \ d)( \ . \ d+)? \ z /
end
2007-02-09 09:04:31 +01:00
attr_reader :name , :default , :type , :limit , :null , :sql_type , :precision , :scale
2007-01-22 14:43:50 +01:00
attr_accessor :primary
# Instantiates a new column in the table.
#
2008-06-02 08:35:38 +02:00
# +name+ is the column's name, such as <tt>supplier_id</tt> in <tt>supplier_id int(11)</tt>.
# +default+ is the type-casted default value, such as +new+ in <tt>sales_stage varchar(20) default 'new'</tt>.
# +sql_type+ is only used to extract the column's length, if necessary. For example +60+ in <tt>company_name varchar(60)</tt>.
2007-01-22 14:43:50 +01:00
# +null+ determines if this column allows +NULL+ values.
def initialize ( name , default , sql_type = nil , null = true )
2007-02-09 09:04:31 +01:00
@name , @sql_type , @null = name , sql_type , null
2008-06-02 08:35:38 +02:00
@limit , @precision , @scale = extract_limit ( sql_type ) , extract_precision ( sql_type ) , extract_scale ( sql_type )
2007-02-09 09:04:31 +01:00
@type = simplified_type ( sql_type )
2007-12-21 08:48:59 +01:00
@default = extract_default ( default )
2007-02-09 09:04:31 +01:00
2007-01-22 14:43:50 +01:00
@primary = nil
end
def text?
2008-10-27 07:47:01 +01:00
type == :string || type == :text
2007-01-22 14:43:50 +01:00
end
def number?
2008-10-27 07:47:01 +01:00
type == :integer || type == :float || type == :decimal
end
def has_default?
! default . nil?
2007-01-22 14:43:50 +01:00
end
# Returns the Ruby class that corresponds to the abstract data type.
def klass
case type
when :integer then Fixnum
when :float then Float
2007-02-09 09:04:31 +01:00
when :decimal then BigDecimal
2007-01-22 14:43:50 +01:00
when :datetime then Time
when :date then Date
when :timestamp then Time
when :time then Time
when :text , :string then String
when :binary then String
when :boolean then Object
end
end
# Casts value (which is a String) to an appropriate instance.
def type_cast ( value )
return nil if value . nil?
case type
when :string then value
when :text then value
when :integer then value . to_i rescue value ? 1 : 0
when :float then value . to_f
2007-02-09 09:04:31 +01:00
when :decimal then self . class . value_to_decimal ( value )
2007-01-22 14:43:50 +01:00
when :datetime then self . class . string_to_time ( value )
when :timestamp then self . class . string_to_time ( value )
when :time then self . class . string_to_dummy_time ( value )
when :date then self . class . string_to_date ( value )
when :binary then self . class . binary_to_string ( value )
when :boolean then self . class . value_to_boolean ( value )
else value
end
end
def type_cast_code ( var_name )
case type
when :string then nil
when :text then nil
when :integer then " ( #{ var_name } .to_i rescue #{ var_name } ? 1 : 0) "
when :float then " #{ var_name } .to_f "
2007-02-09 09:04:31 +01:00
when :decimal then " #{ self . class . name } .value_to_decimal( #{ var_name } ) "
2007-01-22 14:43:50 +01:00
when :datetime then " #{ self . class . name } .string_to_time( #{ var_name } ) "
when :timestamp then " #{ self . class . name } .string_to_time( #{ var_name } ) "
when :time then " #{ self . class . name } .string_to_dummy_time( #{ var_name } ) "
when :date then " #{ self . class . name } .string_to_date( #{ var_name } ) "
when :binary then " #{ self . class . name } .binary_to_string( #{ var_name } ) "
when :boolean then " #{ self . class . name } .value_to_boolean( #{ var_name } ) "
else nil
end
end
# Returns the human name of the column name.
#
# ===== Examples
2008-06-02 08:35:38 +02:00
# Column.new('sales_stage', ...).human_name # => 'Sales stage'
2007-01-22 14:43:50 +01:00
def human_name
Base . human_attribute_name ( @name )
end
2007-12-21 08:48:59 +01:00
def extract_default ( default )
type_cast ( default )
2007-01-22 14:43:50 +01:00
end
2007-12-21 08:48:59 +01:00
class << self
# Used to convert from Strings to BLOBs
def string_to_binary ( value )
value
end
2007-01-22 14:43:50 +01:00
2007-12-21 08:48:59 +01:00
# Used to convert from BLOBs to Strings
def binary_to_string ( value )
value
end
2007-01-22 14:43:50 +01:00
2007-12-21 08:48:59 +01:00
def string_to_date ( string )
return string unless string . is_a? ( String )
return nil if string . empty?
2007-01-22 14:43:50 +01:00
2007-12-21 08:48:59 +01:00
fast_string_to_date ( string ) || fallback_string_to_date ( string )
end
2007-01-22 14:43:50 +01:00
2007-12-21 08:48:59 +01:00
def string_to_time ( string )
return string unless string . is_a? ( String )
return nil if string . empty?
fast_string_to_time ( string ) || fallback_string_to_time ( string )
2007-02-09 09:04:31 +01:00
end
2007-12-21 08:48:59 +01:00
def string_to_dummy_time ( string )
return string unless string . is_a? ( String )
return nil if string . empty?
string_to_time " 2000-01-01 #{ string } "
2007-01-22 14:43:50 +01:00
end
2007-12-21 08:48:59 +01:00
# convert something to a boolean
def value_to_boolean ( value )
2008-10-27 07:47:01 +01:00
if value . is_a? ( String ) && value . blank?
nil
2007-12-21 08:48:59 +01:00
else
2008-10-27 07:47:01 +01:00
TRUE_VALUES . include? ( value )
2007-12-21 08:48:59 +01:00
end
end
# convert something to a BigDecimal
def value_to_decimal ( value )
2008-05-18 06:22:34 +02:00
# Using .class is faster than .is_a? and
# subclasses of BigDecimal will be handled
# in the else clause
if value . class == BigDecimal
2007-12-21 08:48:59 +01:00
value
elsif value . respond_to? ( :to_d )
value . to_d
else
value . to_s . to_d
end
2007-02-09 09:04:31 +01:00
end
2007-12-21 08:48:59 +01:00
protected
# '0.123456' -> 123456
# '1.123456' -> 123456
def microseconds ( time )
( ( time [ :sec_fraction ] . to_f % 1 ) * 1_000_000 ) . to_i
end
def new_date ( year , mon , mday )
if year && year != 0
Date . new ( year , mon , mday ) rescue nil
end
end
def new_time ( year , mon , mday , hour , min , sec , microsec )
# Treat 0000-00-00 00:00:00 as nil.
return nil if year . nil? || year == 0
2008-06-02 08:35:38 +02:00
2008-05-18 06:22:34 +02:00
Time . time_with_datetime_fallback ( Base . default_timezone , year , mon , mday , hour , min , sec , microsec ) rescue nil
2007-12-21 08:48:59 +01:00
end
def fast_string_to_date ( string )
if string =~ Format :: ISO_DATE
new_date $1 . to_i , $2 . to_i , $3 . to_i
end
end
# Doesn't handle time zones.
def fast_string_to_time ( string )
if string =~ Format :: ISO_DATETIME
microsec = ( $7 . to_f * 1_000_000 ) . to_i
new_time $1 . to_i , $2 . to_i , $3 . to_i , $4 . to_i , $5 . to_i , $6 . to_i , microsec
end
end
def fallback_string_to_date ( string )
2008-05-18 06:22:34 +02:00
new_date ( * :: Date . _parse ( string , false ) . values_at ( :year , :mon , :mday ) )
2007-12-21 08:48:59 +01:00
end
def fallback_string_to_time ( string )
time_hash = Date . _parse ( string )
time_hash [ :sec_fraction ] = microseconds ( time_hash )
2008-05-18 06:22:34 +02:00
new_time ( * time_hash . values_at ( :year , :mon , :mday , :hour , :min , :sec , :sec_fraction ) )
2007-12-21 08:48:59 +01:00
end
end
private
2007-01-22 14:43:50 +01:00
def extract_limit ( sql_type )
$1 . to_i if sql_type =~ / \ ((.*) \ ) /
end
2007-02-09 09:04:31 +01:00
def extract_precision ( sql_type )
$2 . to_i if sql_type =~ / ^(numeric|decimal|number) \ (( \ d+)(, \ d+)? \ ) /i
end
def extract_scale ( sql_type )
case sql_type
when / ^(numeric|decimal|number) \ (( \ d+) \ ) /i then 0
when / ^(numeric|decimal|number) \ (( \ d+)(,( \ d+)) \ ) /i then $4 . to_i
end
end
2007-01-22 14:43:50 +01:00
def simplified_type ( field_type )
case field_type
when / int /i
:integer
2007-02-09 09:04:31 +01:00
when / float|double /i
2007-01-22 14:43:50 +01:00
:float
2007-02-09 09:04:31 +01:00
when / decimal|numeric|number /i
extract_scale ( field_type ) == 0 ? :integer : :decimal
2007-01-22 14:43:50 +01:00
when / datetime /i
:datetime
when / timestamp /i
:timestamp
when / time /i
:time
when / date /i
:date
when / clob /i , / text /i
:text
when / blob /i , / binary /i
:binary
when / char /i , / string /i
:string
when / boolean /i
:boolean
end
end
end
class IndexDefinition < Struct . new ( :table , :name , :unique , :columns ) #:nodoc:
end
2008-10-27 07:47:01 +01:00
# Abstract representation of a column definition. Instances of this type
# are typically created by methods in TableDefinition, and added to the
# +columns+ attribute of said TableDefinition object, in order to be used
# for generating a number of table creation or table changing SQL statements.
2007-02-09 09:04:31 +01:00
class ColumnDefinition < Struct . new ( :base , :name , :type , :limit , :precision , :scale , :default , :null ) #:nodoc:
2008-06-02 08:35:38 +02:00
2007-02-09 09:04:31 +01:00
def sql_type
base . type_to_sql ( type . to_sym , limit , precision , scale ) rescue type
end
2008-06-02 08:35:38 +02:00
2007-01-22 14:43:50 +01:00
def to_sql
2007-02-09 09:04:31 +01:00
column_sql = " #{ base . quote_column_name ( name ) } #{ sql_type } "
2008-09-07 07:54:05 +02:00
column_options = { }
column_options [ :null ] = null unless null . nil?
column_options [ :default ] = default unless default . nil?
add_column_options! ( column_sql , column_options ) unless type . to_sym == :primary_key
2007-01-22 14:43:50 +01:00
column_sql
end
alias to_s :to_sql
private
def add_column_options! ( sql , options )
base . add_column_options! ( sql , options . merge ( :column = > self ) )
end
end
2008-10-27 07:47:01 +01:00
# 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+ and
# +change_table+ is actually of this type:
#
# class SomeMigration < ActiveRecord::Migration
# def self.up
# create_table :foo do |t|
# puts t.class # => "ActiveRecord::ConnectionAdapters::TableDefinition"
# end
# end
#
# def self.down
# ...
# end
# end
#
# The table definitions
# The Columns are stored as a ColumnDefinition in the +columns+ attribute.
2007-01-22 14:43:50 +01:00
class TableDefinition
2008-10-27 07:47:01 +01:00
# An array of ColumnDefinition objects, representing the column changes
# that have been defined.
2007-01-22 14:43:50 +01:00
attr_accessor :columns
def initialize ( base )
@columns = [ ]
@base = base
end
# Appends a primary key definition to the table definition.
# Can be called multiple times, but this is probably not a good idea.
def primary_key ( name )
2007-02-09 09:04:31 +01:00
column ( name , :primary_key )
2007-01-22 14:43:50 +01:00
end
# Returns a ColumnDefinition for the column with name +name+.
def [] ( name )
@columns . find { | column | column . name . to_s == name . to_s }
end
# Instantiates a new column for the table.
2007-12-21 08:48:59 +01:00
# The +type+ parameter is normally one of the migrations native types,
# which is one of the following:
2007-01-22 14:43:50 +01:00
# <tt>:primary_key</tt>, <tt>:string</tt>, <tt>:text</tt>,
2007-02-09 09:04:31 +01:00
# <tt>:integer</tt>, <tt>:float</tt>, <tt>:decimal</tt>,
# <tt>:datetime</tt>, <tt>:timestamp</tt>, <tt>:time</tt>,
# <tt>:date</tt>, <tt>:binary</tt>, <tt>:boolean</tt>.
2007-01-22 14:43:50 +01:00
#
2007-12-21 08:48:59 +01:00
# 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.
#
2007-01-22 14:43:50 +01:00
# Available options are (none of these exists by default):
2007-12-21 08:48:59 +01:00
# * <tt>:limit</tt> -
2008-09-07 07:54:05 +02:00
# Requests a maximum column length. This is number of characters for <tt>:string</tt> and <tt>:text</tt> columns and number of bytes for :binary and :integer columns.
2007-12-21 08:48:59 +01:00
# * <tt>:default</tt> -
2007-02-09 09:04:31 +01:00
# The column's default value. Use nil for NULL.
2007-12-21 08:48:59 +01:00
# * <tt>:null</tt> -
2008-06-02 08:35:38 +02:00
# Allows or disallows +NULL+ values in the column. This option could
2007-01-22 14:43:50 +01:00
# have been named <tt>:null_allowed</tt>.
2007-12-21 08:48:59 +01:00
# * <tt>:precision</tt> -
2008-06-02 08:35:38 +02:00
# Specifies the precision for a <tt>:decimal</tt> column.
2007-12-21 08:48:59 +01:00
# * <tt>:scale</tt> -
2008-06-02 08:35:38 +02:00
# Specifies the scale for a <tt>:decimal</tt> column.
2007-02-09 09:04:31 +01:00
#
2008-10-27 07:47:01 +01:00
# 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.
#
2007-02-09 09:04:31 +01:00
# Please be aware of different RDBMS implementations behavior with
# <tt>:decimal</tt> columns:
# * The SQL standard says the default scale should be 0, <tt>:scale</tt> <=
# <tt>:precision</tt>, and makes no comments about the requirements of
# <tt>:precision</tt>.
2008-06-02 08:35:38 +02:00
# * MySQL: <tt>:precision</tt> [1..63], <tt>:scale</tt> [0..30].
2007-02-09 09:04:31 +01:00
# Default is (10,0).
2008-06-02 08:35:38 +02:00
# * PostgreSQL: <tt>:precision</tt> [1..infinity],
2007-02-09 09:04:31 +01:00
# <tt>:scale</tt> [0..infinity]. No default.
2008-06-02 08:35:38 +02:00
# * SQLite2: Any <tt>:precision</tt> and <tt>:scale</tt> may be used.
2007-02-09 09:04:31 +01:00
# Internal storage as strings. No default.
# * SQLite3: No restrictions on <tt>:precision</tt> and <tt>:scale</tt>,
# but the maximum supported <tt>:precision</tt> is 16. No default.
2008-06-02 08:35:38 +02:00
# * Oracle: <tt>:precision</tt> [1..38], <tt>:scale</tt> [-84..127].
2007-02-09 09:04:31 +01:00
# Default is (38,0).
2008-06-02 08:35:38 +02:00
# * DB2: <tt>:precision</tt> [1..63], <tt>:scale</tt> [0..62].
2007-02-09 09:04:31 +01:00
# Default unknown.
2008-06-02 08:35:38 +02:00
# * Firebird: <tt>:precision</tt> [1..18], <tt>:scale</tt> [0..18].
2007-02-09 09:04:31 +01:00
# Default (9,0). Internal types NUMERIC and DECIMAL have different
# storage rules, decimal being better.
2008-06-02 08:35:38 +02:00
# * FrontBase?: <tt>:precision</tt> [1..38], <tt>:scale</tt> [0..38].
2007-02-09 09:04:31 +01:00
# Default (38,0). WARNING Max <tt>:precision</tt>/<tt>:scale</tt> for
# NUMERIC is 19, and DECIMAL is 38.
2008-06-02 08:35:38 +02:00
# * SqlServer?: <tt>:precision</tt> [1..38], <tt>:scale</tt> [0..38].
2007-02-09 09:04:31 +01:00
# Default (38,0).
2008-06-02 08:35:38 +02:00
# * Sybase: <tt>:precision</tt> [1..38], <tt>:scale</tt> [0..38].
2007-02-09 09:04:31 +01:00
# Default (38,0).
# * OpenBase?: Documentation unclear. Claims storage in <tt>double</tt>.
2007-01-22 14:43:50 +01:00
#
# This method returns <tt>self</tt>.
#
2007-12-21 08:48:59 +01:00
# == Examples
2007-02-09 09:04:31 +01:00
# # Assuming td is an instance of TableDefinition
# td.column(:granted, :boolean)
2008-06-02 08:35:38 +02:00
# # granted BOOLEAN
2007-01-22 14:43:50 +01:00
#
2007-02-09 09:04:31 +01:00
# td.column(:picture, :binary, :limit => 2.megabytes)
2008-06-02 08:35:38 +02:00
# # => picture BLOB(2097152)
2007-01-22 14:43:50 +01:00
#
2007-02-09 09:04:31 +01:00
# td.column(:sales_stage, :string, :limit => 20, :default => 'new', :null => false)
2008-06-02 08:35:38 +02:00
# # => sales_stage VARCHAR(20) DEFAULT 'new' NOT NULL
2007-02-09 09:04:31 +01:00
#
2008-06-02 08:35:38 +02:00
# td.column(:bill_gates_money, :decimal, :precision => 15, :scale => 2)
# # => bill_gates_money DECIMAL(15,2)
2007-02-09 09:04:31 +01:00
#
2008-06-02 08:35:38 +02:00
# td.column(:sensor_reading, :decimal, :precision => 30, :scale => 20)
# # => sensor_reading DECIMAL(30,20)
2007-02-09 09:04:31 +01:00
#
# # While <tt>:scale</tt> defaults to zero on most databases, it
# # probably wouldn't hurt to include it.
2008-06-02 08:35:38 +02:00
# td.column(:huge_integer, :decimal, :precision => 30)
# # => huge_integer DECIMAL(30)
2007-12-21 08:48:59 +01:00
#
2008-10-27 07:47:01 +01:00
# # Defines a column with a database-specific type.
# td.column(:foo, 'polygon')
# # => foo polygon
#
2007-12-21 08:48:59 +01:00
# == Short-hand examples
#
2008-06-02 08:35:38 +02:00
# Instead of calling +column+ directly, you can also work with the short-hand definitions for the default types.
2007-12-21 08:48:59 +01:00
# 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", :force => true 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
#
2008-06-02 08:35:38 +02:00
# 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.
2007-12-21 08:48:59 +01:00
#
# TableDefinition#references will add an appropriately-named _id column, plus a corresponding _type
2008-05-18 06:22:34 +02:00
# column if the <tt>:polymorphic</tt> option is supplied. If <tt>:polymorphic</tt> is a hash of options, these will be
# used when creating the <tt>_type</tt> column. So what can be written like this:
2007-12-21 08:48:59 +01:00
#
# create_table :taggings do |t|
# t.integer :tag_id, :tagger_id, :taggable_id
# t.string :tagger_type
# t.string :taggable_type, :default => 'Photo'
# end
#
# Can also be written as follows using references:
#
# create_table :taggings do |t|
# t.references :tag
# t.references :tagger, :polymorphic => true
# t.references :taggable, :polymorphic => { :default => 'Photo' }
# end
2007-01-22 14:43:50 +01:00
def column ( name , type , options = { } )
column = self [ name ] || ColumnDefinition . new ( @base , name , type )
2008-05-18 06:22:34 +02:00
if options [ :limit ]
column . limit = options [ :limit ]
elsif native [ type . to_sym ] . is_a? ( Hash )
column . limit = native [ type . to_sym ] [ :limit ]
end
2007-02-09 09:04:31 +01:00
column . precision = options [ :precision ]
column . scale = options [ :scale ]
2007-01-22 14:43:50 +01:00
column . default = options [ :default ]
column . null = options [ :null ]
@columns << column unless @columns . include? column
self
end
2007-12-21 08:48:59 +01:00
%w( string text integer float decimal datetime timestamp time date binary boolean ) . each do | column_type |
class_eval <<-EOV
def #{column_type}(*args)
options = args . extract_options!
column_names = args
2008-06-02 08:35:38 +02:00
2007-12-21 08:48:59 +01:00
column_names . each { | name | column ( name , '#{column_type}' , options ) }
end
EOV
end
2008-06-02 08:35:38 +02:00
# Appends <tt>:datetime</tt> columns <tt>:created_at</tt> and
2007-12-21 08:48:59 +01:00
# <tt>:updated_at</tt> to the table.
2008-09-07 07:54:05 +02:00
def timestamps ( * args )
options = args . extract_options!
column ( :created_at , :datetime , options )
column ( :updated_at , :datetime , options )
2007-12-21 08:48:59 +01:00
end
def references ( * args )
options = args . extract_options!
polymorphic = options . delete ( :polymorphic )
args . each do | col |
column ( " #{ col } _id " , :integer , options )
2008-05-18 06:22:34 +02:00
column ( " #{ col } _type " , :string , polymorphic . is_a? ( Hash ) ? polymorphic : options ) unless polymorphic . nil?
2007-12-21 08:48:59 +01:00
end
end
alias :belongs_to :references
2007-01-22 14:43:50 +01:00
# Returns a String whose contents are the column definitions
2008-06-02 08:35:38 +02:00
# concatenated together. This string can then be prepended and appended to
2007-01-22 14:43:50 +01:00
# to generate the final SQL to create the table.
def to_sql
@columns * ', '
end
private
def native
@base . native_database_types
end
end
2008-05-18 06:22:34 +02:00
# 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
#
class Table
def initialize ( table_name , base )
@table_name = table_name
@base = base
end
# Adds a new column to the named table.
# See TableDefinition#column for details of the options you can use.
2008-06-02 08:35:38 +02:00
# ===== Example
# ====== Creating a simple column
2008-05-18 06:22:34 +02:00
# t.column(:name, :string)
def column ( column_name , type , options = { } )
@base . add_column ( @table_name , column_name , type , options )
end
2008-06-02 08:35:38 +02:00
# Adds a new index to the table. +column_name+ can be a single Symbol, or
# an Array of Symbols. See SchemaStatements#add_index
2008-05-18 06:22:34 +02:00
#
# ===== 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')
def index ( column_name , options = { } )
@base . add_index ( @table_name , column_name , options )
end
2008-06-02 08:35:38 +02:00
# Adds timestamps (created_at and updated_at) columns to the table. See SchemaStatements#add_timestamps
# ===== Example
2008-05-18 06:22:34 +02:00
# t.timestamps
def timestamps
@base . add_timestamps ( @table_name )
end
# 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)
def change ( column_name , type , options = { } )
@base . change_column ( @table_name , column_name , type , options )
end
2008-06-02 08:35:38 +02:00
# Sets a new default value for a column. See SchemaStatements#change_column_default
2008-05-18 06:22:34 +02:00
# ===== Examples
# t.change_default(:qualification, 'new')
# t.change_default(:authorized, 1)
def change_default ( column_name , default )
@base . change_column_default ( @table_name , column_name , default )
end
# Removes the column(s) from the table definition.
# ===== Examples
# t.remove(:qualification)
# t.remove(:qualification, :experience)
def remove ( * column_names )
@base . remove_column ( @table_name , column_names )
end
2008-06-02 08:35:38 +02:00
# Removes the given index from the table.
2008-05-18 06:22:34 +02:00
#
2008-06-02 08:35:38 +02:00
# ===== Examples
# ====== Remove the suppliers_name_index in the suppliers table
2008-05-18 06:22:34 +02:00
# t.remove_index :name
2008-06-02 08:35:38 +02:00
# ====== Remove the index named accounts_branch_id_index in the accounts table
2008-05-18 06:22:34 +02:00
# t.remove_index :column => :branch_id
2008-06-02 08:35:38 +02:00
# ====== Remove the index named accounts_branch_id_party_id_index in the accounts table
2008-05-18 06:22:34 +02:00
# t.remove_index :column => [:branch_id, :party_id]
2008-06-02 08:35:38 +02:00
# ====== Remove the index named by_branch_party in the accounts table
2008-05-18 06:22:34 +02:00
# t.remove_index :name => :by_branch_party
def remove_index ( options = { } )
@base . remove_index ( @table_name , options )
end
# Removes the timestamp columns (created_at and updated_at) from the table.
2008-06-02 08:35:38 +02:00
# ===== Example
2008-05-18 06:22:34 +02:00
# t.remove_timestamps
def remove_timestamps
@base . remove_timestamps ( @table_name )
end
# Renames a column.
# ===== Example
# t.rename(:description, :name)
def rename ( column_name , new_column_name )
@base . rename_column ( @table_name , column_name , new_column_name )
end
2008-06-02 08:35:38 +02:00
# Adds a reference. Optionally adds a +type+ column.
# <tt>references</tt> and <tt>belongs_to</tt> are acceptable.
# ===== Examples
2008-05-18 06:22:34 +02:00
# t.references(:goat)
# t.references(:goat, :polymorphic => true)
# t.belongs_to(:goat)
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
alias :belongs_to :references
2008-06-02 08:35:38 +02:00
# Removes a reference. Optionally removes a +type+ column.
# <tt>remove_references</tt> and <tt>remove_belongs_to</tt> are acceptable.
# ===== Examples
2008-05-18 06:22:34 +02:00
# t.remove_references(:goat)
2008-06-02 08:35:38 +02:00
# t.remove_references(:goat, :polymorphic => true)
2008-05-18 06:22:34 +02:00
# t.remove_belongs_to(:goat)
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
alias :remove_belongs_to :remove_references
# Adds a column or columns of a specified type
2008-06-02 08:35:38 +02:00
# ===== Examples
2008-05-18 06:22:34 +02:00
# t.string(:goat)
# t.string(:goat, :sheep)
%w( string text integer float decimal datetime timestamp time date binary boolean ) . each do | column_type |
class_eval <<-EOV
def #{column_type}(*args)
options = args . extract_options!
column_names = args
column_names . each do | name |
column = ColumnDefinition . new ( @base , name , '#{column_type}' )
if options [ :limit ]
column . limit = options [ :limit ]
elsif native [ '#{column_type}' . to_sym ] . is_a? ( Hash )
column . limit = native [ '#{column_type}' . to_sym ] [ :limit ]
end
column . precision = options [ :precision ]
column . scale = options [ :scale ]
column . default = options [ :default ]
column . null = options [ :null ]
@base . add_column ( @table_name , name , column . sql_type , options )
end
end
EOV
end
private
def native
@base . native_database_types
end
end
2007-01-22 14:43:50 +01:00
end
end