Installation

This guide will help you to install the package in your laravel project.

Require package

The first thing to do is to install packet if it has not already been done.

composer require patchlevel/laravel-event-sourcing=1.0.0-beta3

Configuration

Next you need to publish the event sourcing config file. It will be published to config/event-sourcing.php

php artisan vendor:publish --tag patchlevel-config

Schema

How the tables are created depends on the configured connection type.

Illuminate

With the illuminate connection type, which is the default, laravel manages the schema. You can publish the shipped migration with the following command:

php artisan vendor:publish --tag patchlevel-migrations

And then run the migrations:

php artisan migrate

The migration creates the event_store, subscriptions and crypto_keys tables. It is published into your application, so you can edit it like any other migration, for example to remove the crypto_keys table if you don't use cryptography.

Dbal

With the dbal connection type, the library manages the schema and derives the tables from your config. There is nothing to publish here, use the schema command instead:

php artisan event-sourcing:schema:create

There are also commands to update or drop the schema and to create or drop the database itself:

php artisan event-sourcing:schema:update
php artisan event-sourcing:schema:drop
php artisan event-sourcing:database:create
php artisan event-sourcing:database:drop

Middlewares

Some features need a middleware to work properly. You should add the middleware to your bootstrap/app.php file.

use Patchlevel\LaravelEventSourcing\Middleware\EventSourcingMiddleware;

$app->withMiddleware(static function (Middleware $middleware): void {
    $middleware->append(EventSourcingMiddleware::class);
});