Module: ActiveRecord::ModelSchema::ClassMethods

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

Instance Method Summary collapse

Instance Method Details

#_default_attributesObject

:nodoc:


474
475
476
477
# File 'activerecord/lib/active_record/model_schema.rb', line 474

def _default_attributes # :nodoc:
  load_schema
  @default_attributes ||= ActiveModel::AttributeSet.new({})
end

#attribute_typesObject

:nodoc:


416
417
418
419
# File 'activerecord/lib/active_record/model_schema.rb', line 416

def attribute_types # :nodoc:
  load_schema
  @attribute_types ||= Hash.new(Type.default_value)
end

#attributes_builderObject

:nodoc:


398
399
400
401
402
403
404
# File 'activerecord/lib/active_record/model_schema.rb', line 398

def attributes_builder # :nodoc:
  unless defined?(@attributes_builder) && @attributes_builder
    defaults = _default_attributes.except(*(column_names - [primary_key]))
    @attributes_builder = ActiveModel::AttributeSet::Builder.new(attribute_types, defaults)
  end
  @attributes_builder
end

#column_defaultsObject

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


469
470
471
472
# File 'activerecord/lib/active_record/model_schema.rb', line 469

def column_defaults
  load_schema
  @column_defaults ||= _default_attributes.deep_dup.to_hash.freeze
end

#column_for_attribute(name) ⇒ Object

Returns the column object for the named attribute. Returns an ActiveRecord::ConnectionAdapters::NullColumn if the named attribute does not exist.

class Person < ActiveRecord::Base
end

person = Person.new
person.column_for_attribute(:name) # the result depends on the ConnectionAdapter
# => #<ActiveRecord::ConnectionAdapters::Column:0x007ff4ab083980 @name="name", @sql_type="varchar(255)", @null=true, ...>

person.column_for_attribute(:nothing)
# => #<ActiveRecord::ConnectionAdapters::NullColumn:0xXXX @name=nil, @sql_type=nil, @cast_type=#<Type::Value>, ...>

460
461
462
463
464
465
# File 'activerecord/lib/active_record/model_schema.rb', line 460

def column_for_attribute(name)
  name = name.to_s
  columns_hash.fetch(name) do
    ConnectionAdapters::NullColumn.new(name)
  end
end

#column_namesObject

Returns an array of column names as strings.


480
481
482
# File 'activerecord/lib/active_record/model_schema.rb', line 480

def column_names
  @column_names ||= columns.map(&:name).freeze
end

#columnsObject


411
412
413
414
# File 'activerecord/lib/active_record/model_schema.rb', line 411

def columns
  load_schema
  @columns ||= columns_hash.values.freeze
end

#columns_hashObject

:nodoc:


406
407
408
409
# File 'activerecord/lib/active_record/model_schema.rb', line 406

def columns_hash # :nodoc:
  load_schema
  @columns_hash
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.


491
492
493
494
495
496
497
# File 'activerecord/lib/active_record/model_schema.rb', line 491

def content_columns
  @content_columns ||= columns.reject do |c|
    c.name == primary_key ||
    c.name == inheritance_column ||
    c.name.end_with?("_id", "_count")
  end.freeze
end

#full_table_name_prefixObject

:nodoc:


276
277
278
# File 'activerecord/lib/active_record/model_schema.rb', line 276

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

#full_table_name_suffixObject

:nodoc:


280
281
282
# File 'activerecord/lib/active_record/model_schema.rb', line 280

def full_table_name_suffix # :nodoc:
  (module_parents.detect { |p| p.respond_to?(:table_name_suffix) } || self).table_name_suffix
end

#ignored_columnsObject

The list of columns names the model should ignore. Ignored columns won't have attribute accessors defined, and won't be referenced in SQL queries.


305
306
307
308
309
310
311
# File 'activerecord/lib/active_record/model_schema.rb', line 305

def ignored_columns
  if defined?(@ignored_columns)
    @ignored_columns
  else
    superclass.ignored_columns
  end
end

#ignored_columns=(columns) ⇒ Object

Sets the columns names the model should ignore. Ignored columns won't have attribute accessors defined, and won't be referenced in SQL queries.

A common usage pattern for this method is to ensure all references to an attribute have been removed and deployed, before a migration to drop the column from the database has been deployed and run. Using this two step approach to dropping columns ensures there is no code that raises errors due to having a cached schema in memory at the time the schema migration is run.

For example, given a model where you want to drop the “category” attribute, first mark it as ignored:

class Project < ActiveRecord::Base
  # schema:
  #   id         :bigint
  #   name       :string, limit: 255
  #   category   :string, limit: 255

  self.ignored_columns = [:category]
end

The schema still contains “category”, but now the model omits it, so any meta-driven code or schema caching will not attempt to use the column:

Project.columns_hash["category"] => nil

You will get an error if accessing that attribute directly, so ensure all usages of the column are removed (automated tests can help you find any usages).

user = Project.create!(name: "First Project")
user.category # => raises NoMethodError

