About this library

This is a store integration for @ocoda/event-sourcing, a library for NestJS with the building blocks for Domain-Driven Design (DDD), CQRS and Event Sourcing.

It provides the MariaDBEventStore and MariaDBSnapshotStore, on InnoDB: they keep events and snapshots in MariaDB or MySQL, with a global position per pool for readAll(). It is tested on MariaDB 10.11, 11.4, 11.8 and 12.3 and the newest rolling release, and, from 4.1, on MySQL 8.4 and 9.7 and the newest Innovation release: see supported versions. The same classes serve both servers.

On MySQL, logging in over TCP with caching_sha2_password needs TLS, cachingRsaPublicKey or allowPublicKeyRetrieval: see Connecting to MySQL. On a Galera cluster, a multi-primary Group Replication group, TiDB or Vitess, the event store reports globalOrder: 'best-effort': see Topologies and capabilities.

Installation

The mariadb driver (^3.5.3) is a peer dependency, so install it next to the core module:

npm install @ocoda/event-sourcing @ocoda/event-sourcing-mariadb mariadb

Requires Node.js 22.12 or later and NestJS 12. The package is ESM-only; CommonJS applications load it through require(), which Node.js supports for ES modules since 22.12. Keep it on the same version as @ocoda/event-sourcing.

Upgrading from 3.x

4.0 stores events and snapshots in a new schema (schema v2), and refuses a 3.x event table until it is migrated. Migrate it once, offline, with migrate(), after a dry run. migrate() runs on MariaDB only. See the runbook and Migrating from 3.x to 4.0.

Documentation 📗

• MariaDB and MySQL: the supported versions, the configuration, MySQL's authentication, the topologies, the schema, the privileges and the migration from 3.x.
• The documentation starts with the installation. The 3.x documentation is at ocoda.github.io/event-sourcing/v3.
• Versioning and support and the changelog.

Contact

[email protected]  

Acknowledgments

This library is inspired by @nestjs/cqrs