instance method
find_in_batches
Ruby on Rails 5.0.7.2
Since v3.1.12Signature
find_in_batches(start: nil, finish: nil, batch_size: 1000, error_on_ignore: nil)
Yields each batch of records that was found by the find options as an array.
Person.where("age > 21").find_in_batches do |group|
sleep(50) # Make sure it doesn't get too crowded in there!
group.each { |person| person.party_all_night! }
end
If you do not provide a block to #find_in_batches, it will return an Enumerator for chaining with other methods:
Person.find_in_batches.with_index do |group, batch|
puts "Processing group ##{batch}"
group.each(&:recover_from_last_night!)
end
To be yielded each record one by one, use #find_each instead.
Options
-
:batch_size- Specifies the size of the batch. Defaults to 1000. -
: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 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.find_in_batches(start: 2000, batch_size: 2000) do |group|
group.each { |person| person.party_all_night! }
end
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 work. This also means that this method only works when the primary key is orderable (e.g. an integer or string).
NOTE: You can’t set the limit either, that’s used to control the batch sizes.
Parameters
-
startkey = nil -
finishkey = nil -
batch_sizekey = 1000 -
error_on_ignorekey = nil
Source
# File activerecord/lib/active_record/relation/batches.rb, line 111
def find_in_batches(start: nil, finish: nil, batch_size: 1000, error_on_ignore: nil)
relation = self
unless block_given?
return to_enum(:find_in_batches, start: start, finish: finish, batch_size: batch_size, error_on_ignore: error_on_ignore) do
total = apply_limits(relation, start, finish).size
(total - 1).div(batch_size) + 1
end
end
in_batches(of: batch_size, start: start, finish: finish, load: true, error_on_ignore: error_on_ignore) do |batch|
yield batch.to_a
end
end
Defined in activerecord/lib/active_record/relation/batches.rb line 111
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveRecord::Batches