Class: ActiveRecord::Relation

Inherits:
Object
  • Object
show all
Includes:
Batches, Calculations, Delegation, Explain, FinderMethods, QueryMethods, SpawnMethods, Enumerable
Defined in:
activerecord/lib/active_record/relation.rb,
activerecord/lib/active_record/relation/merger.rb,
activerecord/lib/active_record/relation/from_clause.rb,
activerecord/lib/active_record/relation/where_clause.rb,
activerecord/lib/active_record/relation/query_attribute.rb,
activerecord/lib/active_record/relation/where_clause_factory.rb,
activerecord/lib/active_record/relation/record_fetch_warning.rb

Overview

Active Record Relation

Defined Under Namespace

Modules: RecordFetchWarning Classes: FromClause, HashMerger, Merger, QueryAttribute, WhereClause, WhereClauseFactory

Constant Summary

MULTI_VALUE_METHODS =
[:includes, :eager_load, :preload, :select, :group,
:order, :joins, :left_joins, :left_outer_joins, :references,
:extending, :unscope]
SINGLE_VALUE_METHODS =
[:limit, :offset, :lock, :readonly, :reordering,
:reverse_order, :distinct, :create_with]
CLAUSE_METHODS =
[:where, :having, :from]
INVALID_METHODS_FOR_DELETE_ALL =
[:limit, :distinct, :offset, :group, :having]
VALUE_METHODS =
MULTI_VALUE_METHODS + SINGLE_VALUE_METHODS + CLAUSE_METHODS

Constants included from FinderMethods

FinderMethods::ONE_AS_ONE

Constants included from QueryMethods

QueryMethods::FROZEN_EMPTY_ARRAY, QueryMethods::FROZEN_EMPTY_HASH, QueryMethods::VALID_UNSCOPING_VALUES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FinderMethods

#exists?, #fifth, #fifth!, #find, #find_by, #find_by!, #first, #first!, #forty_two, #forty_two!, #fourth, #fourth!, #last, #last!, #raise_record_not_found_exception!, #second, #second!, #take, #take!, #third, #third!

Methods included from Calculations

#average, #calculate, #count, #ids, #maximum, #minimum, #pluck, #sum

Methods included from SpawnMethods

#except, #merge, #merge!, #only, #spawn

Methods included from QueryMethods

#_select!, #arel, #bound_attributes, #create_with, #create_with!, #create_with_value, #distinct, #distinct!, #eager_load, #eager_load!, #extending, #extending!, #from, #from!, #group, #group!, #having, #having!, #includes, #includes!, #joins, #joins!, #left_outer_joins, #left_outer_joins!, #limit, #limit!, #lock, #lock!, #none, #none!, #offset, #offset!, #or, #or!, #order, #order!, #preload, #preload!, #readonly, #readonly!, #references, #references!, #reorder, #reorder!, #reverse_order, #reverse_order!, #rewhere, #select, #unscope, #unscope!, #where, #where!

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Methods included from Batches

#find_each, #find_in_batches, #in_batches

Methods included from Explain

#collecting_queries_for_explain, #exec_explain

Methods included from Delegation

#respond_to?

Methods included from Enumerable

#exclude?, #index_by, #pluck, #sum, #without

Constructor Details

#initialize(klass, table, predicate_builder, values = {}) ⇒ Relation



24
25
26
27
28
29
30
31
# File 'activerecord/lib/active_record/relation.rb', line 24

def initialize(klass, table, predicate_builder, values = {})
  @klass  = klass
  @table  = table
  @values = values
  @offsets = {}
  @loaded = false
  @predicate_builder = predicate_builder
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveRecord::Delegation

Instance Attribute Details

#klassObject (readonly) Also known as: model

Returns the value of attribute klass



20
21
22
# File 'activerecord/lib/active_record/relation.rb', line 20

def klass
  @klass
end

#loadedObject (readonly) Also known as: loaded?

Returns the value of attribute loaded



