class ActiveRecord::Relation

Active Record Relation

def ==(other)

Compares two relations for equality.
def ==(other)
  case other
  when Associations::CollectionProxy, AssociationRelation
    self == other.records
  when Relation
    other.to_sql == to_sql
  when Array
    records == other
  end
end

def _create(attributes, &block)

def _create(attributes, &block)
  model.create(attributes, &block)
end

def _create!(attributes, &block)

def _create!(attributes, &block)
  model.create!(attributes, &block)
end

def _exec_scope(...) # :nodoc:

:nodoc:
def _exec_scope(...) # :nodoc:
  @delegate_to_model = true
  registry = model.scope_registry
  _scoping(nil, registry) { instance_exec(...) || self }
ensure
  @delegate_to_model = false
end

def _increment_attribute(attribute, value = 1)

def _increment_attribute(attribute, value = 1)
  bind = predicate_builder.build_bind_attribute(attribute.name, value.abs)
  expr = table.coalesce(Arel::Nodes::UnqualifiedColumn.new(attribute), 0)
  expr = value < 0 ? expr - bind : expr + bind
  expr.expr
end

def _new(attributes, &block)

def _new(attributes, &block)
  model.new(attributes, &block)
end

def _scoping(scope, registry, all_queries = false)

def _scoping(scope, registry, all_queries = false)
  previous = registry.current_scope(model, true)
  registry.set_current_scope(model, scope)
  if all_queries
    previous_global = registry.global_current_scope(model, true)
    registry.set_global_current_scope(model, scope)
  end
  yield
ensure
  registry.set_current_scope(model, previous)
  if all_queries
    registry.set_global_current_scope(model, previous_global)
  end
end

def _substitute_values(values)

def _substitute_values(values)
  values.map do |name, value|
    attr = table[name]
    if Arel.arel_node?(value)
      if value.is_a?(Arel::Nodes::SqlLiteral)
        value = Arel::Nodes::Grouping.new(value)
      end
    else
      type = model.type_for_attribute(attr.name)
      value = predicate_builder.build_bind_attribute(attr.name, type.cast(value))
    end
    [attr, value]
  end
end

def alias_tracker(joins = [], aliases = nil) # :nodoc:

:nodoc:
def alias_tracker(joins = [], aliases = nil) # :nodoc:
  ActiveRecord::Associations::AliasTracker.create(model.connection_pool, table.name, joins, aliases)
end

def already_in_scope?(registry)

def already_in_scope?(registry)
  @delegate_to_model && registry.current_scope(model, true)
end

def any?(*args)

posts.any?(Post) # => true or false

the Enumerable match the pattern via the case-equality operator (===).
When a pattern argument is given, this method checks whether elements in

Returns true if there are any records.
def any?(*args)
  return false if @none
  return super if args.present? || block_given?
  !empty?
end

def bind_attribute(name, value) # :nodoc:

:nodoc:
def bind_attribute(name, value) # :nodoc:
  if reflection = model._reflect_on_association(name)
    name = reflection.foreign_key
    value = value.read_attribute(reflection.association_primary_key) unless value.nil?
  end
  attr = table[name]
  bind = predicate_builder.build_bind_attribute(attr.name, value)
  yield attr, bind
end

def blank?

Returns true if relation is blank.
def blank?
  records.blank?
end

def cache_key(timestamp_column = "updated_at")

Product.where("name like ?", "%Game%").cache_key(:last_reviewed_at)

last updated record.
You can also pass a custom timestamp column to fetch the timestamp of the

# => "products/query-1850ab3d302391b85b8693e941286659-1-20150714212553907087000"
Product.where("name like ?", "%Cosmic Encounter%").cache_key
ActiveRecord::Base.collection_cache_versioning = false

in \Rails 6.0 and earlier, the cache key will also include a version.
If ActiveRecord::Base.collection_cache_versioning is turned off, as it was

# => "products/query-1850ab3d302391b85b8693e941286659"
Product.where("name like ?", "%Cosmic Encounter%").cache_key

The cache key is built with a fingerprint of the SQL query.
Returns a stable cache key that can be used to identify this query.
def cache_key(timestamp_column = "updated_at")
  @cache_keys ||= {}
  @cache_keys[timestamp_column] ||= model.collection_cache_key(self, timestamp_column)
end

def cache_key_with_version

Returns a cache key along with the version.
def cache_key_with_version
  if version = cache_version
    "#{cache_key}-#{version}"
  else
    cache_key
  end
end

def cache_version(timestamp_column = :updated_at)

SELECT COUNT(*), MAX("products"."updated_at") FROM "products" WHERE (name like '%Cosmic Encounter%')

to generate the timestamp, otherwise it will trigger one SQL query like:
If the collection is loaded, the method will iterate through the records

the cache version changes.
comes to match the query, or any of the existing records is updated or deleted,
matching the query, and the timestamp of the last updated record. When a new record
a recyclable caching scheme. The cache version is built with the number of records
Returns a cache version that can be used together with the cache key to form
def cache_version(timestamp_column = :updated_at)
  if model.collection_cache_versioning
    @cache_versions ||= {}
    @cache_versions[timestamp_column] ||= compute_cache_version(timestamp_column)
  end
end

def compute_cache_key(timestamp_column = :updated_at) # :nodoc:

:nodoc:
def compute_cache_key(timestamp_column = :updated_at) # :nodoc:
  query_signature = ActiveSupport::Digest.hexdigest(to_sql)
  key = "#{model.model_name.cache_key}/query-#{query_signature}"
  if model.collection_cache_versioning
    key
  else
    "#{key}-#{compute_cache_version(timestamp_column)}"
  end
end

def compute_cache_version(timestamp_column) # :nodoc:

