@spine-event-engine/storage-mysql 2.0.0-snapshot.13

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,243 @@
+# MySQL storage for Spine TS
+
+`@spine-event-engine/storage-mysql` stores Spine TS records in MySQL. It is a
+durable implementation of `@spine-event-engine/storage` and manages the mysql2
+connection pool and its private tables. PostgreSQL is not supported by this
+package.
+
+This is an experimental snapshot package. Use Node 24 or newer, generated
+record schemas, and a reachable MySQL database.
+
+For database requirements, query limits, lifecycle, and error details, see
+[REFERENCE documentation for agents](REFERENCE.md).
+
+## 💡 Why use it?
+
+- ✅ Stores Spine records durably in a MySQL database.
+- ✅ Manages a bounded `mysql2` connection pool; InnoDB writes are transactional.
+- ✅ Supports declared-column filters, sorting, offsets, limits, and
+  continuations.
+- ✅ Keeps adapter tables private behind the common `RecordStorage` API.
+
+## 🚀 First snapshot success
+
+```sh
+mkdir spine-mysql-app && cd spine-mysql-app
+pnpm init
+pnpm add @spine-event-engine/storage-mysql@snapshot @spine-event-engine/storage@snapshot @bufbuild/protobuf
+```
+
+Create an empty MySQL database, set an application-owned connection URL, and
+run the factory example below with Node 24 or newer. A successful read of
+`task-42` proves the installed snapshot can open its factory and store a record.
+The snapshot tag can change before a stable release.
+
+## 🔌 Create and close a MySQL factory
+
+Provide a MySQL URL that includes a database name. Building the factory opens
+its pool only; each record family creates and verifies its private table lazily
+on first use.
+
+<!-- docs-snippet-path: packages/storage-mysql/src/index.ts -->
+
+```ts
+import { create, ScalarType } from "@bufbuild/protobuf";
+import { StringValueSchema, type StringValue } from "@bufbuild/protobuf/wkt";
+import { ColumnTypes, RecordColumn, RecordSpec } from "@spine-event-engine/storage";
+import { MysqlStorageFactory } from "@spine-event-engine/storage-mysql";
+
+const factory = await MysqlStorageFactory.newBuilder()
+  .setOptions({
+    url: "mysql://user:password@127.0.0.1:3306/spine_app",
+    connectionLimit: 8,
+  })
+  .build();
+const records = factory.createRecordStorage(
+  { name: "Tasks", multitenant: false },
+  new RecordSpec<string, StringValue>({
+    recordType: StringValueSchema,
+    idKind: "string",
+    extractId: (record) => record.value,
+    columns: [
+      new RecordColumn("value", ColumnTypes.scalar(ScalarType.STRING), (record) => record.value),
+    ],
+  }),
+);
+
+try {
+  await records.write(create(StringValueSchema, { value: "task-42" }));
+  const stored = await records.read("task-42");
+  if (stored?.value !== "task-42") throw new Error("The record was not stored.");
+} finally {
+  await records.close();
+  factory.close();
+}
+```
+
+This local loopback example intentionally uses MySQL without TLS. In production,
+require TLS and provide the issuing CA explicitly; do not enable certificate
+verification without the CA material needed by your managed MySQL endpoint.
+
+For a multitenant application, assign each complete generated `TenantId` to a
+different database. The factory creates one pool per configured tenant and
+selects that pool before it opens a table or starts a transaction:
+
+```ts
+import { create } from "@bufbuild/protobuf";
+import { TenantIdSchema } from "@spine-event-engine/proto";
+import { MysqlStorageFactory } from "@spine-event-engine/storage-mysql";
+
+const acme = create(TenantIdSchema, { kind: { case: "value", value: "acme" } });
+const globex = create(TenantIdSchema, { kind: { case: "value", value: "globex" } });
+
+const factory = await MysqlStorageFactory.newBuilder()
+  .setTenantOptions([
+    { tenantId: acme, options: { url: "mysql://user:password@db/acme" } },
+    { tenantId: globex, options: { url: "mysql://user:password@db/globex" } },
+  ])
+  .build();
+```
+
+Use a dedicated database account. The account must be able to create and
+inspect the adapter tables and perform normal reads and writes. Do not commit
+connection URLs or credentials.
+
+## Build it in this workspace
+
+Contributors changing this repository can run the workspace-wide build from its
+root:
+
+```sh
+pnpm typecheck:build
+```
+
+## ✨ Supported records and queries
+
+The adapter performs record CRUD, payload-based compare-and-set, named-column
+queries, sort order, offsets, limits, and keyset continuations. InnoDB makes
+`writeAll` and Entity commits transactional. MyISAM and Aria instead use
+deterministic ordered writes with immutable-prefix retry semantics; a failed
+write may require an identical retry. It supports primitive and structured
+storage IDs. Declared columns support strings, booleans, integral Protobuf
+numbers, enums, bytes, messages, `Timestamp`, and `Version`. Spine JVM JDBC
+does not support `float` or `double` record columns, so this adapter rejects
+them too.
+
+MyISAM and Aria limit the byte length of an indexed key. Their `VARCHAR(512)`
+ID column therefore needs a one-byte binary collation, such as `latin1_bin`,
+and every ID must be representable in that character set. The normal InnoDB
+table can keep the database's Unicode character set.
+
+Each record source uses a separate private table. An ungrouped family defaults to
+its Proto full name with dots replaced by underscores. A grouped family uses
+the group name with dots replaced by underscores, followed by the record type's
+short name. Tables include native declared columns, but the adapter never adds
+user-column indexes automatically.
+
+The table contains exactly `ID`, the serialized `bytes`, the framework columns
+for that record family, and fields explicitly marked `(column)` in the Proto
+model. It does not get a separate SQL column for every Proto field. `ID` is the
+primary key. A Bounded Context name is useful in diagnostics, but it is never
+stored in a row and never changes a table name.
+
+For generated records, start by marking the few Proto fields that a query needs
+with `(column)`. Those declarations, not a field-name convention, select the
+native MySQL columns. `Identifiers` determine the storage ID, and `Stringifiers`
+turn message-valued IDs and declared message columns into the same stable text
+for a write, lookup, filter, sort continuation, and read. `RecordQuery<I>`
+statically types IDs only: MySQL validates filter names and values at runtime
+against the record descriptor and its declared column mappings.
+
+## 🧭 See a Proto model become a table
+
+Suppose an application declares this Projection state:
+
+```proto
+package spine.examples.messageboard;
+
+message MessageView {
+  MessageId id = 1 [(required) = true, (set_once) = true];
+  BoardId board = 2 [(column) = true];
+  UserId author = 3 [(column) = true];
+  string text = 4;
+}
+```
+
+The default current-state table is conceptually:
+
+```sql
+CREATE TABLE spine_examples_messageboard_MessageView (
+  ID VARCHAR(512) NOT NULL,
+  bytes BLOB NOT NULL,
+  archived BOOLEAN NOT NULL DEFAULT false,
+  deleted BOOLEAN NOT NULL DEFAULT false,
+  version INT NOT NULL DEFAULT 0,
+  board TEXT NULL,
+  author TEXT NULL,
+  PRIMARY KEY (ID)
+);
+```
+
+`ID` stores `MessageId` as compact Proto JSON, such as
+`{"value":"message-42"}`. `bytes` contains the authoritative generated
+`EntityRecord`, including the complete `MessageView` state. `archived`,
+`deleted`, and `version` are Entity lifecycle/version facts, not a provider
+revision. The `board` and `author` columns exist only because those Proto fields
+use `(column)`; `text` stays inside `bytes` because it is not a query column.
+
+For `board == BoardId("board-7")`, Spine uses the same reversible stringifier
+as the write and sends parameterized SQL equivalent to:
+
+```sql
+SELECT ID, bytes
+FROM spine_examples_messageboard_MessageView
+WHERE board = ?
+ORDER BY ID ASC;
+-- bound value: {"value":"board-7"}
+```
+
+MySQL compares the materialized column, then Spine decodes each matching
+authoritative `bytes` payload. The adapter does not create an index for
+`board`; add application indexes for production query patterns.
+
+## 🧪 Verify with a disposable database
+
+Run the opt-in integration suite against a disposable MySQL database:
+
+```sh
+SPINE_TS_MYSQL_URL='mysql://user:password@127.0.0.1:3306/spine_test' \
+  pnpm --filter @spine-event-engine/storage-mysql test:mysql
+```
+
+The test creates temporary adapter tables and removes them afterward. It is not a
+substitute for an application's backup, monitoring, permissions, or database
+operations plan.
+
+## ⚠️ Before production
+
+Use a dedicated database and account, protect the connection URL, configure
+TLS, and plan backups, monitoring, and migrations. Indexed `bigint` values must
+fit the exact signed 64-bit MySQL range. PostgreSQL is provided separately by
+[`@spine-event-engine/storage-postgres`](https://github.com/SpineEventEngine/spine-ts/blob/master/packages/storage-postgres/README.md).
+
+Before starting this corrected layout against an existing database, run the
+legacy-layout inventory for every configured tenant database:
+
+```sh
+pnpm --dir packages/storage-mysql inventory:legacy -- \
+  --url 'mysql://user:password@127.0.0.1:3306/tenant_a' \
+  --url 'mysql://user:password@127.0.0.1:3306/tenant_b'
+```
+
+The command exits nonzero if a database is unreachable or contains the old
+`_scope`, `_revision`, or compound scope key. Do not start the corrected
+runtime until it passes. The factory repeats this check for every configured
+database before it becomes usable. The runtime does not read both layouts or choose
+between rows that old Bounded Context partitions would collapse onto the same
+new `ID`; migrate those rows offline and stop on every conflict.
+
+## 🔗 Learn more
+
+- [Storage API](https://github.com/SpineEventEngine/spine-ts/blob/master/packages/storage/README.md)
+- [End-user storage guide](https://github.com/SpineEventEngine/spine-ts/blob/master/docs/USER_GUIDE.md#6-persist-application-data)
+- [Reference for coding agents](REFERENCE.md)

package/REFERENCE.md

@@ -0,0 +1,140 @@
+# @spine-event-engine/storage-mysql reference
+
+This reference is for agents configuring the supported MySQL storage adapter.
+
+## Public entry point
+
+Import `MysqlStorageFactory`, `MysqlStorageOptions`, `MysqlTenantStorageOptions`,
+`MysqlEntityStorageHandle`, `MysqlStorageFactoryBuilder`,
+`MysqlCreateOperation`, `CreateOperationFactory`, `MysqlTableSpec`,
+`MysqlColumnSpec`, `MysqlStorageConfigurationError`,
+`MysqlStorageConnectionError`, `MysqlStorageSchemaError`,
+`MysqlStorageDataError`, and `MysqlStorageOperationError` from
+`@spine-event-engine/storage-mysql`.
+
+## Connection and schema
+
+`MysqlStorageFactory.newBuilder().setOptions(options).build()` configures one
+single-tenant database. `setTenantOptions(entries)` configures one distinct
+database and pool per complete generated `TenantId`. The factory selects
+the matching pool before table, query, transaction, or lock work.
+`setStringifierRegistry(registry)` configures reversible mappings for
+message-valued IDs and ordinary message columns; the builder snapshots the
+registry so later caller changes do not alter stored or queried values.
+`Identifiers` choose the storage ID representation; the configured
+`StringifierRegistry` supplies the matching reversible representation for
+message-valued IDs and declared message columns. `RecordQuery<I>` statically
+types IDs only. Filter names and values are runtime inputs: MySQL checks the
+name against the declared columns and maps each value through the corresponding
+descriptor/column mapping, rather than accepting an application-constructed
+provider string.
+Per-family tables are created and verified lazily on first use. Options support
+`connectionLimit`, `connectTimeoutMs`, and TLS material. Failure to validate
+configuration throws `MysqlStorageConfigurationError`; inaccessible connections
+are reported as `MysqlStorageConnectionError`; an
+incompatible private table shape throws `MysqlStorageSchemaError`.
+
+The adapter supports MySQL and MariaDB InnoDB, MyISAM, and Aria family tables.
+It creates and verifies a family table lazily. An account therefore needs DDL
+permission, metadata reads, and DML. Existing tables are inspected and never
+altered.
+
+MyISAM and Aria impose a smaller primary-key byte limit than InnoDB. A family
+using the canonical `VARCHAR(512)` ID must therefore be provisioned with a
+one-byte binary collation, such as `latin1_bin`, and can store only IDs
+representable in that character set. An `utf8mb4` ID of that declared width
+cannot be converted to MyISAM.
+
+Before deployment, run `pnpm --dir packages/storage-mysql inventory:legacy --
+--url <database-url>` once for every configured tenant database. The command
+fails closed on connection errors, `_scope`, `_revision`, or an old primary key
+containing `_scope`. Passing this inventory is a startup prerequisite for an
+upgraded application. Factory build repeats the inspection for every configured
+database; the runtime has no dual-layout reader or automatic
+conflict winner.
+
+## Lifecycle and tenancy
+
+`close(): void` marks the factory and its live handles closed and starts pool
+draining. Callers do not await it. A record handle closes independently. A
+single-tenant factory has one database. A multitenant factory requires a
+complete generated `TenantId` on each operation and routes it to its configured
+database. Bounded Context names are diagnostic only and never partition rows,
+tables, locks, or queries.
+
+Each Entity source and history family has an independent table. Errors do not
+include connection URLs, credentials, or provider details.
+
+## Records and queries
+
+CRUD operations use normal statements. Payload-based compare-and-set uses an
+InnoDB transaction or a keyed `GET_LOCK` on MyISAM and Aria. On InnoDB,
+`writeAll` encodes the input first, applies entries in input order, and commits
+all rows or none. On MyISAM and Aria, `writeAll` has deterministic input-order
+semantics but is not transactional; a failed Entity prefix requires an
+identical retry. Repeated storage slots in a batch leave the last entry as the
+stored value. IDs are declared as generated message IDs or the supported
+primitive `string`, `int32`, and `int64` kinds. Primitive IDs use native MySQL
+values; message IDs use their reversible stringifier, compact Proto JSON by
+default.
+
+Every family table has `ID`, serialized `bytes`, and only the columns declared
+by its framework record and Proto model, with primary key `(ID)`. Current Entity
+tables declare `archived`, `deleted`, and Entity `version` in addition to model
+`(column)` fields. Those three framework columns are non-null and default to
+`false`, `false`, and `0`, respectively; Entity `version` is not a provider
+revision. Proto fields without `(column)` exist only inside the authoritative
+`bytes` record and never become SQL columns. Existing layouts are inspected and
+never altered. A mismatched type, nullability, primary key, unique constraint,
+or extra column is rejected. Ordinary message columns use the same configured
+reversible stringifier for writes and query operands. `Timestamp` uses epoch
+nanoseconds and `Version` uses its number. Floating-point record columns are
+not supported by Spine JVM JDBC and are rejected here.
+
+Queries execute ID filters, ANDed column filters, materialized-column sorts,
+keyset continuations, offsets, and limits in MySQL. Before executing, MySQL
+validates each ID encoding, requires every filter and sort name to be `ID` or a
+declared materialized column, and maps each filter/continuation value through
+that column's descriptor. Missing materialized columns do not match; dotted
+payload paths are rejected. Large offsets can be expensive.
+
+Normalized projection plans compile IDs, equality, all five comparisons, nested
+`all` / `either`, ordering, limits, and masks to one parameterized SQL statement.
+A mask is applied only after an otherwise fully bounded complete-record fetch.
+Normalized plans have no offset; `RecordQuery.offset` remains separate. The selected
+tenant pool is acquired before the resolved family table is accessed; only that
+validated table and declared columns are interpolated, while IDs, operands, and
+limits are bound. Ordering ends with `ID` for a stable tie-break. An omitted
+query budget accepts at most 10,000 rows; an explicit value cannot exceed
+10,000. The provider fetches only the
+smaller safe bound from the exact limit and query budget plus one, so it may
+read one overflow-lookahead row (10,001 raw rows at the default) before
+rejecting an oversized result. The primary
+key serves ID queries; operators must add indexes for workload equality, range,
+and composite filter/order patterns. Without them MySQL may scan or sort despite
+the runtime materialization bound. To keep one normalized statement finite,
+MySQL accepts at most 1,000 bound parameters including its provider limit;
+oversized ID sets or composite predicate bind work reject before a connection is
+acquired.
+
+## Entity history seam
+
+The provider/framework Entity handle returns current records plus immutable
+state and event history. It is not a remote application history API. State append and retention for one entity use a MySQL server lock;
+this coordination applies to one MySQL server only. Trim and truncate use
+fixed-size chunks. A failed chunk can leave earlier chunks durable, so callers
+retry maintenance. Current-record and history actions are separate calls, not
+one cross-storage transaction.
+
+The internal atomic Entity commit port writes current state, configured history,
+and framework delivery events. InnoDB uses one connection transaction;
+nontransactional engines use a deterministic immutable-history prefix and may
+require an identical retry after a storage failure. Standalone history
+operations remain separate.
+
+`MysqlStorageSchemaError` reports incompatible layouts,
+`MysqlStorageDataError` reports stored bytes that cannot be decoded, and
+`MysqlStorageOperationError` reports sanitized bounds, query, collision, and
+driver-operation failures. Custom creation uses `useOperationFactory()`; its
+resolved `MysqlTableSpec` has the same native column types and naming precedence
+as default DDL (explicit grouped name, explicit record name, then default).

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { MysqlStorageConfigurationError, MysqlStorageConnectionError, MysqlStorageDataError, MysqlStorageFactory, MysqlStorageOperationError, MysqlStorageSchemaError, type CreateOperationFactory, type MysqlColumnSpec, type MysqlCreateOperation, type MysqlStorageFactoryBuilder, type MysqlStorageOptions, type MysqlTenantStorageOptions, type MysqlTableSpec, } from "./mysql/storage-factory.js";
+export type { MysqlEntityStorageHandle } from "./mysql/entity-history.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,8BAA8B,EAC9B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACnB,0BAA0B,EAC1B,uBAAuB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,cAAc,GACpB,MAAM,4BAA4B,CAAC;AACpC,YAAY,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2026, CodeMatters. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+export { MysqlStorageConfigurationError, MysqlStorageConnectionError, MysqlStorageDataError, MysqlStorageFactory, MysqlStorageOperationError, MysqlStorageSchemaError, } from "./mysql/storage-factory.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,8BAA8B,EAC9B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACnB,0BAA0B,EAC1B,uBAAuB,GAQxB,MAAM,4BAA4B,CAAC"}

package/dist/mysql/column-mapping.d.ts

@@ -0,0 +1,27 @@
+import { StringifierRegistry } from "@spine-event-engine/core";
+import type { ColumnMapping, ColumnTypeMapping, RecordColumnType } from "@spine-event-engine/storage";
+/**
+ * Converts typed Protobuf column values to Spine JVM JDBC values.
+ */
+export declare class MysqlColumnMapping implements ColumnMapping<unknown> {
+    #private;
+    /**
+     * Creates a JVM-compatible MySQL column mapping.
+     *
+     * @param stringifiers The schema-bound message stringifiers.
+     */
+    constructor(stringifiers?: StringifierRegistry);
+    /**
+     * Returns the conversion for one generated column type.
+     *
+     * @param type The generated Protobuf column type.
+     * @returns The JVM-compatible MySQL parameter conversion.
+     */
+    of<V>(type: RecordColumnType<V>): ColumnTypeMapping<V, unknown>;
+    /**
+     * Returns SQL null unchanged.
+     * @returns The null conversion.
+     */
+    ofNull(): ColumnTypeMapping<null, unknown>;
+}
+//# sourceMappingURL=column-mapping.d.ts.map

package/dist/mysql/column-mapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"column-mapping.d.ts","sourceRoot":"","sources":["../../src/mysql/column-mapping.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAKrC;;GAEG;AACH,qBAAa,kBAAmB,YAAW,aAAa,CAAC,OAAO,CAAC;;IAG/D;;;;OAIG;gBACS,YAAY,GAAE,mBAA+C;IAMzE;;;;;OAKG;IACH,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,OAAO,CAAC;IAoB/D;;;OAGG;IACH,MAAM,IAAI,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC;CAG3C"}