Code Monkey home page Code Monkey logo

batchtrine's Introduction

Simple garbage collector for easy batch processing with Doctrine ORM.

Installation

composer require adawolfa/batchtrine

Usage

The GC works by copying the identity map from the Unit of Work at the start of each batch and later selectively detaching all the entities that weren't previously part of it. Such entities shouldn't generally be used outside the scope of the batch.

This is supposed to solve the problem with EntityManager::clear(), which renders all the existing references to entities throughout the application invalid, and it's much more straightforward than detaching entities manually.

Single batch

The batch() method runs the supplied callback, forwards its return value and detaches all entities that have been loaded or created during its execution.

$gc = new Adawolfa\Batchtrine\GC($em);

$a = $em->getRepository(Entity::class)->findBy(['code' => 'a']);

$b = $gc->batch(function () use ($em): Entity {
	return $em->getRepository(Entity::class)->findBy(['code' => 'b']);
});

$em->contains($a); // true
$em->contains($b); // false - entity is detached

Iterator

The iterate() method returns a proxy iterator which periodically performs the GC cycle after set number of iterations ($interval).

$a = $em->getRepository(Entity::class)->findBy(['code' => 'a']);

foreach ($gc->iterate($ids) as $id) {
	$entity = $em->getRepository(Entity::class)->find($id);
	assert($a !== $entity);
	// ...
}

$em->contains($a);      // true
$em->contains($entity); // false

Pagination

The paginate() method is useful for traversing through a large result set Doctrine\ORM\Query. The results are obtained by executing the query repeatedly with a smaller limit ($interval) and increasing offset. The GC cycle happens every time before a new result page is fetched.

$a = $em->getRepository(Entity::class)->findBy(['code' => 'a']);

$query = $em->createQueryBuilder()
	->select('e')
	->from(Entity::class, 'e')
	->getQuery();

foreach ($gc->paginate($query) as $entity) {
	assert($a !== $entity);
	// ...
}

$em->contains($a);      // true
$em->contains($entity); // false

For frequently changing data, you should use search-after approach instead.

$query = $em->createQueryBuilder()
	->select('e')
	->from(Entity::class, 'e')
	->where('e.id > :id')
	->orderBy('e.id')
	->getQuery();

$after = function (Query $query, ?Entity $last): void {
	$query->setParameter('id', $last?->id ?? 0);
};

foreach ($gc->paginate($query, after: $after) as $entity) {
	assert($a !== $entity);
	// ...
}

batchtrine's People

Contributors

adawolfa avatar

Watchers

 avatar

batchtrine's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.