ActiveRecord::Core

action_on_strict_loading_violation Link

Set the application to log or raise when an association violates strict loading. Defaults to :raise.

# File rails/activerecord/lib/active_record/core.rb, line 140
mattr_accessor :action_on_strict_loading_violation, instance_accessor: false, default: :raise

configurations() Link

Returns fully resolved ActiveRecord::DatabaseConfigurations object

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 69
def self.configurations
  @@configurations
end

configurations=(config) Link

Contains the database configuration - as is typically stored in config/database.yml - as an ActiveRecord::DatabaseConfigurations object.

For example, the following database.yml…

development:
  adapter: sqlite3
  database: db/development.sqlite3

production:
  adapter: sqlite3
  database: db/production.sqlite3

…would result in ActiveRecord::Base.configurations to look like this:

#<ActiveRecord::DatabaseConfigurations:0x00007fd1acbdf800 @configurations=[
  #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10 @env_name="development",
    @name="primary", @config={adapter: "sqlite3", database: "db/development.sqlite3"}>,
  #<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbdea90 @env_name="production",
    @name="primary", @config={adapter: "sqlite3", database: "db/production.sqlite3"}>
]>

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 63
def self.configurations=(config)
  @@configurations = ActiveRecord::DatabaseConfigurations.new(config)
end

connection_class() Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 269
def self.connection_class # :nodoc
  @connection_class ||= false
end

connection_handler() Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 168
def self.connection_handler
  Thread.current.thread_variable_get(:ar_connection_handler) || default_connection_handler
end

connection_handler=(handler) Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 172
def self.connection_handler=(handler)
  Thread.current.thread_variable_set(:ar_connection_handler, handler)
end

connection_handlers() Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 176
def self.connection_handlers
  unless legacy_connection_handling
    raise NotImplementedError, "The new connection handling does not support accessing multiple connection handlers."
  end

  @@connection_handlers ||= {}
end

connection_handlers=(handlers) Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 184
def self.connection_handlers=(handlers)
  unless legacy_connection_handling
    raise NotImplementedError, "The new connection handling does not setting support multiple connection handlers."
  end

  @@connection_handlers = handlers
end

current_preventing_writes() Link

Returns the symbol representing the current setting for preventing writes.

ActiveRecord::Base.connected_to(role: :reading) do
  ActiveRecord::Base.current_preventing_writes #=> true
end

ActiveRecord::Base.connected_to(role: :writing) do
  ActiveRecord::Base.current_preventing_writes #=> false
end

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 242
def self.current_preventing_writes
  if legacy_connection_handling
    connection_handler.prevent_writes
  else
    connected_to_stack.reverse_each do |hash|
      return hash[:prevent_writes] if !hash[:prevent_writes].nil? && hash[:klasses].include?(Base)
      return hash[:prevent_writes] if !hash[:prevent_writes].nil? && hash[:klasses].include?(connection_classes)
    end

    false
  end
end

current_role() Link

Returns the symbol representing the current connected role.

ActiveRecord::Base.connected_to(role: :writing) do
  ActiveRecord::Base.current_role #=> :writing
end

ActiveRecord::Base.connected_to(role: :reading) do
  ActiveRecord::Base.current_role #=> :reading
end

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 201
def self.current_role
  if ActiveRecord::Base.legacy_connection_handling
    connection_handlers.key(connection_handler) || default_role
  else
    connected_to_stack.reverse_each do |hash|
      return hash[:role] if hash[:role] && hash[:klasses].include?(Base)
      return hash[:role] if hash[:role] && hash[:klasses].include?(connection_classes)
    end

    default_role
  end
end

current_shard() Link

Returns the symbol representing the current connected shard.

ActiveRecord::Base.connected_to(role: :reading) do
  ActiveRecord::Base.current_shard #=> :default
end

ActiveRecord::Base.connected_to(role: :writing, shard: :one) do
  ActiveRecord::Base.current_shard #=> :one
end

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 223
def self.current_shard
  connected_to_stack.reverse_each do |hash|
    return hash[:shard] if hash[:shard] && hash[:klasses].include?(Base)
    return hash[:shard] if hash[:shard] && hash[:klasses].include?(connection_classes)
  end

  default_shard
end

default_timezone Link

Determines whether to use Time.utc (using :utc) or Time.local (using :local) when pulling dates and times from the database. This is set to :utc by default.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 77
mattr_accessor :default_timezone, instance_writer: false, default: :utc

destroy_association_async_job Link

Specifies the job used to destroy associations in the background

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 39
class_attribute :destroy_association_async_job, instance_writer: false, instance_predicate: false, default: false

dump_schema_after_migration Link

Specify whether schema dump should happen at the end of the db:migrate rails command. This is true by default, which is useful for the development environment. This should ideally be false in the production environment where dumping schema is rarely needed.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 107
mattr_accessor :dump_schema_after_migration, instance_writer: false, default: true