20
21
22
# File 'activerecord/lib/active_record/relation.rb', line 20

def loaded
  @loaded
end

#predicate_builderObject (readonly)

Returns the value of attribute predicate_builder



20
21
22
# File 'activerecord/lib/active_record/relation.rb', line 20

def predicate_builder
  @predicate_builder
end

#tableObject (readonly)

Returns the value of attribute table



20
21
22
# File 'activerecord/lib/active_record/relation.rb', line 20

def table
  @table
end

Instance Method Details

#==(other) ⇒ Object

Compares two relations for equality.



650
651
652
653
654
655
656
657
658
659
# File 'activerecord/lib/active_record/relation.rb', line 650

def ==(other)
  case other
  when Associations::CollectionProxy, AssociationRelation
    self == other.to_a
  when Relation
    other.to_sql == to_sql
  when Array
    to_a == other
  end
end

#_update_record(values, id, id_was) ⇒ Object

:nodoc:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'activerecord/lib/active_record/relation.rb', line 74

def _update_record(values, id, id_was) # :nodoc:
  substitutes, binds = substitute_values values

  scope = @klass.unscoped

  if @klass.finder_needs_type_condition?
    scope.unscope!(where: @klass.inheritance_column)
  end

  relation = scope.where(@klass.primary_key => (id_was || id))
  bvs = binds + relation.bound_attributes
  um = relation
    .arel
    .compile_update(substitutes, @klass.primary_key)

  @klass.connection.update(
    um,
    'SQL',
    bvs,
  )
end

#any?Boolean

Returns true if there are any records.



289
290
291
292
# File 'activerecord/lib/active_record/relation.rb', line 289

def any?
  return super if block_given?
  !empty?
end

#as_json(options = nil) ⇒ Object

:nodoc:



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

def as_json(options = nil) #:nodoc:
  to_a.as_json(options)
end

#blank?Boolean

Returns true if relation is blank.



666
667
668
# File 'activerecord/lib/active_record/relation.rb', line 666

def blank?
  to_a.blank?
end

#cache_key(timestamp_column = :updated_at) ⇒ Object

Returns a cache key that can be used to identify the records fetched by this query. The cache key is built with a fingerprint of the sql query, the number of records matched by the query and a timestamp of the last updated record. When a new record comes to match the query, or any of the existing records is updated or deleted, the cache key changes.

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

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

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

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

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

You can customize the strategy to generate the key on a per model basis overriding ActiveRecord::Base#collection_cache_key.



327
328
329
330
# File 'activerecord/lib/active_record/relation.rb', line 327

def cache_key(timestamp_column = :updated_at)
  @cache_keys ||= {}
  @cache_keys[timestamp_column] ||= @klass.collection_cache_key(self, timestamp_column)
end

#create(*args, &block) ⇒ Object

Tries to create a new record with the same scoped attributes defined in the relation. Returns the initialized object if validation fails.

Expects arguments in the same format as ActiveRecord::Base.create.

Examples

users = User.where(name: 'Oscar')
users.create # => #<User id: 3, name: "Oscar", ...>

users.create(name: 'fxn')
users.create # => #<User id: 4, name: "fxn", ...>

users.create { |user| user.name = 'tenderlove' }
# => #<User id: 5, name: "tenderlove", ...>

users.create(name: nil) # validation on name
# => #<User id: nil, name: nil, ...>


145
146
147
# File 'activerecord/lib/active_record/relation.rb', line 145

def create(*args, &block)
  scoping { @klass.create(*args, &block) }
end

#create!(*args, &block) ⇒ Object

Similar to #create, but calls create! on the base class. Raises an exception if a validation error occurs.

Expects arguments in the same format as ActiveRecord::Base.create!.



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

def create!(*args, &block)
  scoping { @klass.create!(*args, &block) }
end

#delete(id_or_array) ⇒ Object

