Module: ActiveRecord::ModelSchema::ClassMethods

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

Instance Method Summary collapse

Instance Method Details

#clear_cache!Object

:nodoc:


307
308
309
# File 'activerecord/lib/active_record/model_schema.rb', line 307

def clear_cache! # :nodoc:
  connection.schema_cache.clear!
end

#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.


242
243
244
# File 'activerecord/lib/active_record/model_schema.rb', line 242

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

#column_methods_hashObject

Returns a hash of all the methods added to query each of the columns in the table with the name of the method as the key and true as the value. This makes it possible to do O(1) lookups in respond_to? to check if a given method for attribute is available.


260
261
262
263
264
265
266
267
268
269
# File 'activerecord/lib/active_record/model_schema.rb', line 260

def column_methods_hash #:nodoc:
  @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
    attr_name = attr.to_s
    methods[attr.to_sym]       = attr_name
    methods["#{attr}=".to_sym] = attr_name
    methods["#{attr}?".to_sym] = attr_name
    methods["#{attr}_before_type_cast".to_sym] = attr_name
    methods
  end
end

#column_namesObject

Returns an array of column names as strings.


247
248
249
# File 'activerecord/lib/active_record/model_schema.rb', line 247

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

#columnsObject

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


227
228
229
230
231
232
233
# File 'activerecord/lib/active_record/model_schema.rb', line 227

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.


236
237
238
# File 'activerecord/lib/active_record/model_schema.rb', line 236

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.


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

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

#full_table_name_prefixObject

:nodoc:


155
156
157
# File 'activerecord/lib/active_record/model_schema.rb', line 155

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

#inheritance_columnObject

The name of the column containing the object's class when Single Table Inheritance is used


160
161
162
163
164
165
166
# File 'activerecord/lib/active_record/model_schema.rb', line 160

def inheritance_column
  if self == Base
    'type'
  else
    (@inheritance_column ||= nil) || superclass.inheritance_column
  end
end

#inheritance_column=(value) ⇒ Object

Sets the value of inheritance_column


173
174
175
176
# File 'activerecord/lib/active_record/model_schema.rb', line 173

def inheritance_column=(value)
  @original_inheritance_column = inheritance_column
  @inheritance_column          = value.to_s
end

#original_inheritance_columnObject

:nodoc:


168
169
170
# File 'activerecord/lib/active_record/model_schema.rb', line 168

def original_inheritance_column #:nodoc:
  deprecated_original_property_getter :inheritance_column
end

#original_sequence_nameObject

:nodoc:


190
191
192
# File 'activerecord/lib/active_record/model_schema.rb', line 190

def original_sequence_name #:nodoc:
  deprecated_original_property_getter :sequence_name
end

#original_table_nameObject

:nodoc:


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

def original_table_name #:nodoc:
  deprecated_original_property_getter :table_name
end

#quoted_table_nameObject

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


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

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

297
298
299
300
301
302
303
304
305
# File 'activerecord/lib/active_record/model_schema.rb', line 297

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

  @column_names = @content_columns = @column_defaults = @columns = @columns_hash = nil
  @dynamic_methods_hash = @inheritance_column = nil
  @arel_engine = @relation = nil
end

#reset_sequence_nameObject

:nodoc:


194
195
196
# File 'activerecord/lib/active_record/model_schema.rb', line 194

def reset_sequence_name #:nodoc:
  self.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.


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

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

#sequence_nameObject


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

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

212
213
214
215
# File 'activerecord/lib/active_record/model_schema.rb', line 212

def sequence_name=(value)
  @original_sequence_name = @sequence_name if defined?(@sequence_name)
  @sequence_name          = value.to_s
end

#set_inheritance_column(value = nil, &block) ⇒ Object

:nodoc:


178
179
180
# File 'activerecord/lib/active_record/model_schema.rb', line 178

def set_inheritance_column(value = nil, &block) #:nodoc:
  deprecated_property_setter :inheritance_column, value, block
end

#set_sequence_name(value = nil, &block) ⇒ Object

:nodoc:


217
218
219
# File 'activerecord/lib/active_record/model_schema.rb', line 217

def set_sequence_name(value = nil, &block) #:nodoc:
  deprecated_property_setter :sequence_name, value, block
end

#set_table_name(value = nil, &block) ⇒ Object

:nodoc:


128
129
130
131
132
133
# File 'activerecord/lib/active_record/model_schema.rb', line 128

def set_table_name(value = nil, &block) #:nodoc:
  deprecated_property_setter :table_name, value, block
  @quoted_table_name = nil
  @arel_table        = nil
  @relation          = Relation.new(self, arel_table)
end

#table_exists?Boolean

Indicates whether the table associated with this class exists

Returns:

  • (Boolean)

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

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"

103
104
105
106
# File 'activerecord/lib/active_record/model_schema.rb', line 103

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.


120
121
122
123
124
125
126
# File 'activerecord/lib/active_record/model_schema.rb', line 120

def table_name=(value)
  @original_table_name = @table_name if defined?(@table_name)
  @table_name          = value && value.to_s
  @quoted_table_name   = nil
  @arel_table          = nil
  @relation            = Relation.new(self, arel_table)
end