Module: OccamsRecord::Batches

Included in:
Query, RawQuery
Defined in:
lib/occams-record/batches.rb

Overview

Methods for building batch finding methods. It expects “model” and “scope” methods to be present.

Instance Method Summary collapse

Instance Method Details

#find_each(batch_size: 1000, use_transaction: true) {|OccamsRecord::Results::Row| ... } ⇒ Enumerator

Load records in batches of N and yield each record to a block if given. If no block is given, returns an Enumerator.

NOTE Unlike ActiveRecord’s find_each, ORDER BY is respected. It will be run inside of a transaction to ensure batch integrity.

Yields:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/occams-record/batches.rb', line 18

def find_each(batch_size: 1000, use_transaction: true)
  enum = Enumerator.new { |y|
    batches(of: batch_size, use_transaction: use_transaction).each { |batch|
      batch.each { |record| y.yield record }
    }
  }
  if block_given?
    enum.each { |record| yield record }
  else
    enum
  end
end

#find_in_batches(batch_size: 1000, use_transaction: true) {|OccamsRecord::Results::Row| ... } ⇒ Enumerator

Load records in batches of N and yield each batch to a block if given. If no block is given, returns an Enumerator.

NOTE Unlike ActiveRecord’s find_each, ORDER BY is respected. The primary key will be appended to the ORDER BY clause to help ensure consistent batches. Additionally, it will be run inside of a transaction.

Yields:



44
45
46
47
48
49
50
51
 
# File 'lib/occams-record/batches.rb', line 44

def find_in_batches(batch_size: 1000, use_transaction: true)
  enum = batches(of: batch_size, use_transaction: use_transaction)
  if block_given?
    enum.each { |batch| yield batch }
  else
    enum
  end
end