Class: ActiveRecord::Relation

Inherits:
Object
  • Object
show all
Includes:
Batches, Calculations, Delegation, Explain, FinderMethods, QueryMethods, RecordFetchWarning, 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/record_fetch_warning.rb,
activerecord/lib/active_record/relation/where_clause_factory.rb

Overview

Active Record Relation

Defined Under Namespace

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

Constant Summary collapse

MULTI_VALUE_METHODS = 
[:includes, :eager_load, :preload, :select, :group,
:order, :joins, :left_outer_joins, :references,
:extending, :unscope]
SINGLE_VALUE_METHODS = 
[:limit, :offset, :lock, :readonly, :reordering,
:reverse_order, :distinct, :create_with, :skip_query_cache]
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

Constants included from Batches

Batches::ORDER_IGNORE_MESSAGE

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!, #second_to_last, #second_to_last!, #take, #take!, #third, #third!, #third_to_last, #third_to_last!

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, #create_with, #create_with!, #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, #skip_query_cache!, #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 Enumerable

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

Constructor Details

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

Returns a new instance of Relation.



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

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

Instance Attribute Details

#klass ⇒ Object (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

#loaded ⇒ Object (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_builder ⇒ Object (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

#table ⇒ Object (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.



607
608
609
610
611
612
613
614
615
616
 
# File 'activerecord/lib/active_record/relation.rb', line 607

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

#_update_record(values, id, id_was) ⇒ Object

:nodoc:



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

def _update_record(values, id, id_was) # :nodoc:
  substitutes = 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))
  um = relation
    .arel
    .compile_update(substitutes, @klass.primary_key)

  @klass.connection.update(
    um,
    "SQL",
  )
end

#any? ⇒ Boolean

Returns true if there are any records.

Returns:

  • (Boolean) 


278
279
280
281
 
# File 'activerecord/lib/active_record/relation.rb', line 278

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

#arel_attribute(name) ⇒ Object

:nodoc:



100
101
102
 
# File 'activerecord/lib/active_record/relation.rb', line 100

def arel_attribute(name) # :nodoc:
  klass.arel_attribute(name, table)
end

#blank? ⇒ Boolean

Returns true if relation is blank.

Returns:

  • (Boolean) 


623
624
625
 
# File 'activerecord/lib/active_record/relation.rb', line 623

def blank?
  records.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.



316
317
318
319
 
# File 'activerecord/lib/active_record/relation.rb', line 316

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, ...>



141
142
143
 
# File 'activerecord/lib/active_record/relation.rb', line 141

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!.



151
152
153
 
# File 'activerecord/lib/active_record/relation.rb', line 151

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])



531
532
533
 
# File 'activerecord/lib/active_record/relation.rb', line 531

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

#delete_all ⇒ 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



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'activerecord/lib/active_record/relation.rb', line 488

def delete_all
  invalid_methods = INVALID_METHODS_FOR_DELETE_ALL.select do |method|
    value = get_value(method)
    SINGLE_VALUE_METHODS.include?(method) ? value : value.any?
  end
  if invalid_methods.any?
    raise ActiveRecordError.new("delete_all doesn't support #{invalid_methods.join(', ')}")
  end

  stmt = Arel::DeleteManager.new
  stmt.from(table)

  if has_join_values?
    @klass.connection.join_to_delete(stmt, arel, arel_attribute(primary_key))
  else
    stmt.wheres = arel.constraints
  end

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

  reset
  affected
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)



462
463
464
465
466
467
468
 
# File 'activerecord/lib/active_record/relation.rb', line 462

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

#destroy_all ⇒ 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



439
440
441
 
# File 'activerecord/lib/active_record/relation.rb', line 439

def destroy_all
  records.each(&:destroy).tap { reset }
end

#eager_loading? ⇒ Boolean

Returns true if relation needs eager loading.

Returns:

  • (Boolean) 


592
593
594
595
596
 
# File 'activerecord/lib/active_record/relation.rb', line 592

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.

Returns:

  • (Boolean) 


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

def empty?
  return @records.empty? if loaded?
  !exists?
end

#empty_scope? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


640
641
642
 
# File 'activerecord/lib/active_record/relation.rb', line 640

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

#encode_with(coder) ⇒ Object

Serializes the relation objects Array.



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

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

#explain ⇒ Object

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.



241
242
243
 
# File 'activerecord/lib/active_record/relation.rb', line 241

def explain
  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



215
216
217
 
# File 'activerecord/lib/active_record/relation.rb', line 215

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.



222
223
224
 
# File 'activerecord/lib/active_record/relation.rb', line 222

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.



228
229
230
 
# File 'activerecord/lib/active_record/relation.rb', line 228

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

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

:nodoc:



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