Deletes the row with a primary key matching the id argument, using a SQL DELETE statement, and returns the number of rows deleted. Active Record objects are not instantiated, so the object's callbacks are not executed, including any :dependent association options.

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

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

Examples

# Delete a single row
Todo.delete(1)

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


561
562
563
# File 'activerecord/lib/active_record/relation.rb', line 561

def delete(id_or_array)
  where(primary_key => id_or_array).delete_all
end

#delete_all(conditions = nil) ⇒ Object

Deletes the records without instantiating the records first, and hence not calling the #destroy method nor invoking callbacks. This is a single SQL DELETE statement that goes straight to the database, much more efficient than #destroy_all. Be careful with relations though, in particular :dependent rules defined on associations are not honored. Returns the number of rows affected.

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

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

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

Post.limit(100).delete_all
# => ActiveRecord::ActiveRecordError: delete_all doesn't support limit


505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'activerecord/lib/active_record/relation.rb', line 505

def delete_all(conditions = nil)
  invalid_methods = INVALID_METHODS_FOR_DELETE_ALL.select { |method|
    if MULTI_VALUE_METHODS.include?(method)
      send("#{method}_values").any?
    elsif SINGLE_VALUE_METHODS.include?(method)
      send("#{method}_value")
    elsif CLAUSE_METHODS.include?(method)
      send("#{method}_clause").any?
    end
  }
  if invalid_methods.any?
    raise ActiveRecordError.new("delete_all doesn't support #{invalid_methods.join(', ')}")
  end

  if conditions
    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
      Passing conditions to delete_all is deprecated and will be removed in Rails 5.1.
      To achieve the same use where(conditions).delete_all
    MESSAGE
    where(conditions).delete_all
  else
    stmt = Arel::DeleteManager.new
    stmt.from(table)

    if joins_values.any?
      @klass.connection.join_to_delete(stmt, arel, table[primary_key])
    else
      stmt.wheres = arel.constraints
    end

    affected = @klass.connection.delete(stmt, 'SQL', bound_attributes)

    reset
    affected
  end
end

#destroy(id) ⇒ Object

Destroy an object (or multiple objects) that has the given id. The object is instantiated first, therefore all callbacks and filters are fired off before the object is deleted. This method is less efficient than #delete but allows cleanup methods and other actions to be run.

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

Parameters

  • id - Can be either an Integer or an Array of Integers.

Examples

# Destroy a single object
Todo.destroy(1)

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


479
480
481
482
483
484
485
# File 'activerecord/lib/active_record/relation.rb', line 479

def destroy(id)
  if id.is_a?(Array)
    id.map { |one_id| destroy(one_id) }
  else
    find(id).destroy
  end
end

#destroy_all(conditions = nil) ⇒ Object

Destroys the records by instantiating each record and calling its #destroy method. Each object's callbacks are executed (including :dependent association options). Returns the collection of objects that were destroyed; each will be frozen, to reflect that no changes should be made (since they can't be persisted).

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

Examples

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


448
449
450
451
452
453
454
455
456
457
458
# File 'activerecord/lib/active_record/relation.rb', line 448

def destroy_all(conditions = nil)
  if conditions
    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
      Passing conditions to destroy_all is deprecated and will be removed in Rails 5.1.
      To achieve the same use where(conditions).destroy_all
    MESSAGE
    where(conditions).destroy_all
  else
    to_a.each(&:destroy).tap { reset }
  end
end

#eager_loading?Boolean

Returns true if relation needs eager loading.



626
627
628
629
630
# File 'activerecord/lib/active_record/relation.rb', line 626

def eager_loading?
  @should_eager_load ||=
    eager_load_values.any? ||
    includes_values.any? && (joined_includes_values.any? || references_eager_loaded_tables?)
end

#empty?Boolean

Returns true if there are no records.



271
272
273
274
275
276
277
278
279
280
# File 'activerecord/lib/active_record/relation.rb', line 271

