Spec-Zone.ru › Ruby on Rails 7.2

класс ActiveRecord::Batches::BatchEnumerator

Родитель:
Объект
Включённые модули:
Enumerable

Атрибуты

finish[R]

Значение первичного ключа, по которому заканчивается BatchEnumerator, включая само значение.

relation[R]

Связь, из которой BatchEnumerator возвращает партии.

start[R]

Значение первичного ключа, с которого начинается BatchEnumerator, включая само значение.

Общедоступные методы экземпляра

batch_size() Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 27
def batch_size
  @of
end

Размер партий, возвращаемых BatchEnumerator.

delete_all() Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 65
def delete_all
  sum(&:delete_all)
end

Удаляет записи по частям. Возвращает общее количество затронутых строк.

Person.in_batches.delete_all

См. Relation#delete_all для подробностей о том, как удаляется каждая партия.

destroy_all() Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 96
def destroy_all
  sum do |relation|
    relation.destroy_all.count(&:destroyed?)
  end
end

Удаляет записи по частям. Возвращает общее количество затронутых строк.

Person.where("age < 10").in_batches.destroy_all

См. Relation#destroy_all для подробностей о том, как удаляется каждая партия.

each(&block) Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 107
def each(&block)
  enum = @relation.to_enum(:in_batches, of: @of, start: @start, finish: @finish, load: false, order: @order, use_ranges: @use_ranges)
  return enum.each(&block) if block_given?
  enum
end

Возвращает объект ActiveRecord::Relation для каждой партии записей.

Person.in_batches.each do |relation|
  relation.update_all(awesome: true)
end
each_record(&block) Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 52
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, order: @order).each do |relation|
    relation.records.each(&block)
  end
end

Проход по коллекции записей из базы данных (например, с использованием метода all) очень неэффективен, так как он попытается создать все объекты сразу.

В этом случае методы пакетной обработки позволяют работать с записями по частям, тем самым значительно снижая потребление памяти.

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

Если вы не передадите блок в each_record, он вернёт перечислитель для цепочки с другими методами:

Person.in_batches.each_record.with_index do |person, index|
  person.award_trophy(index + 1)
end
touch_all(...) Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 85
def touch_all(...)
  sum do |relation|
    relation.touch_all(...)
  end
end

Затрагивает записи по частям. Возвращает общее количество затронутых строк.

Person.in_batches.touch_all

См. Relation#touch_all для подробностей о том, как затрагивается каждая партия.

update_all(updates) Показать исходный код
# File activerecord/lib/active_record/relation/batches/batch_enumerator.rb, line 74
def update_all(updates)
  sum do |relation|
    relation.update_all(updates)
  end
end

Обновляет записи по частям. Возвращает общее количество затронутых строк.

Person.in_batches.update_all("age = age + 1")

См. Relation#update_all для подробностей о том, как обновляется каждая партия.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API