@zmdb/mysql 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,6 @@
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This package is part of zmdb and is licensed under the GNU General Public
+License, version 3 or (at your option) any later version. The complete license
+text is distributed in the root LICENSE file of the source repository:
+https://github.com/ambasta/zmdb/blob/main/LICENSE

package/README.md

@@ -0,0 +1,111 @@
+# @zmdb/mysql
+
+The MySQL vertical owns the immutable `mysql` dialect, its migration hooks and catalog introspector, and the `mysqlDriver` adapter. The shared query compiler comes from `@zmdb/sql`; repository and
+driver contracts come from `@zmdb/orm`. `mysqlVertical` pairs this dialect with its driver factory.
+
+## Install
+
+```bash
+yarn add @zmdb/mysql@1.0.0-beta.1 @zmdb/sql@1.0.0-beta.1 @zmdb/migrations@1.0.0-beta.1 mysql2@^3.24.3
+```
+
+For the TypeScript snippets, install the declaration inputs used by the packed consumer:
+
+```bash
+yarn add --dev typescript@7.0.2 @types/node@26.4.1
+```
+
+Use Node.js 26+ and ESM. Keep the required `@zmdb/sql` and `@zmdb/orm` peers aligned with this package's version; npm resolves those peers. An application already using `zmdb` adds its selected
+database package and client rather than replacing the product facade.
+
+`mysql2` is an optional peer in package metadata; install it explicitly for this recipe. The vertical neither imports the SDK nor creates a pool. Applications choose pool options such as charset and
+large-number representation.
+
+## Configure
+
+The snippets below are successive steps in one module.
+
+```ts
+import { createPool } from 'mysql2/promise';
+import { mysql, mysqlDriver } from '@zmdb/mysql';
+
+const address = process.env.DATABASE_URL;
+if (address === undefined) throw new Error('DATABASE_URL is required');
+const client = createPool(address);
+const driver = mysqlDriver(client);
+```
+
+The application owns the client and closes it with `await client.end()` in a `finally` block after its work. Hosted services that accept this client's protocol are connection recipes, not additional
+official database packages or automatically qualified server variants.
+
+## Compile
+
+```ts
+import { createQueryCompiler } from '@zmdb/sql';
+
+const compiler = createQueryCompiler(mysql);
+const query = compiler.selectFrom('users').where('id', '=', 7).compile();
+```
+
+Compilation is pure: the result carries SQL text and a separate parameter array. It does not create the `users` table or open a connection.
+
+## Migrate
+
+Use `mysql.migrations.emitUp(operation)` to obtain this database's DDL and `mysql.migrations.connection(driver)` to create its migration connection. Pass reviewed migration records to `up` and `down`
+from `@zmdb/migrations`; transactional behavior follows the capability table below. The [complete installed workflow](../../fixtures/consumer-database-publication/runtime.mjs) creates a fresh table,
+applies and rolls back its migration, and closes the supplied client.
+
+## Introspect
+
+```ts
+const snapshot = await mysql.introspector.snapshot(driver);
+```
+
+The snapshot comes from the selected database's real catalog through the same driver. `mysqlIntrospector` is also exported directly. Introspection and generated DDL use this vertical's semantics.
+
+## Execute
+
+```ts
+const rows = await driver.execute(query);
+```
+
+Run this after migrating or otherwise creating the table. Use `driver.transaction(async transaction => ...)` for a pinned transactional driver; the application decides whether to retry. Query values
+travel as parameters, not SQL string interpolation.
+
+## Capabilities
+
+These entries describe `mysql.capabilities`; a true entry can still require the client support described below.
+
+| Capability                            | Advertised support |
+| ------------------------------------- | ------------------ |
+| INSERT/upsert/UPDATE/DELETE returning | no                 |
+| Transactional DDL                     | no                 |
+| Schemas                               | yes                |
+| Sequences                             | no                 |
+| Generated columns                     | yes                |
+| Partial indexes                       | no                 |
+| Foreign keys                          | yes                |
+| Row-level security                    | no                 |
+| Streaming                             | no                 |
+| Server-side cancellation              | no                 |
+
+## Refusals and ownership
+
+The compiler and migration hooks refuse `RETURNING`, standalone sequences, partial indexes and row-level security. DDL is not transactional. `execute` returns an empty row array for commands; use the
+public `executeResult` method when affected-row or insert-ID metadata is needed. Streaming and server-side cancellation are not advertised.
+
+MySQL owns the parent dialect and structural mysql2 adapter. `@zmdb/singlestore` depends on its public family factories and supplies a distinct dialect, migration hooks and introspector. The parent
+does not depend on its child, and a MySQL connection is not a SingleStore qualification.
+
+## Testing evidence
+
+The [database publication qualification](../../fixtures/consumer-database-publication) builds real npm archives and installs this selected package in an independent consumer. Its public workflow
+covers strict declarations, package/client ownership, parameterized CRUD, transaction rollback, migration application/rollback and catalog introspection. The
+[MySQL consumer](../../fixtures/database-mysql) adds the database-specific capability and refusal checks.
+
+Issue [#676](https://github.com/ambasta/zmdb/issues/676) records the completed installed workflows. Those observations are scoped to their recorded clients and servers; they do not certify every
+compatible hosted service. Qualification reports identify their source, archive and server inputs. See the [MySQL guide](../../docs-site/content/dialect-mysql.md) for the detailed contract.
+
+## License
+
+GNU General Public License v3.0 or later (GPL-3.0-or-later) — see [LICENSE](./LICENSE).

package/dist/dialect.d.ts

@@ -0,0 +1,2 @@
+export declare const mysql: import("@zmdb/sql").SqlDialect<"mysql">;
+//# sourceMappingURL=dialect.d.ts.map

package/dist/dialect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialect.d.ts","sourceRoot":"","sources":["../src/dialect.ts"],"names":[],"mappings":"AAmFA,eAAO,MAAM,KAAK,yCAehB,CAAC"}

package/dist/dialect.js

@@ -0,0 +1,91 @@
+import { defineSqlDialect, } from '@zmdb/sql';
+import { mysqlIntrospector } from './introspect.js';
+import { createMysqlMigrations } from './migrations.js';
+const OPERATOR_TOKEN = /^(?!.*--)[A-Za-z@<>=!~*&|?-]{1,4}$/;
+function acceptsOperator(operator) {
+    if (operator === '#>' || operator === '#>>')
+        return false;
+    return OPERATOR_TOKEN.test(operator) && !operator.includes('?');
+}
+function paginate({ limit, offset }) {
+    if (limit === undefined && offset !== undefined) {
+        return ` LIMIT 18446744073709551615 OFFSET ${String(offset)}`;
+    }
+    let text = '';
+    if (limit !== undefined)
+        text += ` LIMIT ${String(limit)}`;
+    if (offset !== undefined)
+        text += ` OFFSET ${String(offset)}`;
+    return text;
+}
+const traits = {
+    placeholder: 'positional',
+    quote: Object.freeze(['`', '`']),
+    paginate,
+    paginationRequiresOrder: false,
+    rowValueIn: true,
+    returning: Object.freeze({
+        insert: 'none',
+        upsert: 'none',
+        update: 'none',
+        delete: 'none',
+    }),
+    upsert: 'onDuplicateKey',
+    fts: 'match',
+    concat: 'function',
+    booleanNot: 'not',
+    types: Object.freeze({
+        serial: 'INT AUTO_INCREMENT',
+        integer: 'INT',
+        bigint: 'BIGINT',
+        numeric: 'DECIMAL',
+        text: 'TEXT',
+        varchar: 'VARCHAR',
+        boolean: 'TINYINT(1)',
+        timestamp: 'DATETIME(3)',
+        json: 'JSON',
+        jsonEnum: 'TEXT',
+    }),
+    paramLimit: 60000,
+    retryableCodes: Object.freeze([]),
+    acceptsOperator,
+    functions: true,
+    procedures: true,
+    tableFunctions: false,
+    vectorDistance: false,
+    spatialPredicates: false,
+};
+const capabilities = {
+    returning: Object.freeze({
+        insert: false,
+        upsert: false,
+        update: false,
+        delete: false,
+    }),
+    transactionalDdl: false,
+    schemas: true,
+    sequences: false,
+    generatedColumns: true,
+    partialIndexes: false,
+    foreignKeys: true,
+    rowLevelSecurity: false,
+    streaming: false,
+    cancellation: false,
+};
+export const mysql = defineSqlDialect({
+    name: 'mysql',
+    family: 'mysql',
+    telemetrySystem: 'mysql',
+    traits,
+    capabilities,
+    migrations: createMysqlMigrations('mysql'),
+    introspector: mysqlIntrospector,
+    outbox: Object.freeze({
+        createTable: 'CREATE TABLE',
+        pendingIndex: 'full',
+        epochLiteral: "'1970-01-01 00:00:00.000'",
+        createdAtDefault: 'CURRENT_TIMESTAMP(3)',
+        boundedTextType: (length) => `VARCHAR(${String(length)})`,
+    }),
+});
+//# sourceMappingURL=dialect.js.map

package/dist/dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialect.js","sourceRoot":"","sources":["../src/dialect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,GAIjB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,cAAc,GAAG,oCAAoC,CAAC;AAE5D,SAAS,eAAe,CAAC,QAAgB;IACvC,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IAC1D,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,EAAkB;IACjD,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAChD,OAAO,sCAAsC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAChE,CAAC;IACD,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,KAAK,KAAK,SAAS;QAAE,IAAI,IAAI,UAAU,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC3D,IAAI,MAAM,KAAK,SAAS;QAAE,IAAI,IAAI,WAAW,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,MAAM,GAA0B;IACpC,WAAW,EAAE,YAAY;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAChC,QAAQ;IACR,uBAAuB,EAAE,KAAK;IAC9B,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC;QACvB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM;KACf,CAAC;IACF,MAAM,EAAE,gBAAgB;IACxB,GAAG,EAAE,OAAO;IACZ,MAAM,EAAE,UAAU;IAClB,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,oBAAoB;QAC5B,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,SAAS;QAClB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE,aAAa;QACxB,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,MAAM;KACjB,CAAC;IACF,UAAU,EAAE,KAAK;IACjB,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACjC,eAAe;IACf,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,KAAK;IACrB,cAAc,EAAE,KAAK;IACrB,iBAAiB,EAAE,KAAK;CACzB,CAAC;AAEF,MAAM,YAAY,GAAyB;IACzC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC;QACvB,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,KAAK;KACd,CAAC;IACF,gBAAgB,EAAE,KAAK;IACvB,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,KAAK;IAChB,gBAAgB,EAAE,IAAI;IACtB,cAAc,EAAE,KAAK;IACrB,WAAW,EAAE,IAAI;IACjB,gBAAgB,EAAE,KAAK;IACvB,SAAS,EAAE,KAAK;IAChB,YAAY,EAAE,KAAK;CACpB,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,gBAAgB,CAAC;IACpC,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,OAAO;IACf,eAAe,EAAE,OAAO;IACxB,MAAM;IACN,YAAY;IACZ,UAAU,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAC1C,YAAY,EAAE,iBAAiB;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;QACpB,WAAW,EAAE,cAAc;QAC3B,YAAY,EAAE,MAAM;QACpB,YAAY,EAAE,2BAA2B;QACzC,gBAAgB,EAAE,sBAAsB;QACxC,eAAe,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,WAAW,MAAM,CAAC,MAAM,CAAC,GAAG;KAClE,CAAC;CACH,CAAC,CAAC"}

package/dist/driver.d.ts

@@ -0,0 +1,48 @@
+import { type ExecuteOptions, type TransactionalDriver } from '@zmdb/orm';
+import { type CompiledQuery, type SqlDialect } from '@zmdb/sql';
+export interface MysqlResultHeader {
+    readonly affectedRows: number;
+    readonly insertId: number | string | bigint;
+    readonly warningStatus?: number;
+}
+export type MysqlQueryResult = readonly Readonly<Record<string, unknown>>[] | MysqlResultHeader;
+export type MysqlParameter = string | number | bigint | boolean | Date | null | Uint8Array | MysqlParameter[] | {
+    readonly [key: string]: MysqlParameter;
+};
+/**
+ * The mysql2/promise surface used by the adapter. It is deliberately structural:
+ * importing @zmdb/mysql does not resolve or load mysql2.
+ */
+export interface MysqlQueryable {
+    execute(sql: string, values?: MysqlParameter[]): Promise<readonly [unknown, readonly unknown[]]>;
+    /** Optional mysql2 text protocol for metadata statements that the prepared protocol rejects. */
+    query?(sql: string, values?: MysqlParameter[]): Promise<readonly [unknown, readonly unknown[]]>;
+}
+export interface MysqlConnection extends MysqlQueryable {
+    beginTransaction(): Promise<unknown>;
+    commit(): Promise<unknown>;
+    rollback(): Promise<unknown>;
+    release?(): void;
+}
+export interface MysqlPool extends MysqlQueryable {
+    getConnection(): Promise<MysqlConnection>;
+}
+export interface MysqlOptions {
+    /** Optional application-to-wire conversion applied before mysql2 receives a value. */
+    readonly mapParameter?: (value: unknown, index: number) => MysqlParameter;
+}
+export type MysqlExecutionResult = {
+    readonly kind: 'rows';
+    readonly rows: readonly Readonly<Record<string, unknown>>[];
+} | {
+    readonly kind: 'command';
+    readonly affectedRows: number;
+    readonly insertId: number | string | bigint;
+    readonly warningStatus?: number;
+};
+export interface MysqlDriver<Name extends string = 'mysql'> extends TransactionalDriver<Name> {
+    readonly dialect: SqlDialect<Name>;
+    executeResult(query: CompiledQuery, options?: ExecuteOptions): Promise<MysqlExecutionResult>;
+}
+export declare function mysqlFamilyDriver<Name extends string>(dialect: SqlDialect<Name>, client: MysqlQueryable, options?: MysqlOptions): MysqlDriver<Name>;
+//# sourceMappingURL=driver.d.ts.map

package/dist/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../src/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAuB,KAAK,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAC/F,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAEhE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,GAAG,iBAAiB,CAAC;AAEhG,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,UAAU,GACV,cAAc,EAAE,GAChB;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAE,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC,CAAC,CAAC;IACjG,gGAAgG;IAChG,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC,CAAC,CAAC;CACjG;AAED,MAAM,WAAW,eAAgB,SAAQ,cAAc;IACrD,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,SAAU,SAAQ,cAAc;IAC/C,aAAa,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,YAAY;IAC3B,sFAAsF;IACtF,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC;CAC3E;AAED,MAAM,MAAM,oBAAoB,GAC5B;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;CAC7D,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEN,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,MAAM,GAAG,OAAO,CAAE,SAAQ,mBAAmB,CAAC,IAAI,CAAC;IAC3F,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACnC,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC9F;AAqJD,wBAAgB,iBAAiB,CAAC,IAAI,SAAS,MAAM,EACnD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,EACzB,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,YAAY,GACrB,WAAW,CAAC,IAAI,CAAC,CAEnB"}

package/dist/driver.js

@@ -0,0 +1,125 @@
+import {} from '@zmdb/orm';
+import {} from '@zmdb/sql';
+function isPool(client) {
+    return typeof Reflect.get(client, 'getConnection') === 'function';
+}
+function isConnection(client) {
+    return (typeof Reflect.get(client, 'beginTransaction') === 'function' &&
+        typeof Reflect.get(client, 'commit') === 'function' &&
+        typeof Reflect.get(client, 'rollback') === 'function');
+}
+function resultHeader(value) {
+    if (value === null || typeof value !== 'object') {
+        throw new TypeError('mysql2 returned neither rows nor a result header');
+    }
+    const affectedRows = Reflect.get(value, 'affectedRows');
+    const insertId = Reflect.get(value, 'insertId');
+    const warningStatus = Reflect.get(value, 'warningStatus');
+    if (typeof affectedRows !== 'number' || !Number.isSafeInteger(affectedRows) || affectedRows < 0) {
+        throw new TypeError('mysql2 result header affectedRows must be a non-negative safe integer');
+    }
+    if ((typeof insertId !== 'number' || !Number.isSafeInteger(insertId)) &&
+        typeof insertId !== 'string' &&
+        typeof insertId !== 'bigint') {
+        throw new TypeError('mysql2 result header insertId must be a safe integer, string, or bigint');
+    }
+    if (warningStatus !== undefined &&
+        (typeof warningStatus !== 'number' || !Number.isSafeInteger(warningStatus) || warningStatus < 0)) {
+        throw new TypeError('mysql2 result header warningStatus must be a non-negative safe integer');
+    }
+    return {
+        affectedRows,
+        insertId,
+        ...(warningStatus === undefined ? {} : { warningStatus }),
+    };
+}
+function isPlainRecord(value) {
+    const prototype = Object.getPrototypeOf(value);
+    return prototype === Object.prototype || prototype === null;
+}
+function mysqlParameter(value, label) {
+    if (value === null ||
+        typeof value === 'string' ||
+        typeof value === 'number' ||
+        typeof value === 'bigint' ||
+        typeof value === 'boolean' ||
+        value instanceof Date ||
+        value instanceof Uint8Array) {
+        return value;
+    }
+    if (Array.isArray(value)) {
+        return value.map((entry, index) => mysqlParameter(entry, `${label}[${String(index)}]`));
+    }
+    if (typeof value === 'object' && isPlainRecord(value)) {
+        return Object.fromEntries(Object.entries(value).map(([key, entry]) => [key, mysqlParameter(entry, `${label}.${key}`)]));
+    }
+    throw new TypeError(`${label} is not a mysql2 execute parameter`);
+}
+function mapParameters(query, options) {
+    const map = options?.mapParameter;
+    return query.parameters.map((value, index) => map === undefined ? mysqlParameter(value, `query parameter ${String(index + 1)}`) : map(value, index));
+}
+async function runTransaction(dialect, connection, options, run) {
+    await connection.beginTransaction();
+    const transactionDriver = createMysqlDriver(dialect, connection, options, true);
+    try {
+        const result = await run(transactionDriver);
+        await connection.commit();
+        return result;
+    }
+    catch (error) {
+        await connection.rollback();
+        throw error;
+    }
+}
+function createMysqlDriver(dialect, client, options, pinned) {
+    const driver = {
+        dialect,
+        async executeResult(query, executeOptions) {
+            const signal = executeOptions?.signal;
+            signal?.throwIfAborted();
+            const parameters = mapParameters(query, options);
+            const textQuery = /^\s*(?:SHOW|DESCRIBE)\b/iu.test(query.text) ? client.query : undefined;
+            const [result] = textQuery === undefined
+                ? await client.execute(query.text, parameters)
+                : await textQuery.call(client, query.text, parameters);
+            signal?.throwIfAborted();
+            if (Array.isArray(result)) {
+                if (result.some(row => row === null || typeof row !== 'object' || Array.isArray(row))) {
+                    throw new TypeError('mysql2 row results must contain objects');
+                }
+                return { kind: 'rows', rows: result };
+            }
+            return { kind: 'command', ...resultHeader(result) };
+        },
+        async execute(query, executeOptions) {
+            const result = await driver.executeResult(query, executeOptions);
+            return result.kind === 'rows' ? result.rows : [];
+        },
+        async transaction(run) {
+            if (pinned) {
+                if (!isConnection(client))
+                    throw new TypeError('a pinned mysql transaction lost its connection');
+                return runTransaction(dialect, client, options, run);
+            }
+            if (isPool(client)) {
+                const connection = await client.getConnection();
+                try {
+                    return await runTransaction(dialect, connection, options, run);
+                }
+                finally {
+                    connection.release?.();
+                }
+            }
+            if (!isConnection(client)) {
+                throw new TypeError('mysqlDriver.transaction requires a mysql2 pool or connection');
+            }
+            return runTransaction(dialect, client, options, run);
+        },
+    };
+    return driver;
+}
+export function mysqlFamilyDriver(dialect, client, options) {
+    return createMysqlDriver(dialect, client, options, false);
+}
+//# sourceMappingURL=driver.js.map

package/dist/driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.js","sourceRoot":"","sources":["../src/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsE,MAAM,WAAW,CAAC;AAC/F,OAAO,EAAuC,MAAM,WAAW,CAAC;AAgEhE,SAAS,MAAM,CAAC,MAAsB;IACpC,OAAO,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,KAAK,UAAU,CAAC;AACpE,CAAC;AAED,SAAS,YAAY,CAAC,MAAsB;IAC1C,OAAO,CACL,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAK,UAAU;QAC7D,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,UAAU;QACnD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,UAAU,CACtD,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAChD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IAC1D,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;QAChG,MAAM,IAAI,SAAS,CAAC,uEAAuE,CAAC,CAAC;IAC/F,CAAC;IACD,IACE,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,OAAO,QAAQ,KAAK,QAAQ,EAC5B,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,yEAAyE,CAAC,CAAC;IACjG,CAAC;IACD,IACE,aAAa,KAAK,SAAS;QAC3B,CAAC,OAAO,aAAa,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,CAAC,CAAC,EAChG,CAAC;QACD,MAAM,IAAI,SAAS,CAAC,wEAAwE,CAAC,CAAC;IAChG,CAAC;IACD,OAAO;QACL,YAAY;QACZ,QAAQ;QACR,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC;KAC1D,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/C,OAAO,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC;AAC9D,CAAC;AAED,SAAS,cAAc,CAAC,KAAc,EAAE,KAAa;IACnD,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS;QAC1B,KAAK,YAAY,IAAI;QACrB,KAAK,YAAY,UAAU,EAC3B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1F,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAC7F,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,oCAAoC,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,aAAa,CAAC,KAAoB,EAAE,OAAiC;IAC5E,MAAM,GAAG,GAAG,OAAO,EAAE,YAAY,CAAC;IAClC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAC3C,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,mBAAmB,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CACtG,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,OAAyB,EACzB,UAA2B,EAC3B,OAAiC,EACjC,GAAsD;IAEtD,MAAM,UAAU,CAAC,gBAAgB,EAAE,CAAC;IACpC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAChF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC5C,MAAM,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,OAAyB,EACzB,MAAsB,EACtB,OAAiC,EACjC,MAAe;IAEf,MAAM,MAAM,GAAsB;QAChC,OAAO;QACP,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc;YACvC,MAAM,MAAM,GAAG,cAAc,EAAE,MAAM,CAAC;YACtC,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,MAAM,CAAC,MAAM,CAAC,GACZ,SAAS,KAAK,SAAS;gBACrB,CAAC,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC;gBAC9C,CAAC,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAC3D,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACtF,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;gBACjE,CAAC;gBACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACxC,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACtD,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,cAAc;YACjC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YACjE,OAAO,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,CAAC;QACD,KAAK,CAAC,WAAW,CAAS,GAAiE;YACzF,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;oBAAE,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;gBACjG,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;YACvD,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;gBAChD,IAAI,CAAC;oBACH,OAAO,MAAM,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;gBACjE,CAAC;wBAAS,CAAC;oBACT,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;gBACzB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,SAAS,CAAC,8DAA8D,CAAC,CAAC;YACtF,CAAC;YACD,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QACvD,CAAC;KACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,OAAyB,EACzB,MAAsB,EACtB,OAAsB;IAEtB,OAAO,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAC5D,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { type DatabaseVertical } from '@zmdb/orm';
+import { type MysqlDriver, type MysqlOptions, type MysqlQueryable } from './driver.js';
+export { mysql } from './dialect.js';
+export { mysqlFamilyDriver, type MysqlConnection, type MysqlDriver, type MysqlExecutionResult, type MysqlOptions, type MysqlParameter, type MysqlPool, type MysqlQueryable, type MysqlQueryResult, type MysqlResultHeader, } from './driver.js';
+export { mysqlFamilyIntrospector, mysqlIntrospector, mysqlSnapshot, type MysqlCatalogOverrides } from './introspect.js';
+export { createMysqlMigrations, mysqlFamilyMigrations, type MysqlMigrationOverrides, type MysqlTableDdlExtension, type MysqlTableDdlHelpers, } from './migrations.js';
+export declare function mysqlDriver(client: MysqlQueryable, options?: MysqlOptions): MysqlDriver<'mysql'>;
+export declare const mysqlVertical: DatabaseVertical<'mysql', MysqlQueryable, MysqlOptions>;
+//# 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":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAGlD,OAAO,EAAqB,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAE1G,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EACL,iBAAiB,EACjB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,GACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxH,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,iBAAiB,CAAC;AAEzB,wBAAgB,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,CAEhG;AAED,eAAO,MAAM,aAAa,EAAE,gBAAgB,CAAC,OAAO,EAAE,cAAc,EAAE,YAAY,CAGhF,CAAC"}

package/dist/index.js

@@ -0,0 +1,15 @@
+import {} from '@zmdb/orm';
+import { mysql } from './dialect.js';
+import { mysqlFamilyDriver } from './driver.js';
+export { mysql } from './dialect.js';
+export { mysqlFamilyDriver, } from './driver.js';
+export { mysqlFamilyIntrospector, mysqlIntrospector, mysqlSnapshot } from './introspect.js';
+export { createMysqlMigrations, mysqlFamilyMigrations, } from './migrations.js';
+export function mysqlDriver(client, options) {
+    return mysqlFamilyDriver(mysql, client, options);
+}
+export const mysqlVertical = Object.freeze({
+    dialect: mysql,
+    driver: mysqlDriver,
+});
+//# 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,OAAO,EAAyB,MAAM,WAAW,CAAC;AAElD,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,iBAAiB,EAA4D,MAAM,aAAa,CAAC;AAE1G,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EACL,iBAAiB,GAUlB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,aAAa,EAA8B,MAAM,iBAAiB,CAAC;AACxH,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GAItB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,UAAU,WAAW,CAAC,MAAsB,EAAE,OAAsB;IACxE,OAAO,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAA4D,MAAM,CAAC,MAAM,CAAC;IAClG,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,WAAW;CACpB,CAAC,CAAC"}

package/dist/introspect.d.ts

@@ -0,0 +1,11 @@
+import type { SchemaSnapshot } from '@zmdb/migrations';
+import { type CatalogSchemaSnapshot } from '@zmdb/migrations/introspect/runtime';
+import { type IntrospectionDriver, type Introspector, type IntrospectOptions } from '@zmdb/sql';
+export interface MysqlCatalogOverrides {
+    readonly snapshot?: (driver: IntrospectionDriver, options: IntrospectOptions, parent: (driver: IntrospectionDriver, options?: IntrospectOptions) => Promise<CatalogSchemaSnapshot>) => Promise<CatalogSchemaSnapshot>;
+    readonly normalizeForDrift?: (snapshot: SchemaSnapshot, role: 'live' | 'declared', parent: (snapshot: SchemaSnapshot, role: 'live' | 'declared') => SchemaSnapshot) => SchemaSnapshot;
+}
+export declare function mysqlSnapshot(driver: IntrospectionDriver, options?: IntrospectOptions): Promise<CatalogSchemaSnapshot>;
+export declare function mysqlFamilyIntrospector<Name extends string>(name: Name, overrides?: MysqlCatalogOverrides): Introspector<Name>;
+export declare const mysqlIntrospector: Introspector<'mysql'>;
+//# sourceMappingURL=introspect.d.ts.map

package/dist/introspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.d.ts","sourceRoot":"","sources":["../src/introspect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAiBL,KAAK,qBAAqB,EAG3B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAyChG,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAClB,MAAM,EAAE,mBAAmB,EAC3B,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,qBAAqB,CAAC,KACjG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAC3B,QAAQ,EAAE,cAAc,EACxB,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,MAAM,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,KAAK,cAAc,KAC5E,cAAc,CAAC;CACrB;AA2ND,wBAAsB,aAAa,CACjC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,qBAAqB,CAAC,CA+GhC;AAMD,wBAAgB,uBAAuB,CAAC,IAAI,SAAS,MAAM,EACzD,IAAI,EAAE,IAAI,EACV,SAAS,GAAE,qBAA0B,GACpC,YAAY,CAAC,IAAI,CAAC,CAWpB;AAED,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,OAAO,CAAoC,CAAC"}