344
345
346
347
# File 'activerecord/lib/active_record/model_schema.rb', line 344

def ignored_columns=(columns)
  reload_schema_from_cache
  @ignored_columns = columns.map(&:to_s).freeze
end

#next_sequence_valueObject

Returns the next value that will be used as the primary key on an insert statement.


389
390
391
# File 'activerecord/lib/active_record/model_schema.rb', line 389

def next_sequence_value
  connection.next_sequence_value(sequence_name)
end

#prefetch_primary_key?Boolean

Determines if the primary key values should be selected from their corresponding sequence before the insert statement.

Returns:

  • (Boolean)

383
384
385
# File 'activerecord/lib/active_record/model_schema.rb', line 383

def prefetch_primary_key?
  connection.prefetch_primary_key?(table_name)
end

#protected_environmentsObject

The array of names of environments where destructive actions should be prohibited. By default, the value is ["production"].


286
287
288
289
290
291
292
# File 'activerecord/lib/active_record/model_schema.rb', line 286

def protected_environments
  if defined?(@protected_environments)
    @protected_environments
  else
    superclass.protected_environments
  end
end

#protected_environments=(environments) ⇒ Object

Sets an array of names of environments where destructive actions should be prohibited.


295
296
297
# File 'activerecord/lib/active_record/model_schema.rb', line 295

def protected_environments=(environments)
  @protected_environments = environments.map(&:to_s)
end

#quoted_table_nameObject

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


261
262
263
# File 'activerecord/lib/active_record/model_schema.rb', line 261

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

#real_inheritance_column=(value) ⇒ Object

:nodoc:


299
300
301
# File 'activerecord/lib/active_record/model_schema.rb', line 299

def real_inheritance_column=(value) # :nodoc:
  self._inheritance_column = value.to_s
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, e.g.:

class CreateJobLevels < ActiveRecord::Migration[7.1]
  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

525
526
527
528
529
530
531
532
# File 'activerecord/lib/active_record/model_schema.rb', line 525

def reset_column_information
  connection.clear_cache!
  ([self] + descendants).each(&:undefine_attribute_methods)
  connection.schema_cache.clear_data_source_cache!(table_name)

  reload_schema_from_cache
  initialize_find_by_cache
end

#reset_sequence_nameObject

:nodoc:


357
358
359
360
# File 'activerecord/lib/active_record/model_schema.rb', line 357

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.


266
267
268
269
270
271
272
273
274
# File 'activerecord/lib/active_record/model_schema.rb', line 266

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


349
350
351
352
353
354
355
# File 'activerecord/lib/active_record/model_schema.rb', line 349

def sequence_name
  if base_class?
    @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, 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

376
377
378
379
# File 'activerecord/lib/active_record/model_schema.rb', line 376

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

#symbol_column_to_string(name_symbol) ⇒ Object

:nodoc:


484
485
486
487
# File 'activerecord/lib/active_record/model_schema.rb', line 484

def symbol_column_to_string(name_symbol) # :nodoc:
  @symbol_column_to_string_name_hash ||= column_names.index_by(&:to_sym)
  @symbol_column_to_string_name_hash[name_symbol]
end

#table_exists?Boolean

Indicates whether the table associated with this class exists

Returns:

  • (Boolean)

394
395
396
# File 'activerecord/lib/active_record/model_schema.rb', line 394

def table_exists?
  connection.schema_cache.data_source_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”.

Active Model Naming's model_name is the base name used to guess the table name. In case a custom Active Model Name is defined, it will be used for the table name as well:

class PostRecord < ActiveRecord::Base
  class << self
    def model_name
      ActiveModel::Name.new(self, nil, "Post")
    end
  end
end

PostRecord.table_name
# => "posts"

You can also set your own table name explicitly:

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

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

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

245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'activerecord/lib/active_record/model_schema.rb', line 245

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
  @predicate_builder = nil
end

#type_for_attribute(attr_name, &block) ⇒ Object

Returns the type of the attribute with the given name, after applying all modifiers. This method is the only valid source of information for anything related to the types of a model's attributes. This method will access the database and load the model's schema if it is required.

The return value of this method will implement the interface described by ActiveModel::Type::Value (though the object itself may not subclass it).

attr_name The name of the attribute to retrieve the type for. Must be a string or a symbol.


436
437
438
439
440
441
442
443
444
445
# File 'activerecord/lib/active_record/model_schema.rb', line 436

def type_for_attribute(attr_name, &block)
  attr_name = attr_name.to_s
  attr_name = attribute_aliases[attr_name] || attr_name

  if block
    attribute_types.fetch(attr_name, &block)
  else
    attribute_types[attr_name]
  end
end

#yaml_encoderObject

:nodoc:


421
422
423
# File 'activerecord/lib/active_record/model_schema.rb', line 421

def yaml_encoder # :nodoc:
  @yaml_encoder ||= ActiveModel::AttributeSet::YAMLEncoder.new(attribute_types)
end