:nodoc:
def compute_cache_version(timestamp_column) # :nodoc:
  timestamp_column = timestamp_column.to_s
  if loaded?
    size = records.size
    if size > 0
      timestamp = records.map { |record| record.read_attribute(timestamp_column) }.max
    end
  else
    collection = eager_loading? ? apply_join_dependency : self
    with_connection do |c|
      column = c.visitor.compile(table[timestamp_column])
      select_values = "COUNT(*) AS #{model.adapter_class.quote_column_name("size")}, MAX(%s) AS timestamp"
      if collection.has_limit_or_offset?
        query = collection.select("#{column} AS collection_cache_key_timestamp")
        query._select!(table[Arel.star]) if distinct_value && collection.select_values.empty?
        subquery_alias = "subquery_for_cache_key"
        subquery_column = "#{subquery_alias}.collection_cache_key_timestamp"
        arel = query.build_subquery(subquery_alias, select_values % subquery_column)
      else
        query = collection.unscope(:order)
        query.select_values = [select_values % column]
        arel = query.arel
      end
      size, timestamp = c.select_rows(arel, nil).first
      if size
        column_type = model.type_for_attribute(timestamp_column)
        timestamp = column_type.deserialize(timestamp)
      else
        size = 0
      end
    end
  end
  if timestamp
    "#{size}-#{timestamp.utc.to_fs(model.cache_timestamp_format)}"
  else
    "#{size}"
  end
end

def create(attributes = nil, &block)

# => #
users.create(name: nil) # validation on name

# => #
users.create { |user| user.name = 'tenderlove' }

users.create # => #
users.create(name: 'fxn')

users.create # => #
users = User.where(name: 'Oscar')

==== Examples

