Yields each record that was found by the find options. The find is performed by find_in_batches with a batch size of 1000 (or as specified by the :batch_size option).
Example:
Person.where("age > 21").find_each do |person| person.party_all_night! end
Note: This method is only intended to use for batch processing of large amounts of records that wouldn’t fit in memory all at once. If you just need to loop over less than 1000 records, it’s probably better just to use the regular find methods.
# File lib/active_record/relation/batches.rb, line 19 19: def find_each(options = {}) 20: find_in_batches(options) do |records| 21: records.each { |record| yield record } 22: end 23: end
Yields each batch of records that was found by the find options as an array. The size of each batch is set by the :batch_size option; the default is 1000.
You can control the starting point for the batch processing by supplying the :start option. 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 option on that worker).
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 mean that this method only works with integer-based primary keys. You can’t set the limit either, that’s used to control the batch sizes.
Example:
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
# File lib/active_record/relation/batches.rb, line 48 48: def find_in_batches(options = {}) 49: relation = self 50: 51: unless arel.orders.blank? && arel.taken.blank? 52: ActiveRecord::Base.logger.warn("Scoped order and limit are ignored, it's forced to be batch order and batch size") 53: end 54: 55: if (finder_options = options.except(:start, :batch_size)).present? 56: raise "You can't specify an order, it's forced to be #{batch_order}" if options[:order].present? 57: raise "You can't specify a limit, it's forced to be the batch_size" if options[:limit].present? 58: 59: relation = apply_finder_options(finder_options) 60: end 61: 62: start = options.delete(:start).to_i 63: batch_size = options.delete(:batch_size) || 1000 64: 65: relation = relation.reorder(batch_order).limit(batch_size) 66: records = relation.where(table[primary_key].gteq(start)).all 67: 68: while records.any? 69: records_size = records.size 70: primary_key_offset = records.last.id 71: 72: yield records 73: 74: break if records_size < batch_size 75: 76: if primary_key_offset 77: records = relation.where(table[primary_key].gt(primary_key_offset)).to_a 78: else 79: raise "Primary key not included in the custom select clause" 80: end 81: end 82: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.