@ocoda/event-sourcing-mariadb 4.0.0-next.2 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -6
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -21,24 +21,29 @@
21
21
 
22
22
  ## About this library
23
23
 
24
- This is a complementing module for `@ocoda/event-sourcing`, a powerful library designed to simplify the implementation of advanced architectural patterns in your [**NestJS**](https://nestjs.com/) application. It provides essential building blocks to help you implement Domain-Driven Design (DDD), CQRS and leverage Event Sourcing to tackle the complexities of modern systems.
24
+ This is a store integration for `@ocoda/event-sourcing`, a library for [**NestJS**](https://nestjs.com/) with the building blocks for Domain-Driven Design (DDD), CQRS and Event Sourcing.
25
25
 
26
- This store-driver library uses [MariaDB](https://mariadb.com/) as an underlying driver for event- and snapshot-stores, and needs to be installed together with the core module `@ocoda/event-sourcing` in order to get started.
26
+ It provides the `MariaDBEventStore` and `MariaDBSnapshotStore`, on InnoDB: they keep events and snapshots in [MariaDB](https://mariadb.com/), 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.
27
27
 
28
28
  ## Installation
29
- The `mariadb` driver is a peer dependency, so install it next to the core module:
29
+ The `mariadb` driver (`^3.5.3`) is a peer dependency, so install it next to the core module:
30
30
  ```bash
31
31
  npm install @ocoda/event-sourcing @ocoda/event-sourcing-mariadb mariadb
32
32
  ```
33
33
 
34
- 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.
34
+ 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`.
35
+
36
+ ## Upgrading from 3.x
37
+ 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: see the [runbook](https://ocoda.github.io/event-sourcing/integrations/mariadb#runbook) and [Migrating from 3.x to 4.0](https://ocoda.github.io/event-sourcing/upgrading/v4).
35
38
 
36
39
  ## Documentation 📗
37
- Ready to dive right in? Visit [the documentation](https://ocoda.github.io/event-sourcing) to find out how to get started.
40
+ - [MariaDB](https://ocoda.github.io/event-sourcing/integrations/mariadb): the configuration, the schema, the privileges and the migration from 3.x.
41
+ - [The documentation](https://ocoda.github.io/event-sourcing) starts with the [installation](https://ocoda.github.io/event-sourcing/start/install). The 3.x documentation is at [ocoda.github.io/event-sourcing/v3](https://ocoda.github.io/event-sourcing/v3/).
42
+ - [Versioning and support](https://ocoda.github.io/event-sourcing/upgrading/versioning) and the [changelog](https://github.com/ocoda/event-sourcing/blob/master/packages/integration/mariadb/CHANGELOG.md).
38
43
 
39
44
  ## Contact
40
45
  dries@drieshooghe.com
41
46
   
42
47
 
43
48
  ## Acknowledgments
44
- This library is inspired by [@nestjs/cqrs](https://github.com/nestjs/cqrs)
49
+ This library is inspired by [@nestjs/cqrs](https://github.com/nestjs/cqrs)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ocoda/event-sourcing-mariadb",
3
- "version": "4.0.0-next.2",
3
+ "version": "4.0.0",
4
4
  "description": "NestJS Event Sourcing Library (@mariadb)",
5
5
  "keywords": [
6
6
  "nestjs",
@@ -50,7 +50,7 @@
50
50
  },
51
51
  "peerDependencies": {
52
52
  "@nestjs/common": "^12.0.0",
53
- "@ocoda/event-sourcing": "^4.0.0-next.2",
53
+ "@ocoda/event-sourcing": "^4.0.0",
54
54
  "mariadb": "^3.5.3"
55
55
  },
56
56
  "devDependencies": {
@@ -58,7 +58,7 @@
58
58
  "@nestjs/core": "12.1.1",
59
59
  "@nestjs/platform-express": "12.1.1",
60
60
  "@nestjs/testing": "12.1.1",
61
- "@ocoda/event-sourcing": "4.0.0-next.2",
61
+ "@ocoda/event-sourcing": "4.0.0",
62
62
  "@ocoda/event-sourcing-config": "1.0.0",
63
63
  "@ocoda/event-sourcing-testing": "1.0.0",
64
64
  "@types/node": "22.20.4",