@remix-run/data-table-mysql 0.1.0 → 0.3.0

package/README.md

@@ -5,12 +5,16 @@ Use this package when you want `data-table` APIs backed by `mysql2`.
 
 ## Features
 
-- **Native `mysql2` Integration**: Works with `mysql2/promise` connection pools
+- **Native `mysql2` Integration**: Works with `mysql2/promise` `Pool` and `PoolConnection` instances
 - **Full `data-table` API Support**: Queries, relations, writes, and transactions
+- **Adapter-Owned Compiler**: SQL compilation lives in this adapter, with optional shared pure helpers from `data-table`
+- **Migration DDL Support**: Compiles and executes `DataMigrationOperation` operations for `remix/data-table/migrations`
 - **MySQL Capabilities Enabled By Default**:
   - `returning: false`
   - `savepoints: true`
   - `upsert: true`
+  - `transactionalDdl: false`
+  - `migrationLock: true`
 
 ## Installation
 
@@ -30,6 +34,7 @@ let db = createDatabase(createMysqlDatabaseAdapter(pool))
 ```
 
 Use `db.query(...)`, relation loading, and transactions from `remix/data-table`.
+Import any driver-specific types you need directly from `mysql2/promise`.
 
 ## Adapter Capabilities
 
@@ -38,24 +43,11 @@ Use `db.query(...)`, relation loading, and transactions from `remix/data-table`.
 - `returning: false`
 - `savepoints: true`
 - `upsert: true`
+- `transactionalDdl: false`
+- `migrationLock: true`
 
 ## Advanced Usage
 
-### Capability Overrides For Testing
-
-Capability overrides are mainly for tests where you want to force or disable specific behavior
-checks. In production, keep defaults so adapter behavior matches MySQL behavior.
-
-```ts
-import { createMysqlDatabaseAdapter } from 'remix/data-table-mysql'
-
-let adapter = createMysqlDatabaseAdapter(pool, {
-  capabilities: {
-    upsert: false,
-  },
-})
-```
-
 ### `returning` On MySQL
 
 MySQL does not natively support SQL `RETURNING`. In this adapter, using `returning` on write
@@ -81,7 +73,7 @@ try {
 ## Related Packages
 
 - [`data-table`](https://github.com/remix-run/remix/tree/main/packages/data-table) - Core query/relations API
-- [`data-schema`](https://github.com/remix-run/remix/tree/main/packages/data-schema) - Schema definitions and validation
+- [`data-schema`](https://github.com/remix-run/remix/tree/main/packages/data-schema) - Schema parsing and validation
 - [`data-table-postgres`](https://github.com/remix-run/remix/tree/main/packages/data-table-postgres) - PostgreSQL adapter
 - [`data-table-sqlite`](https://github.com/remix-run/remix/tree/main/packages/data-table-sqlite) - SQLite adapter
 

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export type { MysqlDatabaseAdapterOptions, MysqlDatabaseConnection, MysqlDatabasePool, MysqlQueryResponse, MysqlQueryResultHeader, MysqlQueryRows, } from './lib/adapter.ts';
 export { createMysqlDatabaseAdapter, MysqlDatabaseAdapter } from './lib/adapter.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,2BAA2B,EAC3B,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,sBAAsB,EACtB,cAAc,GACf,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/lib/adapter.d.ts

@@ -1,69 +1,126 @@
-import type { AdapterCapabilityOverrides, AdapterExecuteRequest, AdapterResult, DatabaseAdapter, TransactionOptions, TransactionToken } from '@remix-run/data-table';
-/**
- * Row-array response shape for mysql query calls.
- */
-export type MysqlQueryRows = Record<string, unknown>[];
-/**
- * Metadata shape for mysql write results.
- */
-export type MysqlQueryResultHeader = {
-    affectedRows: number;
-    insertId: unknown;
-};
-/**
- * Supported mysql `query()` response tuple.
- */
-export type MysqlQueryResponse = [result: unknown, fields?: unknown];
-/**
- * Single mysql connection contract used by this adapter.
- */
-export type MysqlDatabaseConnection = {
-    query(text: string, values?: unknown[]): Promise<MysqlQueryResponse>;
-    beginTransaction(): Promise<void>;
-    commit(): Promise<void>;
-    rollback(): Promise<void>;
-    release?: () => void;
-};
-/**
- * Mysql pool contract used by this adapter.
- */
-export type MysqlDatabasePool = {
-    query(text: string, values?: unknown[]): Promise<MysqlQueryResponse>;
-    getConnection(): Promise<MysqlDatabaseConnection>;
-};
-/**
- * Mysql adapter configuration.
- */
-export type MysqlDatabaseAdapterOptions = {
-    capabilities?: AdapterCapabilityOverrides;
-};
-type MysqlQueryable = MysqlDatabasePool | MysqlDatabaseConnection;
+import type { DataManipulationRequest, DataMigrationRequest, DataMigrationResult, DataMigrationOperation, DataManipulationResult, DataManipulationOperation, DatabaseAdapter, SqlStatement, TableRef, TransactionOptions, TransactionToken } from '@remix-run/data-table';
+import type { Connection as MysqlConnection, Pool as MysqlPool, PoolConnection as MysqlPoolConnection } from 'mysql2/promise';
+type MysqlTransactionConnection = MysqlConnection | MysqlPoolConnection;
+type MysqlQueryable = MysqlPool | MysqlTransactionConnection;
 /**
  * `DatabaseAdapter` implementation for mysql-compatible clients.
  */
 export declare class MysqlDatabaseAdapter implements DatabaseAdapter {
     #private;
+    /**
+     * The SQL dialect identifier reported by this adapter.
+     */
     dialect: string;
+    /**
+     * Feature flags describing the mysql behaviors supported by this adapter.
+     */
     capabilities: {
         returning: boolean;
         savepoints: boolean;
         upsert: boolean;
+        transactionalDdl: boolean;
+        migrationLock: boolean;
     };
-    constructor(client: MysqlQueryable, options?: MysqlDatabaseAdapterOptions);
-    execute(request: AdapterExecuteRequest): Promise<AdapterResult>;
+    constructor(client: MysqlQueryable);
+    /**
+     * Compiles a data or migration operation to mysql SQL statements.
+     * @param operation Operation to compile.
+     * @returns Compiled SQL statements.
+     */
+    compileSql(operation: DataManipulationOperation | DataMigrationOperation): SqlStatement[];
+    /**
+     * Executes a mysql data-manipulation request.
+     * @param request Request to execute.
+     * @returns Execution result.
+     */
+    execute(request: DataManipulationRequest): Promise<DataManipulationResult>;
+    /**
+     * Executes mysql migration operations.
+     * @param request Migration request to execute.
+     * @returns Migration result.
+     */
+    migrate(request: DataMigrationRequest): Promise<DataMigrationResult>;
+    /**
+     * Checks whether a table exists in mysql.
+     * @param table Table reference to inspect.
+     * @param transaction Optional transaction token.
+     * @returns `true` when the table exists.
+     */
+    hasTable(table: TableRef, transaction?: TransactionToken): Promise<boolean>;
+    /**
+     * Checks whether a column exists in mysql.
+     * @param table Table reference to inspect.
+     * @param column Column name to look up.
+     * @param transaction Optional transaction token.
+     * @returns `true` when the column exists.
+     */
+    hasColumn(table: TableRef, column: string, transaction?: TransactionToken): Promise<boolean>;
+    /**
+     * Starts a mysql transaction.
+     * @param options Transaction options.
+     * @returns Transaction token.
+     */
     beginTransaction(options?: TransactionOptions): Promise<TransactionToken>;
+    /**
+     * Commits an open mysql transaction.
+     * @param token Transaction token to commit.
+     * @returns A promise that resolves when the transaction is committed.
+     */
     commitTransaction(token: TransactionToken): Promise<void>;
+    /**
+     * Rolls back an open mysql transaction.
+     * @param token Transaction token to roll back.
+     * @returns A promise that resolves when the transaction is rolled back.
+     */
     rollbackTransaction(token: TransactionToken): Promise<void>;
+    /**
+     * Creates a savepoint in an open mysql transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the savepoint is created.
+     */
     createSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Rolls back to a savepoint in an open mysql transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the rollback completes.
+     */
     rollbackToSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Releases a savepoint in an open mysql transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the savepoint is released.
+     */
     releaseSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Acquires the mysql migration lock.
+     * @returns A promise that resolves when the lock is acquired.
+     */
+    acquireMigrationLock(): Promise<void>;
+    /**
+     * Releases the mysql migration lock.
+     * @returns A promise that resolves when the lock is released.
+     */
+    releaseMigrationLock(): Promise<void>;
 }
 /**
  * Creates a mysql `DatabaseAdapter`.
  * @param client Mysql pool or connection.
  * @param options Optional adapter capability overrides.
  * @returns A configured mysql adapter.
+ * @example
+ * ```ts
+ * import { createPool } from 'mysql2/promise'
+ * import { createDatabase } from 'remix/data-table'
+ * import { createMysqlDatabaseAdapter } from 'remix/data-table-mysql'
+ *
+ * let pool = createPool({ uri: process.env.DATABASE_URL })
+ * let adapter = createMysqlDatabaseAdapter(pool)
+ * let db = createDatabase(adapter)
+ * ```
  */
-export declare function createMysqlDatabaseAdapter(client: MysqlQueryable, options?: MysqlDatabaseAdapterOptions): MysqlDatabaseAdapter;
+export declare function createMysqlDatabaseAdapter(client: MysqlQueryable): MysqlDatabaseAdapter;
 export {};
 //# sourceMappingURL=adapter.d.ts.map

package/dist/lib/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAK9B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAA;AAEpE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpE,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACvB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACpE,aAAa,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAA;CAClD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AAOD,KAAK,cAAc,GAAG,iBAAiB,GAAG,uBAAuB,CAAA;AAEjE;;GAEG;AACH,qBAAa,oBAAqB,YAAW,eAAe;;IAC1D,OAAO,SAAU;IACjB,YAAY;;;;MAAA;IAMZ,YAAY,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,2BAA2B,EAOxE;IAEK,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CA6BpE;IAEK,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAgC9E;IAEK,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9D;IAEK,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBhE;IAEK,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEK,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAEK,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;CAmBF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,2BAA2B,GACpC,oBAAoB,CAEtB"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EACzB,eAAe,EAEf,YAAY,EACZ,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAO9B,OAAO,KAAK,EACV,UAAU,IAAI,eAAe,EAC7B,IAAI,IAAI,SAAS,EACjB,cAAc,IAAI,mBAAmB,EAGtC,MAAM,gBAAgB,CAAA;AAcvB,KAAK,0BAA0B,GAAG,eAAe,GAAG,mBAAmB,CAAA;AACvE,KAAK,cAAc,GAAG,SAAS,GAAG,0BAA0B,CAAA;AAE5D;;GAEG;AACH,qBAAa,oBAAqB,YAAW,eAAe;;IAC1D;;OAEG;IACH,OAAO,SAAU;IAEjB;;OAEG;IACH,YAAY;;;;;;MAAA;IAMZ,YAAY,MAAM,EAAE,cAAc,EASjC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAS,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,YAAY,EAAE,CAOxF;IAED;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CA8B/E;IAED;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAWzE;IAED;;;;;OAKG;IACG,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAchF;IAED;;;;;;OAMG;IACG,SAAS,CACb,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,OAAO,CAAC,CAclB;IAED;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAgC9E;IAED;;;;OAIG;IACG,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9D;IAED;;;;OAIG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBhE;IAED;;;;;OAKG;IACG,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAED;;;;;OAKG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;CAmBF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,cAAc,GAAG,oBAAoB,CAEvF"}