Skip to Content Skip to Search
Namespace
Methods
#
C
D
E
F
H
I
N
P
R
S

Attributes

[R] strict_loading_mode

Class Public methods

configurations()

Returns fully resolved ActiveRecord::DatabaseConfigurations object

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

configurations=(config)

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"}>
]>
# File activerecord/lib/active_record/core.rb, line 70
def self.configurations=(config)
  @@configurations = ActiveRecord::DatabaseConfigurations.new(config)
end

connection_handler()

# File activerecord/lib/active_record/core.rb, line 116
def self.connection_handler
  ActiveSupport::IsolatedExecutionState[:active_record_connection_handler] || default_connection_handler
end

connection_handler=(handler)

# File activerecord/lib/active_record/core.rb, line 120
def self.connection_handler=(handler)
  ActiveSupport::IsolatedExecutionState[:active_record_connection_handler] = handler
end

current_preventing_writes()

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
# File activerecord/lib/active_record/core.rb, line 179
def self.current_preventing_writes
  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_class_for_self)
  end

  false
end

current_role()

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
# File activerecord/lib/active_record/core.rb, line 142
def self.current_role
  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_class_for_self)
  end

  default_role
end

current_shard()

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
# File activerecord/lib/active_record/core.rb, line 160
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_class_for_self)
  end

  default_shard
end

destroy_association_async_job()

The job class used to destroy associations in the background.

# File activerecord/lib/active_record/core.rb, line 26
def self.destroy_association_async_job
  if _destroy_association_async_job.is_a?(String)
    self._destroy_association_async_job = _destroy_association_async_job.constantize
  end
  _destroy_association_async_job
rescue NameError => error
  raise NameError, "Unable to load destroy_association_async_job: #{error.message}"
end

new(attributes = nil)

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')
# File activerecord/lib/active_record/core.rb, line 445
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

Instance Public methods

<=>(other_object)

Allows sort on objects

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

==(comparison_object)

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?
# File activerecord/lib/active_record/core.rb, line 565
def ==(comparison_object)
  super ||
    comparison_object.instance_of?(self.class) &&
    !id.nil? &&
    comparison_object.id == id
end

clone

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
# File activerecord/lib/active_record/core.rb, line 497
    

connection_handler()

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

dup

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) and locking column.

# File activerecord/lib/active_record/core.rb, line 514
    

encode_with(coder)

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, ... }}
# File activerecord/lib/active_record/core.rb, line 550
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)

Alias for: ==

freeze()

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

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

frozen?()

Returns true if the attributes hash has been frozen.

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

hash()

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) ]
# File activerecord/lib/active_record/core.rb, line 575
def hash
  id = self.id

  if id
    self.class.hash ^ id.hash
  else
    super
  end
end

init_with(coder, &block)

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'
# File activerecord/lib/active_record/core.rb, line 472
def init_with(coder, &block)
  coder = LegacyYamlAdapter.convert(coder)
  attributes = self.class.yaml_encoder.decode(coder)
  init_with_attributes(attributes, coder["new_record"], &block)
end

inspect()

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

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

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

pretty_print(pp)

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

# File activerecord/lib/active_record/core.rb, line 690
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!()

Marks this record as read only.

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

readonly?()

Returns true if the record is read only.

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

slice(*methods)

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

# File activerecord/lib/active_record/core.rb, line 714
    

strict_loading!(value = true, mode: :all)

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! # => true
user.comments
=> ActiveRecord::StrictLoadingViolationError

Parameters:

  • value - Boolean specifying whether to enable or disable strict loading.

  • mode - Symbol specifying strict loading mode. Defaults to :all. Using

    :n_plus_one_only mode will only raise an error if an association
    that will lead to an n plus one query is lazily loaded.
    

Example:

user = User.first
user.strict_loading!(false) # => false
user.comments
=> #<ActiveRecord::Associations::CollectionProxy>
# File activerecord/lib/active_record/core.rb, line 646
def strict_loading!(value = true, mode: :all)
  unless [:all, :n_plus_one_only].include?(mode)
    raise ArgumentError, "The :mode option must be one of [:all, :n_plus_one_only] but #{mode.inspect} was provided."
  end

  @strict_loading_mode = mode
  @strict_loading = value
end

strict_loading?()

Returns true if the record is in strict_loading mode.

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

strict_loading_n_plus_one_only?()

Returns true if the record uses strict_loading with :n_plus_one_only mode enabled.

# File activerecord/lib/active_record/core.rb, line 658
def strict_loading_n_plus_one_only?
  @strict_loading_mode == :n_plus_one_only
end