def empty?
  return @records.empty? if loaded?

  if limit_value == 0
    true
  else
    c = count(:all)
    c.respond_to?(:zero?) ? c.zero? : c.empty?
  end
end

#encode_with(coder) ⇒ Object

Serializes the relation objects Array.



257
258
259
# File 'activerecord/lib/active_record/relation.rb', line 257

def encode_with(coder)
  coder.represent_seq(nil, to_a)
end

#explainObject

Runs EXPLAIN on the query or queries triggered by this relation and returns the result as a string. The string is formatted imitating the ones printed by the database shell.

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

Please see further details in the Active Record Query Interface guide.



245
246
247
248
# File 'activerecord/lib/active_record/relation.rb', line 245

def explain
  #TODO: Fix for binds.
  exec_explain(collecting_queries_for_explain { exec_queries })
end

#find_or_create_by(attributes, &block) ⇒ Object

Finds the first record with the given attributes, or creates a record with the attributes if one is not found:

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

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

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

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

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

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

Please note *this method is not atomic*, it runs first a SELECT, and if there are no results an INSERT is attempted. If there are other threads or processes there is a race condition between both calls and it could be the case that you end up with two similar records.

Whether that is a problem or not depends on the logic of the application, but in the particular case in which rows have a UNIQUE constraint an exception may be raised, just retry:

begin
  CreditAccount.transaction(requires_new: true) do
    CreditAccount.find_or_create_by(user_id: user.id)
  end
rescue ActiveRecord::RecordNotUnique
  retry
end


219
220
221
# File 'activerecord/lib/active_record/relation.rb', line 219

def find_or_create_by(attributes, &block)
  find_by(attributes) || create(attributes, &block)
end

#find_or_create_by!(attributes, &block) ⇒ Object

Like #find_or_create_by, but calls create! so an exception is raised if the created record is invalid.



226
227
228
# File 'activerecord/lib/active_record/relation.rb', line 226

def find_or_create_by!(attributes, &block)
  find_by(attributes) || create!(attributes, &block)
end

#find_or_initialize_by(attributes, &block) ⇒ Object

Like #find_or_create_by, but calls new instead of create.



232
233
234
# File 'activerecord/lib/active_record/relation.rb', line 232

def find_or_initialize_by(attributes, &block)
  find_by(attributes) || new(attributes, &block)
end

#first_or_create(attributes = nil, &block) ⇒ Object

:nodoc:



159
160
161
# File 'activerecord/lib/active_record/relation.rb', line 159

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

#first_or_create!(attributes = nil, &block) ⇒ Object

:nodoc:



163
164
165
# File 'activerecord/lib/active_record/relation.rb', line 163

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

#first_or_initialize(attributes = nil, &block) ⇒ Object

:nodoc:



167
168
169
# File 'activerecord/lib/active_record/relation.rb', line 167

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

#initialize_copy(other) ⇒ Object



33
34
35
36
37
38
# File 'activerecord/lib/active_record/relation.rb', line 33

def initialize_copy(other)
  # This method is a hot spot, so for now, use Hash[] to dup the hash.
  #   https://bugs.ruby-lang.org/issues/7166
  @values        = Hash[@values]
  reset
end

#insert(values) ⇒ Object

:nodoc:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'activerecord/lib/active_record/relation.rb', line 40

def insert(values) # :nodoc:
  primary_key_value = nil

  if primary_key && Hash === values
    primary_key_value = values[values.keys.find { |k|
      k.name == primary_key
    }]

    if !primary_key_value && connection.prefetch_primary_key?(klass.table_name)
      primary_key_value = connection.next_sequence_value(klass.sequence_name)
      values[klass.arel_table[klass.primary_key]] = primary_key_value
    end
  end

  im = arel.create_insert
  im.into @table

  substitutes, binds = substitute_values values

  if values.empty? # empty insert
    im.values = Arel.sql(connection.empty_insert_statement_value)
  else
    im.insert substitutes
  end

  @klass.connection.insert(
    im,
    'SQL',
    primary_key,
    primary_key_value,
    nil,
    binds)