dump_schemas Link

Specifies which database schemas to dump when calling db:schema:dump. If the value is :schema_search_path (the default), any schemas listed in schema_search_path are dumped. Use :all to dump all schemas regardless of schema_search_path, or a string of comma separated schemas for a custom list.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 116
mattr_accessor :dump_schemas, instance_writer: false, default: :schema_search_path

error_on_ignored_order Link

Specifies if an error should be raised if the query has an order being ignored when doing batch queries. Useful in applications where the scope being ignored is error-worthy, rather than a warning.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 94
mattr_accessor :error_on_ignored_order, instance_writer: false, default: false

logger Link

Accepts a logger conforming to the interface of Log4r which is then passed on to any new database connections made and which can be retrieved on both a class and instance level by calling logger.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 20
mattr_accessor :logger, instance_writer: false

new(attributes = nil) Link

New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes but not yet saved (pass a hash with key names matching the associated table column names). In both instances, valid attribute keys are determined by the column names of the associated table – hence you can’t have attributes that aren’t part of the table columns.

Example:

# Instantiates a single new object
User.new(first_name: 'Jamie')

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 511
def initialize(attributes = nil)
  @new_record = true
  @attributes = self.class._default_attributes.deep_dup

  init_internals
  initialize_internals_callback

  assign_attributes(attributes) if attributes

  yield self if block_given?
  _run_initialize_callbacks
end

queues Link

Specifies the names of the queues used by background jobs.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 33
mattr_accessor :queues, instance_accessor: false, default: {}

schema_format Link

Specifies the format to use when dumping the database schema with Rails’ Rakefile. If :sql, the schema is dumped as (potentially database- specific) SQL statements. If :ruby, the schema is dumped as an ActiveRecord::Schema file which can be loaded into any database that supports migrations. Use :ruby if you want to have different database adapters for, e.g., your development and test environments.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 87
mattr_accessor :schema_format, instance_writer: false, default: :ruby

suppress_multiple_database_warning Link

Show a warning when Rails couldn’t parse your database.yml for multiple databases.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 130
mattr_accessor :suppress_multiple_database_warning, instance_writer: false, default: false

timestamped_migrations Link

Specify whether or not to use timestamps for migration versions

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 99
mattr_accessor :timestamped_migrations, instance_writer: false, default: true

verbose_query_logs Link

Specifies if the methods calling database queries should be logged below their relevant queries. Defaults to false.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 27
mattr_accessor :verbose_query_logs, instance_writer: false, default: false

warn_on_records_fetched_greater_than Link

Specify a threshold for the size of query result sets. If the number of records in the set exceeds the threshold, a warning is logged. This can be used to identify queries which load thousands of records and potentially cause memory bloat.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 124
mattr_accessor :warn_on_records_fetched_greater_than, instance_writer: false

<=>(other_object) Link

Allows sort on objects

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 662
def <=>(other_object)
  if other_object.is_a?(self.class)
    to_key <=> other_object.to_key
  else
    super
  end
end

==(comparison_object) Link

Returns true if comparison_object is the same exact object, or comparison_object is of the same type and self has an ID and it is equal to comparison_object.id.

Note that new records are different from any other record by definition, unless the other record is the receiver itself. Besides, if you fetch existing records with select and leave the ID out, you’re on your own, this predicate will return false.

Note also that destroying a record preserves its ID in the model instance, so deleted models are still comparable.

Also aliased as: eql?

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 630
def ==(comparison_object)
  super ||
    comparison_object.instance_of?(self.class) &&
    !id.nil? &&
    comparison_object.id == id
end

clone Link

Identical to Ruby’s clone method. This is a “shallow” copy. Be warned that your attributes are not copied. That means that modifying attributes of the clone will modify the original, since they will both point to the same attributes hash. If you need a copy of your attributes hash, please use the dup method.

user = User.first
new_user = user.clone
user.name               # => "Bob"
new_user.name = "Joe"
user.name               # => "Joe"

user.object_id == new_user.object_id            # => false
user.name.object_id == new_user.name.object_id  # => true

user.name.object_id == user.dup.name.object_id  # => false

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 563

connection_handler() Link

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 704
def connection_handler
  self.class.connection_handler
end

dup Link

Duped objects have no id assigned and are treated as new records. Note that this is a “shallow” copy as it copies the object’s attributes only, not its associations. The extent of a “deep” copy is application specific and is therefore left to the application to implement according to its need. The dup method does not preserve the timestamps (created|updated)_(at|on).

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 580

encode_with(coder) Link

Populate coder with attributes about this record that should be serialized. The structure of coder defined in this method is guaranteed to match the structure of coder passed to the init_with method.

Example:

