Module: ActiveRecord::ModelSchema::ClassMethods

Defined in:
activerecord/lib/active_record/model_schema.rb

Instance Method Summary collapse

Instance Method Details

#column_defaultsObject

Returns a hash where the keys are column names and the values are default values when instantiating the AR object for this table.


254
255
256
# File 'activerecord/lib/active_record/model_schema.rb', line 254

def column_defaults
  @column_defaults ||= Hash[columns.map { |c| [c.name, c.default] }]
end

#column_namesObject

Returns an array of column names as strings.


259
260
261
# File 'activerecord/lib/active_record/model_schema.rb', line 259

def column_names
  @column_names ||= columns.map { |column| column.name }
end

#column_typesObject

:nodoc:


226
227
228
# File 'activerecord/lib/active_record/model_schema.rb', line 226

def column_types # :nodoc:
  @column_types ||= decorate_columns(columns_hash.dup)
end

#columnsObject

Returns an array of column objects for the table associated with this class.


213
214
215
216
217
218
219
# File 'activerecord/lib/active_record/model_schema.rb', line 213

def columns
  @columns ||= connection.schema_cache.columns(table_name).map do |col|
    col = col.dup
    col.primary = (col.name == primary_key)
    col
  end
end

#columns_hashObject

Returns a hash of column objects for the table associated with this class.


222
223
224
# File 'activerecord/lib/active_record/model_schema.rb', line 222

def columns_hash
  @columns_hash ||= Hash[columns.map { |c| [c.name, c] }]
end

#content_columnsObject

Returns an array of column objects where the primary id, all columns ending in “_id” or “_count”, and columns used for single table inheritance have been removed.


265
266
267
# File 'activerecord/lib/active_record/model_schema.rb', line 265

def content_columns
  @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
end

#decorate_columns(columns_hash) ⇒ Object

:nodoc:


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'activerecord/lib/active_record/model_schema.rb', line 230

def decorate_columns(columns_hash) # :nodoc:
  return if columns_hash.empty?

  @serialized_column_names ||= self.columns_hash.keys.find_all do |name|
    serialized_attributes.key?(name)
  end

  @serialized_column_names.each do |name|
    columns_hash[name] = AttributeMethods::Serialization::Type.new(columns_hash[name])
  end

  @time_zone_column_names ||= self.columns_hash.find_all do |name, col|
    create_time_zone_conversion_attribute?(name, col)
  end.map!(&:first)

  @time_zone_column_names.each do |name|
    columns_hash[name] = AttributeMethods::TimeZoneConversion::Type.new(columns_hash[name])
  end

  columns_hash
end

#full_table_name_prefixObject

:nodoc:


152
153
154
# File 'activerecord/lib/active_record/model_schema.rb', line 152