def first_or_create(attributes = nil, &block) # :nodoc:
  first || create(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_initialize(attributes = nil, &block) ⇒ Object

:nodoc:



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

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

#has_limit_or_offset? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

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

#initialize_copy(other) ⇒ Object 



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

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

#insert(values) ⇒ Object

:nodoc:



39
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
 
# File 'activerecord/lib/active_record/relation.rb', line 39

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 && klass.prefetch_primary_key?
      primary_key_value = klass.next_sequence_value
      values[arel_attribute(klass.primary_key)] = primary_key_value
    end
  end

  im = arel.create_insert
  im.into @table

  substitutes = 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 || false,
    primary_key_value,
    nil,
  )
end

#inspect ⇒ Object 



631
632
633
634
635
636
637
638
 
# File 'activerecord/lib/active_record/relation.rb', line 631

def inspect
  subject = loaded? ? records : self
  entries = subject.take([limit_value, 11].compact.min).map!(&:inspect)

  entries[10] = "..." if entries.size == 11

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

#joined_includes_values ⇒ Object

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] }



602
603
604
 
# File 'activerecord/lib/active_record/relation.rb', line 602

def joined_includes_values
  includes_values & joins_values
end

#load(&block) ⇒ Object

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>



541
542
543
544
545
 
# File 'activerecord/lib/active_record/relation.rb', line 541

def load(&block)
  exec_queries(&block) unless loaded?

  self
end

#many? ⇒ Boolean

Returns true if there is more than one record.

Returns:

  • (Boolean) 


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

def many?
  return super if block_given?
  limit_value ? records.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



116
117
118
 
# File 'activerecord/lib/active_record/relation.rb', line 116

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

#none? ⇒ Boolean

Returns true if there are no records.

Returns:

  • (Boolean) 


272
273
274
275
 
# File 'activerecord/lib/active_record/relation.rb', line 272

def none?
  return super if block_given?
  empty?
end

#one? ⇒ Boolean

Returns true if there is exactly one record.

Returns:

  • (Boolean) 


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

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

#pretty_print(q) ⇒ Object 



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

def pretty_print(q)
  q.pp(records)
end

#records ⇒ Object

:nodoc:



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

def records # :nodoc:
  load
  @records
end

#reload ⇒ Object

Forces reloading of relation.



548
549
550
551
 
# File 'activerecord/lib/active_record/relation.rb', line 548

def reload
  reset
  load
end

#reset ⇒ Object 



553
554
555
556
557
558
 
# File 'activerecord/lib/active_record/relation.rb', line 553

def reset
  @to_sql = @arel = @loaded = @should_eager_load = nil
  @records = [].freeze
  @offsets = {}
  self
end

#scope_for_create ⇒ Object 



587
588
589
 
# File 'activerecord/lib/active_record/relation.rb', line 587

def scope_for_create
  where_values_hash.merge!(create_with_value.stringify_keys)
end

#scoping ⇒ Object

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.



330
331
332
333
334
335
 
# File 'activerecord/lib/active_record/relation.rb', line 330

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

#size ⇒ Object

Returns size of the records.



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

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

#substitute_values(values) ⇒ Object

:nodoc:



93
94
95
96
97
98
 
# File 'activerecord/lib/active_record/relation.rb', line 93

def substitute_values(values) # :nodoc:
  values.map do |arel_attr, value|
    bind = predicate_builder.build_bind_attribute(arel_attr.name, value)
    [arel_attr, bind]
  end
end

#to_a ⇒ Object

Converts relation objects to Array.



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

def to_a
  records.dup
end

#to_sql ⇒ Object

Returns sql statement for the relation.

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



564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'activerecord/lib/active_record/relation.rb', line 564

def to_sql
  @to_sql ||= begin
                relation = self

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

                conn = klass.connection
                conn.unprepared_statement {
                  conn.to_sql(relation.arel)
                }
              end
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. When running callbacks is not needed for each record update, it is preferred to use #update_all for updating all records in a single query.



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'activerecord/lib/active_record/relation.rb', line 405

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
    records.each { |record| record.update(attributes) }
  else
    if ActiveRecord::Base === id
      raise ArgumentError, "        You are passing an instance of ActiveRecord::Base to `update`.\n        Please pass the id of the object by calling `.id`.\n      MSG\n    end\n    object = find(id)\n    object.update(attributes)\n    object\n  end\nend\n".squish

#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 'Quails' in their title
Book.where('title LIKE ?', '%Quails%').update_all(author: 'David')

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

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

Raises:

  • (ArgumentError) 


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'activerecord/lib/active_record/relation.rb', line 359

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 has_join_values?
    @klass.connection.join_to_update(stmt, arel, arel_attribute(primary_key))
  else
    stmt.key = arel_attribute(primary_key)
    stmt.take(arel.limit)
    stmt.order(*arel.orders)
    stmt.wheres = arel.constraints
  end

  @klass.connection.update stmt, "SQL"
end

#values ⇒ Object 



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

def values
  @values.dup
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"}



583
584
585
 
# File 'activerecord/lib/active_record/relation.rb', line 583

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