๐งบ EachInBatches
๐ป Synopsis
Better than Rails Batching. Can you batch backwards for destructive tasks? each_in_batches
can.
๐ Amazing test matrix was brought to you by | ๐ appraisal2 ๐ |
---|---|
๐ Check it out! | โจ github.com/appraisal-rb/appraisal2 โจ |
๐ก Info you can shake a stick at
Federated DVCS
Federated DVCS Repository | Status | Issues | PRs | Wiki | CI | Discussions |
---|---|---|---|---|---|---|
๐งช galtzo-floss/each_in_batches on GitLab | The Truth | ๐ | ๐ | ๐ | ๐ Tiny Matrix | โ |
๐ง galtzo-floss/each_in_batches on CodeBerg | An Ethical Mirror (Donate) | ๐ | ๐ | โ | โญ๏ธ No Matrix | โ |
๐ galtzo-floss/each_in_batches on GitHub | A Dirty Mirror | ๐ | ๐ | โ | ๐ฏ Full Matrix | ๐ |
๐ฎ๏ธ Discord Server | Let's | talk | about | this | library! |
- ๐กSubscribe for support guarantees covering all FLOSS dependencies
- ๐กTidelift is part of Sonar
- ๐กTidelift pays maintainers to maintain the software you depend on!
๐@
Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers
Alternatively:
Tokens to Remember |
|
---|---|
Works with JRuby |
|
Works with Truffle Ruby |
|
Works with MRI Ruby 3 |
|
Works with MRI Ruby 2 |
|
Works with MRI Ruby 1 | |
Source |
|
Documentation |
|
Compliance |
|
Style |
|
Support |
|
Maintainer ๐๏ธ |
|
... ๐ |
|
โจ Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add each_in_batches
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install each_in_batches
๐ Secure Installation
This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasnโt been tampered with by following the instructions below.
Add my public key (if you havenโt already, expires 2045-04-29) as a trusted certificate:
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
You only need to do that once. Then proceed to install with:
gem install each_in_batches -P HighSecurity
The HighSecurity
trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
If you want to up your security game full-time:
bundle config set --global trust-policy MediumSecurity
MediumSecurity
instead of HighSecurity
is necessary if not all the gems you use are signed.
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
๐ง Basic Usage
To create a new Batch, call Batch#new
pass it the class and any additional arguments (all as a hash).
batch = EachInBatches::Batch.new(:arel => Payment.canceled.order("transaction_id ASC"), :batch_size => 50)
To process the batched data, pass a block to Batch#run
the same way you would to an object in a block like Klass.all.each {|x| x.do_something }
.
Batch#run
will pass the data to your block, one at a time, in batches set by the :batch_size argument.
batch.run {|x| puts x.id; puts x.transaction_id}
Print the results!
batch.print_results
Or...
Consolidate your code if you prefer
EachInBatches::Batch.new(:arel => Payment.canceled.order("transaction_id ASC"), batch_size => 50, :show_results => true).run{|x| puts x.id; puts x.transaction_id}
Configuration
Arguements for the initializer (Batch.new) method are:
Required:
:arel - Usage: :arel => Payment.canceled.order("transaction_id ASC")
Required, as this is the class that will be batched
Optional:
:verbose - Usage: :verbose => true or false
Sets verbosity of output
Default: false (if not provided)
:backwards - Usage: :backwards => true or false
Using the order supplied for :arel (if any) figures out what the batch set looks like,
and begins working from the end rather than the front.
Default: false (if not provided)
Example: EachInBatches::Batch.new(:arel => Report.where(company_id: nil).order("id ASC"), :backwards => true, :batch_size => 50).run{|x| x.destroy }
:batch_size - Usage: :batch_size => x
Where x is some number.
How many AR Objects should be processed at once?
Default: 50 (if not provided)
:last_batch - Usage: :last_batch => x
Where x is some number.
Only process up to and including batch #x.
Batch numbers start at 0 for the first batch.
Default: won't be used (no limit if not provided)
:first_batch - Usage: first_batch => x
Where x is some number.
Begin processing batches beginning at batch #x.
Batch numbers start at 0 for the first batch.
Default: won't be used (no offset if not provided)
:show_results - Usage: :show_results => true or false
Prints statistics about the results of Batch#run.
Default: true if verbose is set to true and :show_results is not provided, otherwise false
Output
Interpreting the output:
'[O]' means the batch was skipped due to an offset.
'[L]' means the batch was skipped due to a limit.
'[P]' means the batch is processing.
'[C]' means the batch is complete.
and yes... it was a coincidence. This class is not affiliated with 'one laptop per child'
FLOSS Funding
How wonderful it is that nobody need wait a single moment before starting to improve the world.
โAnne Frank
Iโm driven by a passion to foster a thriving open-source community โ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions โ totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโm reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐ chickens, 2 ๐ถ dogs, 3 ๐ฐ rabbits, 8 ๐โ cats).
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund
.
Iโm developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
Floss-Funding.dev: ๐๏ธ No network calls. ๐๏ธ No tracking. ๐๏ธ No oversight. ๐๏ธ Minimal crypto hashing. ๐ก Easily disabled nags
๐ Security
See SECURITY.md.
๐ค Contributing
If you need some ideas of where to help, you could work on adding more code coverage, or if it is already ๐ฏ (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
๐ Release Instructions
See CONTRIBUTING.md.
Code Coverage
๐ช Code of Conduct
Everyone interacting with this project's codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .
๐ Contributors
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/galtzo-floss/each_in_batches/-/graphs/main
โญ๏ธ Star History
๐ Versioning
This Library adheres to .
Violations of this scheme should be reported as bugs.
Specifically, if a minor or patch version is released that breaks backward compatibility,
a new version should be immediately released that restores compatibility.
Breaking changes to the public API will only be introduced with new major versions.
dropping support for a platform is both obviously and objectively a breaking change
โJordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716
I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("each_in_batches", "~> 1.0")
SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:
See CHANGELOG.md for a list of releases.
๐ License
The gem is available as open source under the terms of
the MIT License .
See LICENSE.txt for the official Copyright Notice.
ยฉ Copyright
-
Copyright (c) 2008-2015, 2025 Peter H.ย Boling, of
Galtzo.com
, Brian Kidd, and each_in_batches contributors
P.S. If you need help๏ธ or want to say thanks, ๐ Join the Discord.