end

#inspectObject



674
675
676
677
678
679
# File 'activerecord/lib/active_record/relation.rb', line 674

def inspect
  entries = to_a.take([limit_value, 11].compact.min).map!(&:inspect)
  entries[10] = '...' if entries.size == 11

  "#<#{self.class.name} [#{entries.join(', ')}]>"
end

#joined_includes_valuesObject

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



636
637
638
# File 'activerecord/lib/active_record/relation.rb', line 636

def joined_includes_values
  includes_values & joins_values
end

#loadObject

Causes the records to be loaded from the database if they have not been loaded already. You can use this if for some reason you need to explicitly load some records before actually using them. The return value is the relation itself, not the records.

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


571
572
573
574
575
# File 'activerecord/lib/active_record/relation.rb', line 571

def load
  exec_queries unless loaded?

  self
end

#many?Boolean

Returns true if there is more than one record.



301
302
303
304
# File 'activerecord/lib/active_record/relation.rb', line 301

def many?
  return super if block_given?
  limit_value ? to_a.many? : size > 1
end

#new(*args, &block) ⇒ Object Also known as: build

Initializes new record from relation while maintaining the current scope.

Expects arguments in the same format as ActiveRecord::Base.new.

users = User.where(name: 'DHH')
user = users.new # => #<User id: nil, name: "DHH", created_at: nil, updated_at: nil>

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

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


120
121
122
# File 'activerecord/lib/active_record/relation.rb', line 120

def new(*args, &block)
  scoping { @klass.new(*args, &block) }
end

#none?Boolean

Returns true if there are no records.



283
284
285
286
# File 'activerecord/lib/active_record/relation.rb', line 283

def none?
  return super if block_given?
  empty?
end

#one?Boolean

Returns true if there is exactly one record.



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

def one?
  return super if block_given?
  limit_value ? to_a.one? : size == 1
end

#pretty_print(q) ⇒ Object



661
662
663
# File 'activerecord/lib/active_record/relation.rb', line 661

def pretty_print(q)
  q.pp(self.to_a)
end

#reloadObject

Forces reloading of relation.



578
579
580
581
# File 'activerecord/lib/active_record/relation.rb', line 578

def reload
  reset
  load
end

#resetObject



583
584
585
586
587
588
589
# File 'activerecord/lib/active_record/relation.rb', line 583

def reset
  @last = @to_sql = @order_clause = @scope_for_create = @arel = @loaded = nil
  @should_eager_load = @join_dependency = nil
  @records = []
  @offsets = {}
  self
end

#scope_for_createObject



621
622
623
# File 'activerecord/lib/active_record/relation.rb', line 621

def scope_for_create
  @scope_for_create ||= where_values_hash.merge(create_with_value)
end

#scopingObject

Scope all queries to the current scope.

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

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



341
342
343
344
345
346
# File 'activerecord/lib/active_record/relation.rb', line 341

def scoping
  previous, klass.current_scope = klass.current_scope, self
  yield
ensure
  klass.current_scope = previous
end

#sizeObject

Returns size of the records.



266
267
268
# File 'activerecord/lib/active_record/relation.rb', line 266

def size
  loaded? ? @records.length : count(:all)
end

#substitute_values(values) ⇒ Object

:nodoc:



96
97
98
99
100
101
102
103
104
105
106
# File 'activerecord/lib/active_record/relation.rb', line 96

def substitute_values(values) # :nodoc:
  binds = values.map do |arel_attr, value|
    QueryAttribute.new(arel_attr.name, value, klass.type_for_attribute(arel_attr.name))
  end

  substitutes = values.map do |(arel_attr, _)|
    [arel_attr, connection.substitute_at(klass.columns_hash[arel_attr.name])]
  end

  [substitutes, binds]
end

#to_aObject

Converts relation objects to Array.



