Class: ActiveRecord::Relation
- Includes:
- Batches, Calculations, Delegation, Explain, FinderMethods, QueryMethods, SpawnMethods
- Defined in:
- activerecord/lib/active_record/relation.rb,
activerecord/lib/active_record/relation/merger.rb
Overview
Active Record Relation
Direct Known Subclasses
Defined Under Namespace
Classes: HashMerger, JoinOperation, Merger
Constant Summary collapse
- MULTI_VALUE_METHODS =
[:includes, :eager_load, :preload, :select, :group, :order, :joins, :where, :having, :bind, :references, :extending, :unscope]
- SINGLE_VALUE_METHODS =
[:limit, :offset, :lock, :readonly, :from, :reordering, :reverse_order, :distinct, :create_with, :uniq]
- VALUE_METHODS =
MULTI_VALUE_METHODS + SINGLE_VALUE_METHODS
Constants included from FinderMethods
Constants included from QueryMethods
QueryMethods::VALID_UNSCOPING_VALUES
Constants included from Delegation
Delegation::BLACKLISTED_ARRAY_METHODS
Instance Attribute Summary collapse
-
#klass ⇒ Object
(also: #model)
readonly
Returns the value of attribute klass.
-
#loaded ⇒ Object
(also: #loaded?)
readonly
Returns the value of attribute loaded.
-
#table ⇒ Object
readonly
Returns the value of attribute table.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Compares two relations for equality.
-
#_update_record(values, id, id_was) ⇒ Object
:nodoc:.
-
#any? ⇒ Boolean
Returns true if there are any records.
-
#as_json(options = nil) ⇒ Object
:nodoc:.
-
#blank? ⇒ Boolean
Returns true if relation is blank.
-
#create(*args, &block) ⇒ Object
Tries to create a new record with the same scoped attributes defined in the relation.
-
#create!(*args, &block) ⇒ Object
Similar to #create, but calls
create!
on the base class. -
#delete(id_or_array) ⇒ Object
Deletes the row with a primary key matching the
id
argument, using a SQLDELETE
statement, and returns the number of rows deleted. -
#delete_all(conditions = nil) ⇒ Object
Deletes the records matching
conditions
without instantiating the records first, and hence not calling thedestroy
method nor invoking callbacks. -
#destroy(id) ⇒ Object
Destroy an object (or multiple objects) that has the given id.
-
#destroy_all(conditions = nil) ⇒ Object
Destroys the records matching
conditions
by instantiating each record and calling itsdestroy
method. -
#eager_loading? ⇒ Boolean
Returns true if relation needs eager loading.
-
#empty? ⇒ Boolean
Returns true if there are no records.
-
#explain ⇒ Object
Runs EXPLAIN on the query or queries triggered by this relation and returns the result as a string.
-
#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_or_create_by!(attributes, &block) ⇒ Object
Like
find_or_create_by
, but callscreate!
so an exception is raised if the created record is invalid. -
#find_or_initialize_by(attributes, &block) ⇒ Object
Like
find_or_create_by
, but callsnew
instead ofcreate
. -
#first_or_create(attributes = nil, &block) ⇒ Object
:nodoc:.
-
#first_or_create!(attributes = nil, &block) ⇒ Object
:nodoc:.
-
#first_or_initialize(attributes = nil, &block) ⇒ Object
:nodoc:.
-
#initialize(klass, table, values = {}) ⇒ Relation
constructor
A new instance of Relation.
- #initialize_copy(other) ⇒ Object
-
#insert(values) ⇒ Object
:nodoc:.
- #inspect ⇒ Object
-
#joined_includes_values ⇒ Object
Joins that are also marked for preloading.
-
#load ⇒ Object
Causes the records to be loaded from the database if they have not been loaded already.
-
#many? ⇒ Boolean
Returns true if there is more than one record.
-
#new(*args, &block) ⇒ Object
(also: #build)
Initializes new record from relation while maintaining the current scope.
- #pretty_print(q) ⇒ Object
-
#reload ⇒ Object
Forces reloading of relation.
- #reset ⇒ Object
- #scope_for_create ⇒ Object
-
#scoping ⇒ Object
Scope all queries to the current scope.
-
#size ⇒ Object
Returns size of the records.
-
#substitute_values(values) ⇒ Object
:nodoc:.
-
#to_a ⇒ Object
Converts relation objects to Array.
-
#to_sql ⇒ Object
Returns sql statement for the relation.
-
#uniq_value ⇒ Object
uniq
anduniq!
are silently deprecated. -
#update(id, attributes) ⇒ Object
Updates an object (or multiple objects) and saves it to the database, if validations pass.
-
#update_all(updates) ⇒ Object
Updates all records with details given if they match a set of conditions supplied, limits and order can also be supplied.
- #values ⇒ Object
-
#where_values_hash(relation_table_name = table_name) ⇒ Object
Returns a hash of where conditions.
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, #bind, #bind!, #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!, #limit, #limit!, #lock, #lock!, #none, #none!, #offset, #offset!, #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, extended, #included
Methods included from Batches
Methods included from Explain
#collecting_queries_for_explain, #exec_explain
Methods included from Delegation
Constructor Details
#initialize(klass, table, values = {}) ⇒ Relation
Returns a new instance of Relation.
23 24 25 26 27 28 29 |
# File 'activerecord/lib/active_record/relation.rb', line 23 def initialize(klass, table, values = {}) @klass = klass @table = table @values = values @offsets = {} @loaded = false end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class ActiveRecord::Delegation
Instance Attribute Details
#klass ⇒ Object (readonly) Also known as: model
Returns the value of attribute klass
19 20 21 |
# File 'activerecord/lib/active_record/relation.rb', line 19 def klass @klass end |
#loaded ⇒ Object (readonly) Also known as: loaded?
Returns the value of attribute loaded
19 20 21 |
# File 'activerecord/lib/active_record/relation.rb', line 19 def loaded @loaded end |
#table ⇒ Object (readonly)
Returns the value of attribute table
19 20 21 |
# File 'activerecord/lib/active_record/relation.rb', line 19 def table @table end |
Instance Method Details
#==(other) ⇒ Object
Compares two relations for equality.
577 578 579 580 581 582 583 584 585 586 |
# File 'activerecord/lib/active_record/relation.rb', line 577 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:
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'activerecord/lib/active_record/relation.rb', line 73 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 um = scope.where(@klass.arel_table[@klass.primary_key].eq(id_was || id)).arel.compile_update(substitutes, @klass.primary_key) @klass.connection.update( um, 'SQL', binds) end |
#any? ⇒ Boolean
Returns true if there are any records.
264 265 266 267 268 269 270 |
# File 'activerecord/lib/active_record/relation.rb', line 264 def any? if block_given? to_a.any? { |*block_args| yield(*block_args) } else !empty? end end |
#as_json(options = nil) ⇒ Object
:nodoc:
242 243 244 |
# File 'activerecord/lib/active_record/relation.rb', line 242 def as_json( = nil) #:nodoc: to_a.as_json() end |
#blank? ⇒ Boolean
Returns true if relation is blank.
593 594 595 |
# File 'activerecord/lib/active_record/relation.rb', line 593 def blank? to_a.blank? 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 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, ...>
138 139 140 |
# File 'activerecord/lib/active_record/relation.rb', line 138 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 Base.create!
.
146 147 148 |
# File 'activerecord/lib/active_record/relation.rb', line 146 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 id
s.
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])
482 483 484 |
# File 'activerecord/lib/active_record/relation.rb', line 482 def delete(id_or_array) where(primary_key => id_or_array).delete_all end |
#delete_all(conditions = nil) ⇒ Object
Deletes the records matching conditions
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.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
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 a limit scope is supplied, delete_all
raises an ActiveRecord error:
Post.limit(100).delete_all
# => ActiveRecord::ActiveRecordError: delete_all doesn't support limit scope
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
# File 'activerecord/lib/active_record/relation.rb', line 441 def delete_all(conditions = nil) raise ActiveRecordError.new("delete_all doesn't support limit scope") if self.limit_value if conditions where(conditions).delete_all else stmt = Arel::DeleteManager.new(arel.engine) 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', bind_values) 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 ActiveRecord#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)
414 415 416 417 418 419 420 |
# File 'activerecord/lib/active_record/relation.rb', line 414 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 matching conditions
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.
Parameters
-
conditions
- A string, array, or hash that specifies which records to destroy. If omitted, all records are destroyed. See the Conditions section in the introduction to ActiveRecord::Base for more information.
Examples
Person.destroy_all("last_login < '2004-04-04'")
Person.destroy_all(status: "inactive")
Person.where(age: 0..18).destroy_all
387 388 389 390 391 392 393 |
# File 'activerecord/lib/active_record/relation.rb', line 387 def destroy_all(conditions = nil) if conditions where(conditions).destroy_all else to_a.each {|object| object.destroy }.tap { reset } end end |
#eager_loading? ⇒ Boolean
Returns true if relation needs eager loading.
556 557 558 559 560 |
# File 'activerecord/lib/active_record/relation.rb', line 556 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.
252 253 254 255 256 257 258 259 260 261 |
# File 'activerecord/lib/active_record/relation.rb', line 252 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 |
#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.
232 233 234 |
# File 'activerecord/lib/active_record/relation.rb', line 232 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.find_or_create_by(user_id: user.id)
rescue ActiveRecord::RecordNotUnique
retry
end
208 209 210 |
# File 'activerecord/lib/active_record/relation.rb', line 208 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.
214 215 216 |
# File 'activerecord/lib/active_record/relation.rb', line 214 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
.
219 220 221 |
# File 'activerecord/lib/active_record/relation.rb', line 219 def find_or_initialize_by(attributes, &block) find_by(attributes) || new(attributes, &block) end |
#first_or_create(attributes = nil, &block) ⇒ Object
:nodoc:
150 151 152 |
# File 'activerecord/lib/active_record/relation.rb', line 150 def first_or_create(attributes = nil, &block) # :nodoc: first || create(attributes, &block) end |
#first_or_create!(attributes = nil, &block) ⇒ Object
:nodoc:
154 155 156 |
# File 'activerecord/lib/active_record/relation.rb', line 154 def first_or_create!(attributes = nil, &block) # :nodoc: first || create!(attributes, &block) end |
#first_or_initialize(attributes = nil, &block) ⇒ Object
:nodoc:
158 159 160 |
# File 'activerecord/lib/active_record/relation.rb', line 158 def first_or_initialize(attributes = nil, &block) # :nodoc: first || new(attributes, &block) end |
#initialize_copy(other) ⇒ Object
31 32 33 34 35 36 37 |
# File 'activerecord/lib/active_record/relation.rb', line 31 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] @values[:bind] = @values[:bind].dup if @values.key? :bind 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 && 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 |
#inspect ⇒ Object
601 602 603 604 605 606 |
# File 'activerecord/lib/active_record/relation.rb', line 601 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_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] }
566 567 568 |
# File 'activerecord/lib/active_record/relation.rb', line 566 def joined_includes_values includes_values & joins_values end |
#load ⇒ 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>
492 493 494 495 496 |
# File 'activerecord/lib/active_record/relation.rb', line 492 def load exec_queries unless loaded? self end |
#many? ⇒ Boolean
Returns true if there is more than one record.
273 274 275 276 277 278 279 |
# File 'activerecord/lib/active_record/relation.rb', line 273 def many? if block_given? to_a.many? { |*block_args| yield(*block_args) } else limit_value ? to_a.many? : size > 1 end 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 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
115 116 117 |
# File 'activerecord/lib/active_record/relation.rb', line 115 def new(*args, &block) scoping { @klass.new(*args, &block) } end |
#pretty_print(q) ⇒ Object
588 589 590 |
# File 'activerecord/lib/active_record/relation.rb', line 588 def pretty_print(q) q.pp(self.to_a) end |
#reload ⇒ Object
Forces reloading of relation.
499 500 501 502 |
# File 'activerecord/lib/active_record/relation.rb', line 499 def reload reset load end |
#reset ⇒ Object
504 505 506 507 508 509 510 |
# File 'activerecord/lib/active_record/relation.rb', line 504 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_create ⇒ Object
551 552 553 |
# File 'activerecord/lib/active_record/relation.rb', line 551 def scope_for_create @scope_for_create ||= where_values_hash.merge(create_with_value) 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.
290 291 292 293 294 295 |
# File 'activerecord/lib/active_record/relation.rb', line 290 def scoping previous, klass.current_scope = klass.current_scope, self yield ensure klass.current_scope = previous end |
#size ⇒ Object
Returns size of the records.
247 248 249 |
# File 'activerecord/lib/active_record/relation.rb', line 247 def size loaded? ? @records.length : count(:all) end |
#substitute_values(values) ⇒ Object
:nodoc:
90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'activerecord/lib/active_record/relation.rb', line 90 def substitute_values(values) # :nodoc: substitutes = values.sort_by { |arel_attr,_| arel_attr.name } binds = substitutes.map do |arel_attr, value| [@klass.columns_hash[arel_attr.name], value] end substitutes.each_with_index do |tuple, i| tuple[1] = @klass.connection.substitute_at(binds[i][0], i) end [substitutes, binds] end |
#to_a ⇒ Object
Converts relation objects to Array.
237 238 239 240 |
# File 'activerecord/lib/active_record/relation.rb', line 237 def to_a load @records end |
#to_sql ⇒ Object
Returns sql statement for the relation.
User.where(name: 'Oscar').to_sql
# => SELECT "users".* FROM "users" WHERE "users"."name" = 'Oscar'
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
# File 'activerecord/lib/active_record/relation.rb', line 516 def to_sql @to_sql ||= begin relation = self connection = klass.connection visitor = connection.visitor if eager_loading? find_with_associations { |rel| relation = rel } end ast = relation.arel.ast binds = relation.bind_values.dup visitor.accept(ast) do connection.quote(*binds.shift.reverse) end end end |
#uniq_value ⇒ Object
uniq
and uniq!
are silently deprecated. uniq_value
delegates to distinct_value
to maintain backwards compatibility. Use distinct_value
instead.
572 573 574 |
# File 'activerecord/lib/active_record/relation.rb', line 572 def uniq_value distinct_value end |
#update(id, 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)
352 353 354 355 356 357 358 359 360 |
# File 'activerecord/lib/active_record/relation.rb', line 352 def update(id, attributes) if id.is_a?(Array) id.map.with_index { |one_id, idx| update(one_id, attributes[idx]) } else object = find(id) object.update(attributes) object end end |
#update_all(updates) ⇒ Object
Updates all records with details given if they match a set of conditions supplied, limits and order can also be supplied. 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.
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')
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'activerecord/lib/active_record/relation.rb', line 316 def update_all(updates) raise ArgumentError, "Empty list of attributes to change" if updates.blank? stmt = Arel::UpdateManager.new(arel.engine) stmt.set Arel.sql(@klass.send(:sanitize_sql_for_assignment, updates)) stmt.table(table) stmt.key = table[primary_key] if joins_values.any? @klass.connection.join_to_update(stmt, arel) else stmt.take(arel.limit) stmt.order(*arel.orders) stmt.wheres = arel.constraints end @klass.connection.update stmt, 'SQL', bind_values end |
#values ⇒ Object
597 598 599 |
# File 'activerecord/lib/active_record/relation.rb', line 597 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"}
538 539 540 541 542 543 544 545 546 547 548 549 |
# File 'activerecord/lib/active_record/relation.rb', line 538 def where_values_hash(relation_table_name = table_name) equalities = where_values.grep(Arel::Nodes::Equality).find_all { |node| node.left.relation.name == relation_table_name } binds = Hash[bind_values.find_all(&:first).map { |column, v| [column.name, v] }] Hash[equalities.map { |where| name = where.left.name [name, binds.fetch(name.to_s) { where.right }] }] end |