An abstract definition of a column in a table.

Methods
B
H
K
N
S
T
V
Attributes
[R] default
[R] limit
[R] name
[R] null
[R] precision
[RW] primary
[R] scale
[R] sql_type
[R] type
Class Public methods
binary_to_string(value)

Used to convert from BLOBs to Strings

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 101
def self.binary_to_string(value)
  value
end
new(name, default, sql_type = nil, null = true)

Instantiates a new column in the table.

name is the column's name, as in supplier_id int(11). default is the type-casted default value, such as sales_stage varchar(20) default 'new'. sql_type is only used to extract the column's length, if necessary. For example, company_name varchar(60). null determines if this column allows NULL values.

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 18
def initialize(name, default, sql_type = nil, null = true)
  @name, @sql_type, @null = name, sql_type, null
  @limit, @precision, @scale  = extract_limit(sql_type), extract_precision(sql_type), extract_scale(sql_type) 
  @type = simplified_type(sql_type)
  @default = type_cast(default)

  @primary = nil
end
string_to_binary(value)

Used to convert from Strings to BLOBs

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 96
def self.string_to_binary(value)
  value
end
string_to_date(string)
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 105
def self.string_to_date(string)
  return string unless string.is_a?(String)
  date_array = ParseDate.parsedate(string)
  # treat 0000-00-00 as nil
  Date.new(date_array[0], date_array[1], date_array[2]) rescue nil
end
string_to_dummy_time(string)
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 121
def self.string_to_dummy_time(string)
  return string unless string.is_a?(String)
  return nil if string.empty?
  time_hash = Date._parse(string)
  time_hash[:sec_fraction] = microseconds(time_hash)
  # pad the resulting array with dummy date information
  time_array = [2000, 1, 1]
  time_array += time_hash.values_at(:hour, :min, :sec, :sec_fraction)
  Time.send(Base.default_timezone, *time_array) rescue nil
end
string_to_time(string)
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 112
def self.string_to_time(string)
  return string unless string.is_a?(String)
  time_hash = Date._parse(string)
  time_hash[:sec_fraction] = microseconds(time_hash)
  time_array = time_hash.values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction)
  # treat 0000-00-00 00:00:00 as nil
  Time.send(Base.default_timezone, *time_array) rescue DateTime.new(*time_array[0..5]) rescue nil
end
value_to_boolean(value)

convert something to a boolean

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 133
def self.value_to_boolean(value)
  if value == true || value == false
    value
  else
    %w(true t 1).include?(value.to_s.downcase)
  end
end
value_to_decimal(value)

convert something to a BigDecimal

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 142
def self.value_to_decimal(value)
  if value.is_a?(BigDecimal)
    value
  elsif value.respond_to?(:to_d)
    value.to_d
  else
    value.to_s.to_d
  end
end
Instance Public methods
human_name()

Returns the human name of the column name.

Examples
Column.new('sales_stage', ...).human_name #=> 'Sales stage'
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 91
def human_name
  Base.human_attribute_name(@name)
end
klass()

Returns the Ruby class that corresponds to the abstract data type.

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 36
def klass
  case type
    when :integer       then Fixnum
    when :float         then Float
    when :decimal       then BigDecimal
    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
number?()
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 31
def number?
  [:float, :integer, :decimal].include? type
end
text?()
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 27
def text?
  [:string, :text].include? type
end
type_cast(value)

Casts value (which is a String) to an appropriate instance.

# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 52
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
    when :decimal   then self.class.value_to_decimal(value)
    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
type_cast_code(var_name)
# File rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 70
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"
    when :decimal   then "#{self.class.name}.value_to_decimal(#{var_name})"
    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