251
252
253
254
# File 'activerecord/lib/active_record/relation.rb', line 251

def to_a
  load
  @records
end

#to_sqlObject

Returns sql statement for the relation.

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


595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
# File 'activerecord/lib/active_record/relation.rb', line 595

def to_sql
  @to_sql ||= begin
                relation   = self
                connection = klass.connection
                visitor    = connection.visitor

                if eager_loading?
                  find_with_associations { |rel| relation = rel }
                end

                binds = relation.bound_attributes
                binds = connection.prepare_binds_for_database(binds)
                binds.map! { |value| connection.quote(value) }
                collect = visitor.accept(relation.arel.ast, Arel::Collectors::Bind.new)
                collect.substitute_binds(binds).join
              end
end

#uniq_valueObject

#uniq and #uniq! are silently deprecated. #uniq_value delegates to #distinct_value to maintain backwards compatibility. Use #distinct_value instead.



644
645
646
# File 'activerecord/lib/active_record/relation.rb', line 644

def uniq_value
  distinct_value
end

#update(id = :all, attributes) ⇒ Object

Updates an object (or multiple objects) and saves it to the database, if validations pass. The resulting object is returned whether the object was saved successfully to the database or not.

Parameters

  • id - This should be the id or an array of ids to be updated.

  • attributes - This should be a hash of attributes or an array of hashes.

Examples

# Updates one record
Person.update(15, user_name: 'Samuel', group: 'expert')

# Updates multiple records
people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
Person.update(people.keys, people.values)

# Updates multiple records from the result of a relation
people = Person.where(group: 'expert')
people.update(group: 'masters')

Note: Updating a large number of records will run an UPDATE query for each record, which may cause a performance issue. So if it is not needed to run callbacks for each update, it is preferred to use #update_all for updating all records using a single query.



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'activerecord/lib/active_record/relation.rb', line 413

def update(id = :all, attributes)
  if id.is_a?(Array)
    id.map.with_index { |one_id, idx| update(one_id, attributes[idx]) }
  elsif id == :all
    to_a.each { |record| record.update(attributes) }
  else
    if ActiveRecord::Base === id
      id = id.id
      ActiveSupport::Deprecation.warn(<<-MSG.squish)
        You are passing an instance of ActiveRecord::Base to `update`.
        Please pass the id of the object by calling `.id`
      MSG
    end
    object = find(id)
    object.update(attributes)
    object
  end
end

#update_all(updates) ⇒ Object

Updates all records in the current relation with details given. This method constructs a single SQL UPDATE statement and sends it straight to the database. It does not instantiate the involved models and it does not trigger Active Record callbacks or validations. However, values passed to #update_all will still go through Active Record's normal type casting and serialization.

Parameters

  • updates - A string, array, or hash representing the SET part of an SQL statement.

Examples

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

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

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

Raises:

  • (ArgumentError)


367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'activerecord/lib/active_record/relation.rb', line 367

def update_all(updates)
  raise ArgumentError, "Empty list of attributes to change" if updates.blank?

  stmt = Arel::UpdateManager.new

  stmt.set Arel.sql(@klass.send(:sanitize_sql_for_assignment, updates))
  stmt.table(table)

  if joins_values.any?
    @klass.connection.join_to_update(stmt, arel, table[primary_key])
  else
    stmt.key = table[primary_key]
    stmt.take(arel.limit)
    stmt.order(*arel.orders)
    stmt.wheres = arel.constraints
  end

  @klass.connection.update stmt, 'SQL', bound_attributes
end

#valuesObject



670
671
672
# File 'activerecord/lib/active_record/relation.rb', line 670

def values
  Hash[@values]
end

#where_values_hash(relation_table_name = table_name) ⇒ Object

Returns a hash of where conditions.

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


617
618
619
# File 'activerecord/lib/active_record/relation.rb', line 617

def where_values_hash(relation_table_name = table_name)
  where_clause.to_h(relation_table_name)
end