def full_table_name_prefix #:nodoc:
  (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
end

#inheritance_columnObject

Defines the name of the table column which will store the class name on single-table inheritance situations.

The default inheritance column name is type, which means it's a reserved word inside Active Record. To be able to use single-table inheritance with another column name, or to use the column type in your own model for something else, you can set inheritance_column:

self.inheritance_column = 'zoink'

165
166
167
# File 'activerecord/lib/active_record/model_schema.rb', line 165

def inheritance_column
  (@inheritance_column ||= nil) || superclass.inheritance_column
end

#inheritance_column=(value) ⇒ Object

Sets the value of inheritance_column


170
171
172
173
# File 'activerecord/lib/active_record/model_schema.rb', line 170

def inheritance_column=(value)
  @inheritance_column = value.to_s
  @explicit_inheritance_column = true
end

#initialize_attributes(attributes, options = {}) ⇒ Object

This is a hook for use by modules that need to do extra stuff to attributes when they are initialized. (e.g. attribute serialization)


318
319
320
# File 'activerecord/lib/active_record/model_schema.rb', line 318

def initialize_attributes(attributes, options = {}) #:nodoc:
  attributes
end

#quoted_table_nameObject

Returns a quoted version of the table name, used to construct SQL statements.


137
138
139
# File 'activerecord/lib/active_record/model_schema.rb', line 137

def quoted_table_name
  @quoted_table_name ||= connection.quote_table_name(table_name)
end

#reset_column_informationObject

Resets all the cached information about columns, which will cause them to be reloaded on the next request.

The most common usage pattern for this method is probably in a migration, when just after creating a table you want to populate it with some default values, eg:

class CreateJobLevels < ActiveRecord::Migration
  def up
    create_table :job_levels do |t|
      t.integer :id
      t.string :name

      t.timestamps
    end

    JobLevel.reset_column_information
    %w{assistant executive manager director}.each do |type|
      JobLevel.create(name: type)
    end
  end

  def down
    drop_table :job_levels
  end
end

295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'activerecord/lib/active_record/model_schema.rb', line 295

def reset_column_information
  connection.clear_cache!
  undefine_attribute_methods
  connection.schema_cache.clear_table_cache!(table_name) if table_exists?

  @arel_engine             = nil
  @column_defaults         = nil
  @column_names            = nil
  @columns                 = nil
  @columns_hash            = nil
  @column_types            = nil
  @content_columns         = nil
  @dynamic_methods_hash    = nil
  @inheritance_column      = nil unless defined?(@explicit_inheritance_column) && @explicit_inheritance_column
  @relation                = nil
  @serialized_column_names = nil
  @time_zone_column_names  = nil
  @cached_time_zone        = nil
end

#reset_sequence_nameObject

:nodoc:


183
184
185
186
# File 'activerecord/lib/active_record/model_schema.rb', line 183

def reset_sequence_name #:nodoc:
  @explicit_sequence_name = false
  @sequence_name          = connection.default_sequence_name(table_name, primary_key)
end

#reset_table_nameObject

Computes the table name, (re)sets it internally, and returns it.


142
143
144
145
146
147
148
149
150
# File 'activerecord/lib/active_record/model_schema.rb', line 142

def reset_table_name #:nodoc:
  self.table_name = if abstract_class?
    superclass == Base ? nil : superclass.table_name
  elsif superclass.abstract_class?
    superclass.table_name || compute_table_name
  else
    compute_table_name
  end
end

#sequence_nameObject


175
176
177
178
179
180
181
# File 'activerecord/lib/active_record/model_schema.rb', line 175

def sequence_name
  if base_class == self
    @sequence_name ||= reset_sequence_name
  else
    (@sequence_name ||= nil) || base_class.sequence_name
  end
end

#sequence_name=(value) ⇒ Object

Sets the name of the sequence to use when generating ids to the given value, or (if the value is nil or false) to the value returned by the given block. This is required for Oracle and is useful for any database which relies on sequences for primary key generation.

If a sequence name is not explicitly set when using Oracle or Firebird, it will default to the commonly used pattern of: ##table_name_seq

If a sequence name is not explicitly set when using PostgreSQL, it will discover the sequence corresponding to your primary key for you.

class Project < ActiveRecord::Base
  self.sequence_name = "projectseq"   # default would have been "project_seq"
end

202
203
204
205
# File 'activerecord/lib/active_record/model_schema.rb', line 202

def sequence_name=(value)
  @sequence_name          = value.to_s
  @explicit_sequence_name = true
end

#table_exists?Boolean

Indicates whether the table associated with this class exists

Returns:

  • (Boolean)

208
209
210
# File 'activerecord/lib/active_record/model_schema.rb', line 208

def table_exists?
  connection.schema_cache.table_exists?(table_name)
end

#table_nameObject

Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.

Nested classes are given table names prefixed by the singular form of the parent's table name. Enclosing modules are not considered.

Examples

class Invoice < ActiveRecord::Base
end

file                  class               table_name
invoice.rb            Invoice             invoices

class Invoice < ActiveRecord::Base
  class Lineitem < ActiveRecord::Base
  end
end

file                  class               table_name
invoice.rb            Invoice::Lineitem   invoice_lineitems

module Invoice
  class Lineitem < ActiveRecord::Base
  end
end

file                  class               table_name
invoice/lineitem.rb   Invoice::Lineitem   lineitems

Additionally, the class-level table_name_prefix is prepended and the table_name_suffix is appended. So if you have “myapp_” as a prefix, the table name guess for an Invoice class becomes “myapp_invoices”. Invoice::Lineitem becomes “myapp_invoice_lineitems”.

You can also set your own table name explicitly:

class Mouse < ActiveRecord::Base
  self.table_name = "mice"
end

Alternatively, you can override the table_name method to define your own computation. (Possibly using super to manipulate the default table name.) Example:

class Post < ActiveRecord::Base
  def self.table_name
    "special_" + super
  end
end
Post.table_name # => "special_posts"

108
109
110
111
# File 'activerecord/lib/active_record/model_schema.rb', line 108

def table_name
  reset_table_name unless defined?(@table_name)
  @table_name
end

#table_name=(value) ⇒ Object

Sets the table name explicitly. Example:

class Project < ActiveRecord::Base
  self.table_name = "project"
end

You can also just define your own self.table_name method; see the documentation for ActiveRecord::Base#table_name.


121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'activerecord/lib/active_record/model_schema.rb', line 121

def table_name=(value)
  value = value && value.to_s

  if defined?(@table_name)
    return if value == @table_name
    reset_column_information if connected?
  end

  @table_name        = value
  @quoted_table_name = nil
  @arel_table        = nil
  @sequence_name     = nil unless defined?(@explicit_sequence_name) && @explicit_sequence_name
  @relation          = Relation.create(self, arel_table)
end