{ActiveRecord::Base.create}[rdoc-ref:Persistence::ClassMethods#create].
Expects arguments in the same format as

defined in the relation. Returns the initialized object if validation fails.
Tries to create a new record with the same scoped attributes
def create(attributes = nil, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| create(attr, &block) }
  else
    block = current_scope_restoring_block(&block)
    scoping { _create(attributes, &block) }
  end
end

def create!(attributes = nil, &block)

{ActiveRecord::Base.create!}[rdoc-ref:Persistence::ClassMethods#create!].
Expects arguments in the same format as

on the base class. Raises an exception if a validation error occurs.
{create!}[rdoc-ref:Persistence::ClassMethods#create!]
Similar to #create, but calls
def create!(attributes = nil, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| create!(attr, &block) }
  else
    block = current_scope_restoring_block(&block)
    scoping { _create!(attributes, &block) }
  end
end

def create_or_find_by(attributes, &block)

such situation.
and failed due to validation errors it won't be persisted, you get what #create returns in
(unless the INSERT -> DELETE -> SELECT race condition is triggered), but if creation was attempted
This method will return a record if all given attributes are covered by unique constraints

otherwise #create will fail due to validation errors and #find_by will never be called.
* Columns with unique database constraints should not have uniqueness validations defined,
to this problem).
key of type int (note: All \Rails apps since 5.1+ have defaulted to bigint, which is not liable
the problem of running out of integers, if the underlying table is still stuck on a primary
* The primary key may auto-increment on each create, even if it fails. This can accelerate
* It relies on exception handling to handle control flow, which may be marginally slower.
that's a significantly less likely condition to hit.
if a DELETE between those two statements is run by another client. But for most applications,
we actually have another race condition between INSERT -> SELECT, which can be triggered
* While we avoid the race condition between SELECT -> INSERT from #find_or_create_by,
rather than a record with the given attributes.
matching record, which will then raise an ActiveRecord::RecordNotFound exception,
of the given attributes. This means that the subsequent #find_by! may fail to find a
* A unique constraint violation may be triggered by only one, or at least less than all,
* The underlying table must have the relevant columns defined with unique database constraints.

There are several drawbacks to #create_or_find_by, though:

better suited for cases where the record is most likely not to exist yet.
This is similar to #find_or_create_by, but tries to create the record first. As such it is

and the existing record with those attributes is found using #find_by!.
unique constraints, the exception such an insertion would normally raise is caught,
on one or several of its columns. If a row already exists with one or several of these
Attempts to create a record with the given attributes in a table that has a unique database constraint
def create_or_find_by(attributes, &block)
  with_connection do |connection|
    transaction(requires_new: true) { create(attributes, &block) }
  rescue ActiveRecord::RecordNotUnique
    if connection.transaction_open?
      where(attributes).lock.find_by!(attributes)
    else
      find_by!(attributes)
    end
  end
end

def create_or_find_by!(attributes, &block)

is raised if the created record is invalid.
{create!}[rdoc-ref:Persistence::ClassMethods#create!] so an exception
Like #create_or_find_by, but calls
def create_or_find_by!(attributes, &block)
  with_connection do |connection|
    transaction(requires_new: true) { create!(attributes, &block) }
  rescue ActiveRecord::RecordNotUnique
    if connection.transaction_open?
      where(attributes).lock.find_by!(attributes)
    else
      find_by!(attributes)
    end
  end
end

def current_scope_restoring_block(&block)

def current_scope_restoring_block(&block)
  current_scope = model.current_scope(true)
  -> record do
    model.current_scope = current_scope
    yield record if block_given?
  end
end

def delete(id_or_array)

Todo.delete([2,3,4])
# Delete multiple rows

Todo.delete(1)
# Delete a single row

==== Examples

that ensures referential integrity or performs other essential jobs.
skipping callbacks might bypass business logic in your application
Note: Although it is often much faster than the alternative, #destroy,

You can delete multiple rows at once by passing an Array of ids.

executed, including any :dependent association options.
Record objects are not instantiated, so the object's callbacks are not
SQL +DELETE+ statement, and returns the number of rows deleted. Active
Deletes the row with a primary key matching the +id+ argument, using an
def delete(id_or_array)
  return 0 if id_or_array.nil? || (id_or_array.is_a?(Array) && id_or_array.empty?)
  where(model.primary_key => id_or_array).delete_all
end

def delete_all

# => ActiveRecord::ActiveRecordError: delete_all doesn't support distinct
Post.distinct.delete_all

If an invalid method is supplied, #delete_all raises an ActiveRecordError:

+after_destroy+ callbacks, use the #destroy_all method instead.
If you need to destroy dependent associations or call your before_* or
Both calls delete the affected posts all at once with a single DELETE statement.

Post.where(person_id: 5).where(category: ['Something', 'Else']).delete_all

number of rows affected.
:dependent rules defined on associations are not honored. Returns the
efficient than #destroy_all. Be careful with relations though, in particular
This is a single SQL DELETE statement that goes straight to the database, much more
method nor invoking callbacks.
first, and hence not calling the {#destroy}[rdoc-ref:Persistence#destroy]
Deletes the records without instantiating the records
def delete_all
  return 0 if @none
  invalid_methods = INVALID_METHODS_FOR_DELETE_ALL.select do |method|
    value = @values[method]
    method == :distinct ? value : value&.any?
  end
  if invalid_methods.any?
    raise ActiveRecordError.new("delete_all doesn't support #{invalid_methods.join(', ')}")
  end
  model.with_connection do |c|
    arel = eager_loading? ? apply_join_dependency.arel : build_arel(c)
    arel.source.left = table
    group_values_arel_columns = arel_columns(group_values.uniq)
    having_clause_ast = having_clause.ast unless having_clause.empty?
    key = if model.composite_primary_key?
      primary_key.map { |pk| table[pk] }
    else
      table[primary_key]
    end
    stmt = arel.compile_delete(key, having_clause_ast, group_values_arel_columns)
    c.delete(stmt, "#{model} Delete All").tap { reset }
  end
end

def delete_by(*args)

Person.delete_by("published_at < ?", 2.weeks.ago)
Person.delete_by(name: 'Spartacus', rating: 4)
Person.delete_by(id: 13)

If no record is found, returns 0 as zero rows were affected.

Returns the number of rows affected.
This is short-hand for relation.where(condition).delete_all.
Finds and deletes all records matching the specified conditions.
def delete_by(*args)
  where(*args).delete_all
end

def destroy(id)

Todo.destroy(todos)
todos = [1,2,3]
# Destroy multiple objects

Todo.destroy(1)
# Destroy a single object

==== Examples

* +id+ - This should be the id or an array of ids to be destroyed.

==== Parameters

from the attributes, and then calls destroy on it.
This essentially finds the object (or multiple objects) with the given id, creates a new object

less efficient than #delete but allows cleanup methods and other actions to be run.
therefore all callbacks and filters are fired off before the object is deleted. This method is
Destroy an object (or multiple objects) that has the given id. The object is instantiated first,
def destroy(id)
  multiple_ids = if model.composite_primary_key?
    id.first.is_a?(Array)
  else
    id.is_a?(Array)
  end
  if multiple_ids
    find(id).each(&:destroy)
  else
    find(id).destroy
  end
end

def destroy_all

Person.where(age: 0..18).destroy_all

==== Examples

#delete_all instead.
rows quickly, without concern for their associations or callbacks, use
possibly more, to enforce your callbacks). If you want to delete many
once. It generates at least one SQL +DELETE+ query per record (or
record can be time consuming when you're removing many records at
Note: Instantiation, callback execution, and deletion of each

reflect that no changes should be made (since they can't be persisted).
Returns the collection of objects that were destroyed; each will be frozen, to
Each object's callbacks are executed (including :dependent association options).
record and calling its {#destroy}[rdoc-ref:Persistence#destroy] method.
Destroys the records by instantiating each
def destroy_all
  records.each(&:destroy).tap { reset }
end

def destroy_by(*args)

Person.destroy_by("published_at < ?", 2.weeks.ago)
Person.destroy_by(name: 'Spartacus', rating: 4)
Person.destroy_by(id: 13)

If no record is found, returns empty array.

Returns the collection of objects that were destroyed.
This is short-hand for relation.where(condition).destroy_all.
Finds and destroys all records matching the specified conditions.
def destroy_by(*args)
  where(*args).destroy_all
end

def eager_loading?

Returns true if relation needs eager loading.
def eager_loading?
  @should_eager_load ||=
    eager_load_values.any? ||
    includes_values.any? && (joined_includes_values.any? || references_eager_loaded_tables?)
end

def empty?

Returns true if there are no records.
def empty?
  return true if @none
  if loaded?
    records.empty?
  else
    !exists?
  end
end

def empty_scope? # :nodoc:

:nodoc:
def empty_scope? # :nodoc:
  @values == model.unscoped.values
end

def encode_with(coder)

Serializes the relation objects Array.
def encode_with(coder)
  coder.represent_seq(nil, records)
end

def exec_main_query(async: false)

def exec_main_query(async: false)
  if @none
    if async
      return FutureResult.wrap([])
    else
      return []
    end
  end
  skip_query_cache_if_necessary do
    if where_clause.contradiction?
      [].freeze
    elsif eager_loading?
      model.with_connection do |c|
        apply_join_dependency do |relation, join_dependency|
          if relation.null_relation?
            [].freeze
          else
            relation = join_dependency.apply_column_aliases(relation)
            @_join_dependency = join_dependency
            c.select_all(relation.arel, "SQL", async: async)
          end
        end
      end
    else
      model.with_connection do |c|
        model._query_by_sql(c, arel, async: async)
      end
    end
  end
end

def exec_queries(&block)

def exec_queries(&block)
  skip_query_cache_if_necessary do
    rows = if scheduled?
      future = @future_result
      @future_result = nil
      future.result
    else
      exec_main_query
    end
    records = instantiate_records(rows, &block)
    preload_associations(records) unless skip_preloading_value
    records.each(&:readonly!) if readonly_value
    records.each { |record| record.strict_loading!(strict_loading_value) } unless strict_loading_value.nil?
    records
  end
end

def explain(*options)

{Active Record Query Interface guide}[https://guides.rubyonrails.org/active_record_querying.html#running-explain].
Please see further details in the

# ...
# EXPLAIN SELECT MAX(`users`.`id`) FROM `users`
User.all.explain.maximum(:id)

The column name can be passed if required:

# ...
# EXPLAIN SELECT COUNT(*) FROM `users`
User.all.explain.count

these methods on +explain+:
To run EXPLAIN on queries created by +first+, +pluck+ and +count+, call

are needed by the next ones when eager loading is going on.
Note that this method actually runs the queries, since the results of some

# ...
# EXPLAIN SELECT `users`.* FROM `users`
User.all.explain

ones printed by the database shell.
returns the result as a string. The string is formatted imitating the
Runs EXPLAIN on the query or queries triggered by this relation and
def explain(*options)
  ExplainProxy.new(self, options)
end

def find_or_create_by(attributes, &block)

you end up with two or more similar records.
doesn't have a relevant unique constraint it could be the case that
and if there are no results an INSERT is attempted. So if the table
Please note this method is not atomic, it runs first a SELECT,

ActiveRecord::RecordNotFound exception.
because a concurrent DELETE happened, it will then raise an
once more. If somehow the second find still does not find a record
assume it encountered a race condition and will try finding the record
If creation failed because of a unique constraint, this method will

#create returns in such situation.
failed due to validation errors it won't be persisted, you get what
This method always returns a record, but if creation was attempted and

# => #
end
user.last_name = 'Johansson'
User.find_or_create_by(first_name: 'Scarlett') do |user|
# particular last name.
# Find the first user named "Scarlett" or create a new one with a

above can be alternatively written this way:
This method accepts a block, which is passed down to #create. The last example

# => #
User.create_with(last_name: 'Johansson').find_or_create_by(first_name: 'Scarlett')
# a particular last name.
# Find the first user named "Scarlett" or create a new one with

# => #
User.find_or_create_by(first_name: 'Penélope')
# We already have one so the existing record will be returned.
# Find the first user named "Penélope" or create a new one.

# => #
User.find_or_create_by(first_name: 'Penélope')
# Find the first user named "Penélope" or create a new one.

with the attributes if one is not found:
Finds the first record with the given attributes, or creates a record
def find_or_create_by(attributes, &block)
  find_by(attributes) || create_or_find_by(attributes, &block)
end

def find_or_create_by!(attributes, &block)

is raised if the created record is invalid.
{create!}[rdoc-ref:Persistence::ClassMethods#create!] so an exception
Like #find_or_create_by, but calls
def find_or_create_by!(attributes, &block)
  find_by(attributes) || create_or_find_by!(attributes, &block)
end

def find_or_initialize_by(attributes, &block)

instead of {create}[rdoc-ref:Persistence::ClassMethods#create].
Like #find_or_create_by, but calls {new}[rdoc-ref:Core#new]
def find_or_initialize_by(attributes, &block)
  find_by(attributes) || new(attributes, &block)
end

def first_or_create(attributes = nil, &block) # :nodoc:

:nodoc:
def first_or_create(attributes = nil, &block) # :nodoc:
  first || create(attributes, &block)
end

def first_or_create!(attributes = nil, &block) # :nodoc:

:nodoc:
def first_or_create!(attributes = nil, &block) # :nodoc:
  first || create!(attributes, &block)
end

def first_or_initialize(attributes = nil, &block) # :nodoc:

:nodoc:
def first_or_initialize(attributes = nil, &block) # :nodoc:
  first || new(attributes, &block)
end

def global_scope?(registry)

def global_scope?(registry)
  registry.global_current_scope(model, true)
end

def has_limit_or_offset? # :nodoc:

:nodoc:
def has_limit_or_offset? # :nodoc:
  limit_value || offset_value
end

def initialize(model, table: nil, predicate_builder: nil, values: {})

def initialize(model, table: nil, predicate_builder: nil, values: {})
  if table
    predicate_builder ||= model.predicate_builder.with(TableMetadata.new(model, table))
  else
    table = model.arel_table
    predicate_builder ||= model.predicate_builder
  end
  @model  = model
  @table  = table
  @values = values
  @loaded = false
  @predicate_builder = predicate_builder
  @delegate_to_model = false
  @future_result = nil
  @records = nil
  @async = false
  @none = false
end

def initialize_copy(other)

def initialize_copy(other)
  @values = @values.dup
  reset
end

def insert(attributes, returning: nil, unique_by: nil, record_timestamps: nil)

See #insert_all for documentation.

go through Active Record's type casting and serialization.
Active Record callbacks or validations. Though passed values
statement. It does not instantiate any models nor does it trigger
Inserts a single record into the database in a single SQL INSERT
def insert(attributes, returning: nil, unique_by: nil, record_timestamps: nil)
  insert_all([ attributes ], returning: returning, unique_by: unique_by, record_timestamps: record_timestamps)
end

def insert!(attributes, returning: nil, record_timestamps: nil)

See #insert_all! for more.

go through Active Record's type casting and serialization.
Active Record callbacks or validations. Though passed values
statement. It does not instantiate any models nor does it trigger
Inserts a single record into the database in a single SQL INSERT
def insert!(attributes, returning: nil, record_timestamps: nil)
  insert_all!([ attributes ], returning: returning, record_timestamps: record_timestamps)
end

def insert_all(attributes, returning: nil, unique_by: nil, record_timestamps: nil)

])
{ id: 2, title: "Eloquent Ruby" }
{ id: 1, title: "Rework" },
author.books.create_with(created_at: Time.now).insert_all([

# to set default attributes for all inserted records.
# insert_all works on chained scopes, and you can use create_with

])
{ id: 1, title: "Eloquent Ruby", author: "Russ" }
{ id: 1, title: "Rework", author: "David" },
Book.insert_all([

# Here "Eloquent Ruby" is skipped because its id is not unique.
# Insert records and skip inserting any duplicates.

==== Example

Active Record's schema_cache.
:unique_by is recommended to be paired with
Because it relies on the index information from the database

record_timestamps: false # Never set timestamps automatically
record_timestamps: true # Always set timestamps automatically

way or the other, pass :record_timestamps:
To override this and force automatic setting of timestamp columns one

behavior.
the model's record_timestamps config, matching typical
By default, automatic setting of timestamp columns is controlled by
[:record_timestamps]

unique_by: :index_books_on_isbn
unique_by: %i[ author_id name ]
unique_by: :isbn

Unique indexes can be identified by columns or name:

ActiveRecord::RecordNotUnique is raised.
row has an existing id, or is not unique by another unique index,
Consider a Book model where no duplicate ISBNs make sense, but if any

To skip rows according to just one unique index pass :unique_by.

by every unique index on the table. Any duplicate rows are skipped.
(PostgreSQL and SQLite only) By default rows are considered to be unique
[:unique_by]

(for example, returning: Arel.sql("id, name as new_name")).
You can also pass an SQL string if you need more control on the return values

clause entirely.
or returning: false to omit the underlying RETURNING SQL
Pass returning: %w[ id name ] for both id and name
inserted records, which by default is the primary key.
(PostgreSQL, SQLite3, and MariaDB only) An array of attributes to return for all successfully
[:returning]

==== Options

:returning (see below).
Returns an ActiveRecord::Result with its contents based on

Override with :unique_by (see below).
duplicate rows are skipped.
Rows are considered to be unique by every unique index on the table. Any

the attributes for a single row and must have the same keys.
The +attributes+ parameter is an Array of Hashes. Every Hash determines

go through Active Record's type casting and serialization.
Active Record callbacks or validations. Though passed values
statement. It does not instantiate any models nor does it trigger
Inserts multiple records into the database in a single SQL INSERT
def insert_all(attributes, returning: nil, unique_by: nil, record_timestamps: nil)
  InsertAll.execute(self, attributes, on_duplicate: :skip, returning: returning, unique_by: unique_by, record_timestamps: record_timestamps)
end

def insert_all!(attributes, returning: nil, record_timestamps: nil)

])
{ id: 1, title: "Eloquent Ruby", author: "Russ" }
{ id: 1, title: "Rework", author: "David" },
Book.insert_all!([
# does not have a unique id.
# Raises ActiveRecord::RecordNotUnique because "Eloquent Ruby"

])
{ title: "Eloquent Ruby", author: "Russ" }
{ title: "Rework", author: "David" },
Book.insert_all!([
# Insert multiple records

==== Examples

record_timestamps: false # Never set timestamps automatically
record_timestamps: true # Always set timestamps automatically

way or the other, pass :record_timestamps:
To override this and force automatic setting of timestamp columns one

behavior.
the model's record_timestamps config, matching typical
By default, automatic setting of timestamp columns is controlled by
[:record_timestamps]

(for example, returning: Arel.sql("id, name as new_name")).
You can also pass an SQL string if you need more control on the return values

clause entirely.
or returning: false to omit the underlying RETURNING SQL
Pass returning: %w[ id name ] for both id and name
inserted records, which by default is the primary key.
(PostgreSQL, SQLite3, and MariaDB only) An array of attributes to return for all successfully
[:returning]

==== Options

:returning (see below).
Returns an ActiveRecord::Result with its contents based on

To skip duplicate rows, see #insert_all. To replace them, see #upsert_all.

unique index on the table. In that case, no rows are inserted.
Raises ActiveRecord::RecordNotUnique if any rows violate a

the attributes for a single row and must have the same keys.
The +attributes+ parameter is an Array of Hashes. Every Hash determines

go through Active Record's type casting and serialization.
Active Record callbacks or validations. Though passed values
statement. It does not instantiate any models nor does it trigger
Inserts multiple records into the database in a single SQL INSERT
def insert_all!(attributes, returning: nil, record_timestamps: nil)
  InsertAll.execute(self, attributes, on_duplicate: :raise, returning: returning, record_timestamps: record_timestamps)
end

def inspect

def inspect
  subject = loaded? ? records : annotate("loading for inspect")
  entries = subject.take([limit_value, 11].compact.min).map!(&:inspect)
  entries[10] = "..." if entries.size == 11
  "#<#{self.class.name} [#{entries.join(', ')}]>"
end

def instantiate_records(rows, &block)

def instantiate_records(rows, &block)
  return [].freeze if rows.empty?
  if eager_loading?
    records = @_join_dependency.instantiate(rows, strict_loading_value, &block).freeze
    @_join_dependency = nil
    records
  else
    model._load_from_sql(rows, &block).freeze
  end
end

def joined_includes_values

nested hashes which partially match, e.g. { a: :b } & { a: [:b, :c] }
represent the same association, but that aren't matched by this. Also, we could have
Note that this is a naive implementation because we could have strings and symbols which
Joins that are also marked for preloading. In which case we should just eager load them.
def joined_includes_values
  includes_values & joins_values
end

def limited_count

def limited_count
  limit_value ? count : limit(2).count
end

def load(&block)

Post.where(published: true).load # => #

return value is the relation itself, not the records.
to explicitly load some records before actually using them. The
been loaded already. You can use this if for some reason you need
Causes the records to be loaded from the database if they have not
def load(&block)
  if !loaded? || scheduled?
    @records = exec_queries(&block)
    @loaded = true
  end
  self
end

def load_async

ASYNC Post Load (0.0ms) (db time 2ms) SELECT "posts".* FROM "posts" LIMIT 100

it by prefixing the log line with ASYNC:
If the query was actually executed in the background, the Active Record logs will show

executing them in the foreground.
for queries to actually be executed concurrently. Otherwise it defaults to
Note that {config.active_record.async_query_executor}[https://guides.rubyonrails.org/configuring.html#config-active-record-async-query-executor] must be configured

it will be performed by the foreground thread.
When the +Relation+ is iterated, if the background query wasn't executed yet,

Post.where(published: true).load_async # => #

Schedule the query to be performed from a background thread pool.
def load_async
  with_connection do |c|
    return load if !c.async_enabled?
    unless loaded?
      result = exec_main_query(async: !c.current_transaction.joinable?)
      if result.is_a?(Array)
        @records = result
      else
        @future_result = result
      end
      @loaded = true
    end
  end
  self
end

def load_records(records)

def load_records(records)
  @records = records.freeze
  @loaded = true
end

def many?

Returns true if there is more than one record.
def many?
  return false if @none
  return super if block_given?
  return records.many? if loaded?
  limited_count > 1
end

def new(attributes = nil, &block)

user.name # => Oscar
user = users.new { |user| user.name = 'Oscar' }

You can also pass a block to new with the new record as argument:

user = users.new # => #
users = User.where(name: 'DHH')

Expects arguments in the same format as {ActiveRecord::Base.new}[rdoc-ref:Core.new].

scope.
Initializes new record from relation while maintaining the current
def new(attributes = nil, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| new(attr, &block) }
  else
    block = current_scope_restoring_block(&block)
    scoping { _new(attributes, &block) }
  end
end

def none?(*args)

posts.none?(Comment) # => true or false

the Enumerable match the pattern via the case-equality operator (===).
When a pattern argument is given, this method checks whether elements in

Returns true if there are no records.
def none?(*args)
  return true if @none
  return super if args.present? || block_given?
  empty?
end

def one?(*args)

posts.one?(Post) # => true or false

the Enumerable match the pattern via the case-equality operator (===).
When a pattern argument is given, this method checks whether elements in

Returns true if there is exactly one record.
def one?(*args)
  return false if @none
  return super if args.present? || block_given?
  return records.one? if loaded?
  limited_count == 1
end

def preload_associations(records) # :nodoc:

:nodoc:
def preload_associations(records) # :nodoc:
  preload = preload_values
  preload += includes_values unless eager_loading?
  scope = strict_loading_value ? StrictLoadingScope : nil
  preload.each do |associations|
    ActiveRecord::Associations::Preloader.new(records: records, associations: associations, scope: scope).call
  end
end

def pretty_print(pp)

def pretty_print(pp)
  subject = loaded? ? records : annotate("loading for pp")
  entries = subject.take([limit_value, 11].compact.min)
  entries[10] = "..." if entries.size == 11
  pp.pp(entries)
end

def readonly?

def readonly?
  readonly_value
end

def records # :nodoc:

:nodoc:
def records # :nodoc:
  load
  @records
end

def references_eager_loaded_tables?

def references_eager_loaded_tables?
  joined_tables = build_joins([]).flat_map do |join|
    if join.is_a?(Arel::Nodes::StringJoin)
      tables_in_string(join.left)
    else
      join.left.name
    end
  end
  joined_tables << table.name
  # always convert table names to downcase as in Oracle quoted table names are in uppercase
  joined_tables.map!(&:downcase)
  !(references_values.map(&:to_s) - joined_tables).empty?
end

def reload

Forces reloading of relation.
def reload
  reset
  load
end

def reset

def reset
  @future_result&.cancel
  @future_result = nil
  @delegate_to_model = false
  @to_sql = @arel = @loaded = @should_eager_load = nil
  @offsets = @take = nil
  @cache_keys = nil
  @cache_versions = nil
  @records = nil
  self
end

def scheduled?

thread pool.
Returns true if the relation was scheduled on the background
def scheduled?
  !!@future_result
end

def scope_for_create

def scope_for_create
  hash = where_clause.to_h(model.table_name, equality_only: true)
  create_with_value.each { |k, v| hash[k.to_s] = v } unless create_with_value.empty?
  hash
end

def scoping(all_queries: nil, &block)

the default_scope) during the execution of a block.
Please check unscoped if you want to remove all previous scopes (including

nested block.
Once +all_queries+ is set to true it cannot be set to false in a
for the relation including +update+ and +delete+ on instances.
If all_queries: true is passed, scoping will apply to all queries

# SELECT "comments".* FROM "comments" WHERE "comments"."post_id" = 1 ORDER BY "comments"."id" ASC LIMIT 1
end
Comment.first
Comment.where(post_id: 1).scoping do

Scope all queries to the current scope.
def scoping(all_queries: nil, &block)
  registry = model.scope_registry
  if global_scope?(registry) && all_queries == false
    raise ArgumentError, "Scoping is set to apply to all queries and cannot be unset in a nested block."
  elsif already_in_scope?(registry)
    yield
  else
    _scoping(self, registry, all_queries, &block)
  end
end

def size

Returns size of the records.
def size
  if loaded?
    records.length
  else
    count(:all)
  end
end

def skip_query_cache_if_necessary(&block)

def skip_query_cache_if_necessary(&block)
  if skip_query_cache_value
    model.uncached(&block)
  else
    yield
  end
end

def tables_in_string(string)

def tables_in_string(string)
  return [] if string.blank?
  # always convert table names to downcase as in Oracle quoted table names are in uppercase
  # ignore raw_sql_ that is used by Oracle adapter as alias for limit/offset subqueries
  string.scan(/[a-zA-Z_][.\w]+(?=.?\.)/).map!(&:downcase) - ["raw_sql_"]
end

def then(&block) # :nodoc:

:nodoc:
def then(&block) # :nodoc:
  if @future_result
    @future_result.then do
      yield self
    end
  else
    super
  end
end

def to_ary

Converts relation objects to Array.
def to_ary
  records.dup
end

def to_sql

# SELECT "users".* FROM "users" WHERE "users"."name" = 'Oscar'
User.where(name: 'Oscar').to_sql

Returns sql statement for the relation.
def to_sql
  @to_sql ||= if eager_loading?
    apply_join_dependency do |relation, join_dependency|
      relation = join_dependency.apply_column_aliases(relation)
      relation.to_sql
    end
  else
    model.with_connection do |conn|
      conn.unprepared_statement { conn.to_sql(arel) }
    end
  end
end

def touch_all(*names, time: nil)

# => "UPDATE \"people\" SET \"updated_at\" = '2018-01-04 22:55:23.132670' WHERE \"people\".\"name\" = 'David'"
Person.where(name: 'David').touch_all
# Touch records with scope

# => "UPDATE \"people\" SET \"updated_at\" = '2020-05-16 00:00:00'"
Person.all.touch_all(time: Time.new(2020, 5, 16, 0, 0, 0))
# Touch multiple records with a specified time

# => "UPDATE \"people\" SET \"updated_at\" = '2018-01-04 22:55:23.132670', \"created_at\" = '2018-01-04 22:55:23.132670'"
Person.all.touch_all(:created_at)
# Touch multiple records with a custom attribute

# => "UPDATE \"people\" SET \"updated_at\" = '2018-01-04 22:55:23.132670'"
Person.all.touch_all
# Touch all records

=== Examples

If no time argument is passed, the current time is used as default.
If attribute names are passed, they are updated along with +updated_at+/+updated_on+ attributes.
This method can be passed attribute names and an optional time argument.
It does not instantiate the involved models, and it does not trigger Active Record callbacks or validations.
Touches all records in the current relation, setting the +updated_at+/+updated_on+ attributes to the current time or the time specified.
def touch_all(*names, time: nil)
  update_all model.touch_attributes_with_time(*names, time: time)
end

def update(id = :all, attributes) # :nodoc:

:nodoc:
def update(id = :all, attributes) # :nodoc:
  if id == :all
    each { |record| record.update(attributes) }
  else
    model.update(id, attributes)
  end
end

def update!(id = :all, attributes) # :nodoc:

:nodoc:
def update!(id = :all, attributes) # :nodoc:
  if id == :all
    each { |record| record.update!(attributes) }
  else
    model.update!(id, attributes)
  end
end

def update_all(updates)

Book.where('title LIKE ?', '%Rails%').update_all(title: Arel.sql("title + ' - volume 1'"))
# Update all books with 'Rails' in their title

Invoice.update_all('number = id')
# Update all invoices and set the number column to its id value.

Book.where('title LIKE ?', '%Rails%').order(:created_at).limit(5).update_all(author: 'David')
# Update all books that match conditions, but limit it to 5 ordered by date

Book.where('title LIKE ?', '%Rails%').update_all(author: 'David')
# Update all books with 'Rails' in their title

Customer.update_all wants_email: true
# Update all customers with the given attributes

==== Examples

be type cast, unless you use +Arel.sql+. (Don't pass user-provided values to +Arel.sql+.)
* +updates+ - A string, array, or hash representing the SET part of an SQL statement. Any strings provided will

==== Parameters

Note: As Active Record callbacks are not triggered, this method will not automatically update +updated_at+/+updated_on+ columns.

Active Record's normal type casting and serialization. Returns the number of rows affected.
trigger Active Record callbacks or validations. However, values passed to #update_all will still go through
statement and sends it straight to the database. It does not instantiate the involved models and it does not
Updates all records in the current relation with details given. This method constructs a single SQL UPDATE
def update_all(updates)
  raise ArgumentError, "Empty list of attributes to change" if updates.blank?
  return 0 if @none
  if updates.is_a?(Hash)
    if model.locking_enabled? &&
        !updates.key?(model.locking_column) &&
        !updates.key?(model.locking_column.to_sym)
      attr = table[model.locking_column]
      updates[attr.name] = _increment_attribute(attr)
    end
    values = _substitute_values(updates)
  else
    values = Arel.sql(model.sanitize_sql_for_assignment(updates, table.name))
  end
  model.with_connection do |c|
    arel = eager_loading? ? apply_join_dependency.arel : build_arel(c)
    arel.source.left = table
    group_values_arel_columns = arel_columns(group_values.uniq)
    having_clause_ast = having_clause.ast unless having_clause.empty?
    key = if model.composite_primary_key?
      primary_key.map { |pk| table[pk] }
    else
      table[primary_key]
    end
    stmt = arel.compile_update(values, key, having_clause_ast, group_values_arel_columns)
    c.update(stmt, "#{model} Update All").tap { reset }
  end
end

def update_counters(counters)

Post.where(author_id: author.id).update_counters(comment_count: 1)
# For Posts by a given author increment the comment_count by 1.

==== Examples

* If attributes names are passed, they are updated along with update_at/on attributes.
* :touch option - Touch the timestamp columns when updating.
* +counter+ - A Hash containing the names of the fields to update as keys and the amount to update as values.

==== Parameters

Updates the counters of the records in the current relation.
def update_counters(counters)
  touch = counters.delete(:touch)
  updates = {}
  counters.each do |counter_name, value|
    attr = table[counter_name]
    updates[attr.name] = _increment_attribute(attr, value)
  end
  if touch
    names = touch if touch != true
    names = Array.wrap(names)
    options = names.extract_options!
    touch_updates = model.touch_attributes_with_time(*names, **options)
    updates.merge!(touch_updates) unless touch_updates.empty?
  end
  update_all updates
end

def upsert(attributes, **kwargs)

See #upsert_all for documentation.

go through Active Record's type casting and serialization.
it trigger Active Record callbacks or validations. Though passed values
single SQL INSERT statement. It does not instantiate any models nor does
Updates or inserts (upserts) a single record into the database in a
def upsert(attributes, **kwargs)
  upsert_all([ attributes ], **kwargs)
end

def upsert_all(attributes, on_duplicate: :update, update_only: nil, returning: nil, unique_by: nil, record_timestamps: nil)

Book.find_by(isbn: "1").title # => "Eloquent Ruby"

], unique_by: :isbn)
{ title: "Eloquent Ruby", author: "Russ", isbn: "1" }
{ title: "Rework", author: "David", isbn: "1" },
Book.upsert_all([

# Here "Eloquent Ruby" overwrites "Rework" because its ISBN is duplicate.
# Inserts multiple records, performing an upsert when records have duplicate ISBNs.

==== Examples

record_timestamps: false # Never set timestamps automatically
record_timestamps: true # Always set timestamps automatically

way or the other, pass :record_timestamps:
To override this and force automatic setting of timestamp columns one

behavior.
the model's record_timestamps config, matching typical
By default, automatic setting of timestamp columns is controlled by
[:record_timestamps]

See the related +:on_duplicate+ option. Both options can't be used at the same time.

)
update_only: [:price] # Only prices will be updated
],
{ id: 6, name: "Aluminium", price: 0.35 }
{ id: 4, name: "Gold", price: 1380.87 },
{ id: 2, name: "Copper", price: 4.84 },
[
Commodity.upsert_all(

Example:

except primary keys, read-only columns, and columns covered by the optional +unique_by+
+upsert_all+ will update all the columns that can be updated. These are all the columns
Provide a list of column names that will be updated in case of conflict. If not provided,
[:update_only]

See the related +:update_only+ option. Both options can't be used at the same time.

)
on_duplicate: Arel.sql("price = GREATEST(commodities.price, EXCLUDED.price)")
],
{ id: 6, name: "Aluminium", price: 0.35 }
{ id: 4, name: "Gold", price: 1380.87 },
{ id: 2, name: "Copper", price: 4.84 },
[
Commodity.upsert_all(

Example:

by yourself.
NOTE: If you use this option you must provide all the columns you want to update

Configure the SQL update sentence that will be used in case of conflict.
[:on_duplicate]

Active Record's schema_cache.
:unique_by is recommended to be paired with
Because it relies on the index information from the database

unique_by: :index_books_on_isbn
unique_by: %i[ author_id name ]
unique_by: :isbn

Unique indexes can be identified by columns or name:

ActiveRecord::RecordNotUnique is raised.
row has an existing id, or is not unique by another unique index,
Consider a Book model where no duplicate ISBNs make sense, but if any

To skip rows according to just one unique index pass :unique_by.

by every unique index on the table. Any duplicate rows are skipped.
(PostgreSQL and SQLite only) By default rows are considered to be unique
[:unique_by]

(for example, returning: Arel.sql("id, name as new_name")).
You can also pass an SQL string if you need more control on the return values

clause entirely.
or returning: false to omit the underlying RETURNING SQL
Pass returning: %w[ id name ] for both id and name
upserted records, which by default is the primary key.
(PostgreSQL, SQLite3, and MariaDB only) An array of attributes to return for all successfully
[:returning]

==== Options

columns, and columns covered by the optional +unique_by+.
there is a conflict. These are all the columns except primary keys, read-only
By default, +upsert_all+ will update all the columns that can be updated when

:returning (see below).
Returns an ActiveRecord::Result with its contents based on

the attributes for a single row and must have the same keys.
The +attributes+ parameter is an Array of Hashes. Every Hash determines

go through Active Record's type casting and serialization.
it trigger Active Record callbacks or validations. Though passed values
single SQL INSERT statement. It does not instantiate any models nor does
Updates or inserts (upserts) multiple records into the database in a
def upsert_all(attributes, on_duplicate: :update, update_only: nil, returning: nil, unique_by: nil, record_timestamps: nil)
  InsertAll.execute(self, attributes, on_duplicate: on_duplicate, update_only: update_only, returning: returning, unique_by: unique_by, record_timestamps: record_timestamps)
end

def values

def values
  @values.dup
end

def values_for_queries # :nodoc:

:nodoc:
def values_for_queries # :nodoc:
  @values.except(:extending, :skip_query_cache, :strict_loading)
end

def where_values_hash(relation_table_name = model.table_name) # :nodoc:

:nodoc:
# => {name: "Oscar"}
User.where(name: 'Oscar').where_values_hash

Returns a hash of where conditions.
def where_values_hash(relation_table_name = model.table_name) # :nodoc:
  where_clause.to_h(relation_table_name)
end