@remix-run/data-table-sqlite 0.1.0 → 0.2.0

package/README.md

@@ -7,10 +7,14 @@ Use this package when you want `data-table` APIs backed by `better-sqlite3`.
 
 - **Native `better-sqlite3` Integration**: Works well for local and embedded deployments
 - **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`
 - **SQLite Capabilities Enabled By Default**:
   - `returning: true`
   - `savepoints: true`
   - `upsert: true`
+  - `transactionalDdl: true`
+  - `migrationLock: false`
 
 ## Installation
 
@@ -30,6 +34,7 @@ let db = createDatabase(createSqliteDatabaseAdapter(sqlite))
 ```
 
 This is a good fit for local development, embedded deployments, and single-node services.
+Import any driver-specific types you need directly from `better-sqlite3`.
 
 ## Adapter Capabilities
 
@@ -38,6 +43,8 @@ This is a good fit for local development, embedded deployments, and single-node
 - `returning: true`
 - `savepoints: true`
 - `upsert: true`
+- `transactionalDdl: true`
+- `migrationLock: false`
 
 ## Advanced Usage
 
@@ -67,7 +74,7 @@ let adapter = createSqliteDatabaseAdapter(sqlite, {
 ## 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-mysql`](https://github.com/remix-run/remix/tree/main/packages/data-table-mysql) - MySQL adapter
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { SqliteDatabaseAdapterOptions, SqliteDatabaseConnection } from './lib/adapter.ts';
+export type { SqliteDatabaseAdapterOptions } from './lib/adapter.ts';
 export { createSqliteDatabaseAdapter, SqliteDatabaseAdapter } 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,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAC9F,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,4BAA4B,EAAE,MAAM,kBAAkB,CAAA;AACpE,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/lib/adapter.d.ts

@@ -1,9 +1,5 @@
-import type { AdapterCapabilityOverrides, AdapterExecuteRequest, AdapterResult, DatabaseAdapter, TransactionOptions, TransactionToken } from '@remix-run/data-table';
+import type { AdapterCapabilityOverrides, DataManipulationRequest, DataMigrationRequest, DataMigrationResult, DataMigrationOperation, DataManipulationResult, DataManipulationOperation, DatabaseAdapter, SqlStatement, TableRef, TransactionOptions, TransactionToken } from '@remix-run/data-table';
 import type { Database as BetterSqliteDatabase } from 'better-sqlite3';
-/**
- * Better SQLite3 database handle accepted by the sqlite adapter.
- */
-export type SqliteDatabaseConnection = BetterSqliteDatabase;
 /**
  * Sqlite adapter configuration.
  */
@@ -15,19 +11,92 @@ export type SqliteDatabaseAdapterOptions = {
  */
 export declare class SqliteDatabaseAdapter implements DatabaseAdapter {
     #private;
+    /**
+     * The SQL dialect identifier reported by this adapter.
+     */
     dialect: string;
+    /**
+     * Feature flags describing the sqlite behaviors supported by this adapter.
+     */
     capabilities: {
         returning: boolean;
         savepoints: boolean;
         upsert: boolean;
+        transactionalDdl: boolean;
+        migrationLock: boolean;
     };
-    constructor(database: SqliteDatabaseConnection, options?: SqliteDatabaseAdapterOptions);
-    execute(request: AdapterExecuteRequest): Promise<AdapterResult>;
+    constructor(database: BetterSqliteDatabase, options?: SqliteDatabaseAdapterOptions);
+    /**
+     * Compiles a data or migration operation to sqlite SQL statements.
+     * @param operation Operation to compile.
+     * @returns Compiled SQL statements.
+     */
+    compileSql(operation: DataManipulationOperation | DataMigrationOperation): SqlStatement[];
+    /**
+     * Executes a sqlite data-manipulation request.
+     * @param request Request to execute.
+     * @returns Execution result.
+     */
+    execute(request: DataManipulationRequest): Promise<DataManipulationResult>;
+    /**
+     * Executes sqlite migration operations.
+     * @param request Migration request to execute.
+     * @returns Migration result.
+     */
+    migrate(request: DataMigrationRequest): Promise<DataMigrationResult>;
+    /**
+     * Checks whether a table exists in sqlite.
+     * @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 sqlite.
+     * @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 sqlite transaction.
+     * @param options Transaction options.
+     * @returns Transaction token.
+     */
     beginTransaction(options?: TransactionOptions): Promise<TransactionToken>;
+    /**
+     * Commits an open sqlite 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 sqlite 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 sqlite 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 sqlite 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 sqlite 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>;
 }
 /**
@@ -35,6 +104,16 @@ export declare class SqliteDatabaseAdapter implements DatabaseAdapter {
  * @param database Better SQLite3 database instance.
  * @param options Optional adapter capability overrides.
  * @returns A configured sqlite adapter.
+ * @example
+ * ```ts
+ * import BetterSqlite3 from 'better-sqlite3'
+ * import { createDatabase } from 'remix/data-table'
+ * import { createSqliteDatabaseAdapter } from 'remix/data-table-sqlite'
+ *
+ * let sqlite = new BetterSqlite3('./data/app.db')
+ * let adapter = createSqliteDatabaseAdapter(sqlite)
+ * let db = createDatabase(adapter)
+ * ```
  */
-export declare function createSqliteDatabaseAdapter(database: SqliteDatabaseConnection, options?: SqliteDatabaseAdapterOptions): SqliteDatabaseAdapter;
+export declare function createSqliteDatabaseAdapter(database: BetterSqliteDatabase, options?: SqliteDatabaseAdapterOptions): SqliteDatabaseAdapter;
 //# 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;AAE9B,OAAO,KAAK,EAAE,QAAQ,IAAI,oBAAoB,EAAa,MAAM,gBAAgB,CAAA;AAIjF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,eAAe;;IAC3D,OAAO,SAAW;IAClB,YAAY;;;;MAAA;IAMZ,YAAY,QAAQ,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,4BAA4B,EAOrF;IAEK,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAgCpE;IAEK,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAY9E;IAEK,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9D;IAEK,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIhE;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;CAOF;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,wBAAwB,EAClC,OAAO,CAAC,EAAE,4BAA4B,GACrC,qBAAqB,CAEvB"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,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,EAAE,QAAQ,IAAI,oBAAoB,EAAa,MAAM,gBAAgB,CAAA;AAIjF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,eAAe;;IAC3D;;OAEG;IACH,OAAO,SAAW;IAElB;;OAEG;IACH,YAAY;;;;;;MAAA;IAMZ,YAAY,QAAQ,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,4BAA4B,EASjF;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,CAgC/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,CAahF;IAED;;;;;;OAMG;IACG,SAAS,CACb,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,OAAO,CAAC,CAYlB;IAED;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAY9E;IAED;;;;OAIG;IACG,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9D;IAED;;;;OAIG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIhE;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;CAOF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,oBAAoB,EAC9B,OAAO,CAAC,EAAE,4BAA4B,GACrC,qBAAqB,CAEvB"}