Class: ActiveRecord::ConnectionAdapters::Column

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

Overview

An abstract definition of a column in a table.

Direct Known Subclasses

MySQL::Column, NullColumn, PostgreSQLColumn

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, default, sql_type_metadata = nil, null = true, default_function = nil, collation = nil) ⇒ Column

Instantiates a new column in the table.

name is the column's name, such as supplier_id in supplier_id int. default is the type-casted default value, such as new in sales_stage varchar(20) default 'new'. sql_type_metadata is various information about the type of the column null determines if this column allows NULL values.



18
19
20
21
22
23
24
25
26
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 18

def initialize(name, default,  = nil, null = true, default_function = nil, collation = nil)
  @name = name.freeze
  @sql_type_metadata = 
  @null = null
  @default = default
  @default_function = default_function
  @collation = collation
  @table_name = nil
end

Instance Attribute Details

#collationObject (readonly)

Returns the value of attribute collation



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def collation
  @collation
end

#defaultObject (readonly)

Returns the value of attribute default



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def default
  @default
end

#default_functionObject (readonly)

Returns the value of attribute default_function



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def default_function
  @default_function
end

#nameObject (readonly)

Returns the value of attribute name



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def name
  @name
end

#nullObject (readonly)

Returns the value of attribute null



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def null
  @null
end

#sql_type_metadataObject (readonly)

Returns the value of attribute sql_type_metadata



8
9
10
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 8

def 
  @sql_type_metadata
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?



44
45
46
47
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 44

def ==(other)
  other.is_a?(Column) &&
    attributes_for_hash == other.attributes_for_hash
end

#bigint?Boolean

Returns:

  • (Boolean)


32
33
34
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 32

def bigint?
  /bigint/ === sql_type
end

#has_default?Boolean

Returns:

  • (Boolean)


28
29
30
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 28

def has_default?
  !default.nil? || default_function
end

#hashObject



50
51
52
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 50

def hash
  attributes_for_hash.hash
end

#human_nameObject

Returns the human name of the column name.

Examples
Column.new('sales_stage', ...).human_name # => 'Sales stage'


40
41
42
# File 'activerecord/lib/active_record/connection_adapters/column.rb', line 40

def human_name
  Base.human_attribute_name(@name)
end