class Post < ActiveRecord::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 615
def encode_with(coder)
  self.class.yaml_encoder.encode(@attributes, coder)
  coder["new_record"] = new_record?
  coder["active_record_yaml_version"] = 2
end

eql?(comparison_object) Link

Alias for: ==

freeze() Link

Clone and freeze the attributes hash such that associations are still accessible, even on destroyed records, but cloned models will not be frozen.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 651
def freeze
  @attributes = @attributes.clone.freeze
  self
end

frozen?() Link

Returns true if the attributes hash has been frozen.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 657
def frozen?
  @attributes.frozen?
end

hash() Link

Delegates to id in order to allow two records of the same type and id to work with something like:

[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 640
def hash
  if id
    self.class.hash ^ id.hash
  else
    super
  end
end

init_with(coder, &block) Link

Initialize an empty model object from coder. coder should be the result of previously encoding an Active Record model, using encode_with.

class Post < ActiveRecord::Base
end

old_post = Post.new(title: "hello world")
coder = {}
old_post.encode_with(coder)

post = Post.allocate
post.init_with(coder)
post.title # => 'hello world'

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 538
def init_with(coder, &block)
  coder = LegacyYamlAdapter.convert(self.class, coder)
  attributes = self.class.yaml_encoder.decode(coder)
  init_with_attributes(attributes, coder["new_record"], &block)
end

inspect() Link

Returns the contents of the record as a nicely formatted string.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 709
def inspect
  # We check defined?(@attributes) not to issue warnings if the object is
  # allocated but not initialized.
  inspection = if defined?(@attributes) && @attributes
    self.class.attribute_names.collect do |name|
      if _has_attribute?(name)
        "#{name}: #{attribute_for_inspect(name)}"
      end
    end.compact.join(", ")
  else
    "not initialized"
  end

  "#<#{self.class} #{inspection}>"
end

pretty_print(pp) Link

Takes a PP and prettily prints this record to it, allowing you to get a nice result from pp record when pp is required.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 727
def pretty_print(pp)
  return super if custom_inspect_method_defined?
  pp.object_address_group(self) do
    if defined?(@attributes) && @attributes
      attr_names = self.class.attribute_names.select { |name| _has_attribute?(name) }
      pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
        pp.breakable " "
        pp.group(1) do
          pp.text attr_name
          pp.text ":"
          pp.breakable
          value = _read_attribute(attr_name)
          value = inspection_filter.filter_param(attr_name, value) unless value.nil?
          pp.pp value
        end
      end
    else
      pp.breakable " "
      pp.text "not initialized"
    end
  end
end

readonly!() Link

Marks this record as read only.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 700
def readonly!
  @readonly = true
end

readonly?() Link

Returns true if the record is read only.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 679
def readonly?
  @readonly
end

slice(*methods) Link

Returns a hash of the given methods with their names as keys and returned values as values.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 751
def slice(*methods)
  methods.flatten.index_with { |method| public_send(method) }.with_indifferent_access
end

strict_loading!() Link

Sets the record to strict_loading mode. This will raise an error if the record tries to lazily load an association.

user = User.first
user.strict_loading!
user.comments.to_a
=> ActiveRecord::StrictLoadingViolationError

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 695
def strict_loading!
  @strict_loading = true
end

strict_loading?() Link

Returns true if the record is in strict_loading mode.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 684
def strict_loading?
  @strict_loading
end

values_at(*methods) Link

Returns an array of the values returned by the given methods.

Source: show | on GitHub

# File rails/activerecord/lib/active_record/core.rb, line 756
def values_at(*methods)
  methods.flatten.map! { |method| public_send(method) }
end

Module ActiveRecord::Core

Class Public methods

action_on_strict_loading_violation Link

configurations() Link

configurations=(config) Link

connection_class() Link

connection_handler() Link

connection_handler=(handler) Link

connection_handlers() Link

connection_handlers=(handlers) Link

current_preventing_writes() Link

current_role() Link

current_shard() Link

default_timezone Link

destroy_association_async_job Link

dump_schema_after_migration Link

dump_schemas Link

error_on_ignored_order Link

logger Link

new(attributes = nil) Link

Example:

queues Link

schema_format Link

suppress_multiple_database_warning Link

timestamped_migrations Link

verbose_query_logs Link

warn_on_records_fetched_greater_than Link

Instance Public methods

<=>(other_object) Link

==(comparison_object) Link

clone Link

connection_handler() Link

dup Link

encode_with(coder) Link

eql?(comparison_object) Link

freeze() Link

frozen?() Link

hash() Link

init_with(coder, &block) Link

inspect() Link

pretty_print(pp) Link

readonly!() Link

readonly?() Link

slice(*methods) Link

strict_loading!() Link

strict_loading?() Link

values_at(*methods) Link