https://github.com/endroid/flusher
Auto optimizing entity manager flusher
https://github.com/endroid/flusher
Last synced: about 1 year ago
JSON representation
Auto optimizing entity manager flusher
- Host: GitHub
- URL: https://github.com/endroid/flusher
- Owner: endroid
- License: mit
- Created: 2017-07-24T19:27:31.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T14:06:43.000Z (over 1 year ago)
- Last Synced: 2025-03-25T10:05:18.292Z (over 1 year ago)
- Language: PHP
- Homepage: http://endroid.nl/
- Size: 45.9 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Flusher
*By [endroid](https://endroid.nl/)*
[](https://packagist.org/packages/endroid/flusher)
[](https://github.com/endroid/flusher/actions)
[](https://packagist.org/packages/endroid/flusher)
[](https://packagist.org/packages/endroid/flusher)
[](https://packagist.org/packages/endroid/flusher)
When you import or modify large amounts of data it is often necessary to define
the optimal batch size before flushing: small batch sizes perform bad because of
the overhead in each flush. And batch sizes that are too large perform bad because
of the high memory usage and the need to calculate a large change set. Also the
batch size you choose can give different results on different types of hardware.
This library helps you write entities to the database without worrying about the
batch size. It incrementally tries new batch sizes (given a step size), sticks
with the one that gives the highest performance or switches to a better batch size
if the circumstances have changed.
## Installation
Use [Composer](https://getcomposer.org/) to install the library.
``` bash
$ composer require endroid/flusher
```
## Usage
In order to enable auto flushing you first need to create a Flusher for the
entity manager you are currently using.
```php
$flusher = new Flusher($manager);
```
Then when you performed operations on your entity manager you can call the
flush() method on the flusher any time to notify there are changes.
```php
for ($n = 1; $n <= 50000; $n++) {
$task = new Task();
$task->setName('Task '.$n);
$manager->persist($task);
$flusher->flush();
}
```
Because there is no way of knowing if there are pending flushes at the end you
need to call finish() to make sure all data is flushed.
```php
$flusher->finish();
```
## Versioning
Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatibility
breaking changes will be kept to a minimum but be aware that these can occur.
Lock your dependencies for production and test your code when upgrading.
## License
This bundle is under the MIT license. For the full copyright and license
information please view the LICENSE file that was distributed with this source code.