micro-module/snapshotting

POC for snapshotting aggregates in broadway/broadway

v0.7.9 2024-12-13 12:41 UTC

Requires

• php: ^8.0
• ext-json: *
• doctrine/dbal: ^2.9 | ^3.3
• micro-module/base: ^0.7.0
• micro-module/broadway: ^2.6
• micro-module/value-object: ^0.6.0

Requires (Dev)

• mockery/mockery: ^1.4
• php-parallel-lint/php-console-highlighter: ^0.5.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpmd/phpmd: ^2.10
• phpstan/phpstan: ^0.12.96
• phpstan/phpstan-mockery: ^0.12.14
• phpstan/phpstan-phpunit: ^0.12.22
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-master
• symplify/easy-coding-standard: ^9.4
• vimeo/psalm: ^4.9

proprietary

README

Proof-of-concept component providing snapshotting functionality to broadway/broadway.

Documentation

This project demonstrates taking and using snapshots of an aggregate root in the EventSourcingRepository.

Snaphots can be triggered using different strategies like once every number of events or after an amount of time has passed. The EventCountTrigger implements the former strategy.

Getting started

This repository is just a library. It lacks (for now) implementations of the SnapshotRepository.

For example if you want store your events and snapshots in a database using doctrine/dbal you will have to:

• create a DBALSnapshotRepository implementing the SnapshotRepository to store and fetch snapshots. You wil have to figure out how to serialize your aggregate root.

License

This project is licensed under the MIT License - see the LICENSE file for details