Class: ActiveRecord::Batches::BatchEnumerator
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | activerecord/lib/active_record/relation/batches/batch_enumerator.rb |
Class Method Summary
- .new(of: 1000, start: nil, finish: nil, relation:, cursor:, order: :asc, use_ranges: nil) ⇒ BatchEnumerator constructor Internal use only
Instance Attribute Summary
-
#finish
readonly
The primary key value at which the
BatchEnumerator
ends, inclusive of the value. -
#relation
readonly
The relation from which the
BatchEnumerator
yields batches. -
#start
readonly
The primary key value from which the
BatchEnumerator
starts, inclusive of the value.
::Enumerable
- Included
#many? | Returns |
Instance Method Summary
-
#batch_size
The size of the batches yielded by the
BatchEnumerator
. -
#delete_all
Deletes records in batches.
-
#destroy_all
Destroys records in batches.
-
#each(&block)
Yields an
::ActiveRecord::Relation
object for each batch of records. -
#each_record(&block)
Looping through a collection of records from the database (using the
all
method, for example) is very inefficient since it will try to instantiate all the objects at once. -
#touch_all
Touches records in batches.
-
#update_all(updates)
Updates records in batches.
::Enumerable
- Included
#compact_blank | Returns a new |
#exclude? | The negative of the |
#excluding | Returns a copy of the enumerable excluding the specified elements. |
#in_order_of | Returns a new |
#including | Returns a new array that includes the passed elements. |
#index_by | Convert an enumerable to a hash, using the block result as the key and the element as the value. |
#index_with | Convert an enumerable to a hash, using the element as the key and the block result as the value. |
#maximum | Calculates the maximum from the extracted elements. |
#minimum | Calculates the minimum from the extracted elements. |
#pick | Extract the given key from the first element in the enumerable. |
#pluck | Extract the given key from each element in the enumerable. |
#sole | Returns the sole item in the enumerable. |
#without | Alias for Enumerable#excluding. |
#as_json |
::ActiveSupport::EnumerableCoreExt::Constants
- Included
Constructor Details
.new(of: 1000, start: nil, finish: nil, relation:, cursor:, order: :asc, use_ranges: nil) ⇒ BatchEnumerator
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 8
def initialize(of: 1000, start: nil, finish: nil, relation:, cursor:, order: :asc, use_ranges: nil) # :nodoc: @of = of @relation = relation @start = start @finish = finish @cursor = cursor @order = order @use_ranges = use_ranges end
Instance Attribute Details
#finish (readonly)
The primary key value at which the BatchEnumerator
ends, inclusive of the value.
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 22
attr_reader :finish
#relation (readonly)
The relation from which the BatchEnumerator
yields batches.
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 25
attr_reader :relation
#start (readonly)
The primary key value from which the BatchEnumerator
starts, inclusive of the value.
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 19
attr_reader :start
Instance Method Details
#batch_size
The size of the batches yielded by the BatchEnumerator
.
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 28
def batch_size @of end
#delete_all
Deletes records in batches. Returns the total number of rows affected.
Person.in_batches.delete_all
See Relation#delete_all for details of how each batch is deleted.
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 66
def delete_all sum(&:delete_all) end
#destroy_all
Destroys records in batches. Returns the total number of rows affected.
Person.where("age < 10").in_batches.destroy_all
See Relation#destroy_all for details of how each batch is destroyed.
#each(&block)
Yields an ::ActiveRecord::Relation
object for each batch of records.
Person.in_batches.each do |relation|
relation.update_all(awesome: true)
end
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 108
def each(&block) enum = @relation.to_enum(:in_batches, of: @of, start: @start, finish: @finish, load: false, cursor: @cursor, order: @order, use_ranges: @use_ranges) return enum.each(&block) if block_given? enum end
#each_record(&block)
Looping through a collection of records from the database (using the all
method, for example) is very inefficient since it will try to instantiate all the objects at once.
In that case, batch processing methods allow you to work with the records in batches, thereby greatly reducing memory consumption.
Person.in_batches.each_record do |person|
person.do_awesome_stuff
end
Person.where("age > 21").in_batches(of: 10).each_record do |person|
person.party_all_night!
end
If you do not provide a block to #each_record
, it will return an Enumerator for chaining with other methods:
Person.in_batches.each_record.with_index do |person, index|
person.award_trophy(index + 1)
end
# File 'activerecord/lib/active_record/relation/batches/batch_enumerator.rb', line 53
def each_record(&block) return to_enum(:each_record) unless block_given? @relation.to_enum(:in_batches, of: @of, start: @start, finish: @finish, load: true, cursor: @cursor, order: @order).each do |relation| relation.records.each(&block) end end
#touch_all
Touches records in batches. Returns the total number of rows affected.
Person.in_batches.touch_all
See Relation#touch_all for details of how each batch is touched.
#update_all(updates)
Updates records in batches. Returns the total number of rows affected.
Person.in_batches.update_all("age = age + 1")
See Relation#update_all for details of how each batch is updated.