Flowdock
method

in_batches

Importance_3
v6.0.0 - Show latest stable - 0 notes - Class: ActiveRecord::Batches
in_batches(of: 1000, start: nil, finish: nil, load: false, error_on_ignore: nil) public

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 an order is present in the relation.

Limits are honored, and if present there is no requirement for the batch size, it can be less than, equal, or greater than the limit.

The options start and finish are especially useful if you want multiple workers dealing with the same processing queue. You can make worker 1 handle all the records between id 1 and 9999 and worker 2 handle from 10000 and beyond by setting the :start and :finish option on each worker.

# Let's process from record 10_000 on.
Person.in_batches(start: 10_000).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: By its nature, batch processing is subject to race conditions if other processes are modifying the database.

Show source
Register or log in to add new notes.