instance method
in_batches
Ruby on Rails 5.0.7.2
Since v5.0.7.2Signature
in_batches(of: 1000, start: nil, finish: nil, load: false, error_on_ignore: nil)Yields ActiveRecord::Relation objects to work with a batch of records.
Person.where("age > 21").in_batches do |relation|
relation.delete_all
sleep(10) # Throttle the delete queries
end
If you do not provide a block to #in_batches, it will return a BatchEnumerator which is enumerable.
Person.in_batches.each_with_index do |relation, batch_index|
puts "Processing relation ##{batch_index}"
relation.delete_all
end
Examples of calling methods on the returned BatchEnumerator object:
Person.in_batches.delete_all
Person.in_batches.update_all(awesome: true)
Person.in_batches.each_record(&:party_all_night!)
Options
-
:of- Specifies the size of the batch. Defaults to 1000. -
:load- Specifies if the relation should be loaded. Defaults to false. -
:start- Specifies the primary key value to start from, inclusive of the value. -
:finish- Specifies the primary key value to end at, inclusive of the value. -
:error_on_ignore- Overrides the application config to specify if an error should be raised when the order and limit have to be ignored due to batching.
This is especially useful if you want to work with the ActiveRecord::Relation object instead of the array of records, or if you want multiple workers dealing with the same processing queue. You can make worker 1 handle all the records between id 0 and 10,000 and worker 2 handle from 10,000 and beyond (by setting the :start and :finish option on each worker).
# Let's process the next 2000 records
Person.in_batches(of: 2000, start: 2000).update_all(awesome: true)
An example of calling where query method on the relation:
Person.in_batches.each do |relation|
relation.update_all('age = age + 1')
relation.where('age > 21').update_all(should_party: true)
relation.where('age <= 21').delete_all
end
NOTE: If you are going to iterate through each record, you should call #each_record on the yielded BatchEnumerator:
Person.in_batches.each_record(&:party_all_night!)
NOTE: It’s not possible to set the order. That is automatically set to ascending on the primary key (“id ASC”) to make the batch ordering consistent. Therefore the primary key must be orderable, e.g. an integer or a string.
NOTE: You can’t set the limit either, that’s used to control the batch sizes.
Parameters
-
ofkey = 1000 -
startkey = nil -
finishkey = nil -
loadkey = false -
error_on_ignorekey = nil
Source
# File activerecord/lib/active_record/relation/batches.rb, line 184
def in_batches(of: 1000, start: nil, finish: nil, load: false, error_on_ignore: nil)
relation = self
unless block_given?
return BatchEnumerator.new(of: of, start: start, finish: finish, relation: self)
end
if arel.orders.present? || arel.taken.present?
act_on_order_or_limit_ignored(error_on_ignore)
end
relation = relation.reorder(batch_order).limit(of)
relation = apply_limits(relation, start, finish)
batch_relation = relation
loop do
if load
records = batch_relation.records
ids = records.map(&:id)
yielded_relation = self.where(primary_key => ids)
yielded_relation.load_records(records)
else
ids = batch_relation.pluck(primary_key)
yielded_relation = self.where(primary_key => ids)
end
break if ids.empty?
primary_key_offset = ids.last
raise ArgumentError.new("Primary key not included in the custom select clause") unless primary_key_offset
yield yielded_relation
break if ids.length < of
batch_relation = relation.where(arel_attribute(primary_key).gt(primary_key_offset))
end
end
Defined in activerecord/lib/active_record/relation/batches.rb line 184
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveRecord::Batches