bunsql-native-migrate 0.2.0 → 0.3.0

package/src/drivers/shared.ts

@@ -10,6 +10,7 @@ export interface SqlLock {
 export interface SqlDialect {
   install(db: SQL): Promise<void>;
   record(db: SQL, migration: string, checksum: string): Promise<void>;
+  trackingTableExists?(db: SQL): Promise<boolean>;
   createLock?(db: SQL): SqlLock;
 }
 
@@ -54,14 +55,18 @@ export function createReservedLock(
   };
 }
 
-export function createSqlDriver(databaseUrl: string, dialect: SqlDialect): MigrationDriver {
+export function createSqlDriver(
+  databaseUrl: string,
+  dialect: SqlDialect,
+  table: string,
+): MigrationDriver {
   const db = new SQL(databaseUrl);
   const lock = dialect.createLock?.(db);
 
   return {
     install: () => dialect.install(db),
     async listExecuted() {
-      const rows = await db`SELECT migration, checksum FROM migrations ORDER BY id ASC`;
+      const rows = await db`SELECT migration, checksum FROM ${db.unsafe(table)} ORDER BY id ASC`;
       return rows.map(
         (r: { migration: string; checksum: string | null }): ExecutedMigration => ({
           name: r.migration,
@@ -71,12 +76,15 @@ export function createSqlDriver(databaseUrl: string, dialect: SqlDialect): Migra
     },
     record: (migration, checksum) => dialect.record(db, migration, checksum),
     async setChecksum(migration, checksum) {
-      await db`UPDATE migrations SET checksum = ${checksum} WHERE migration = ${migration}`;
+      await db`UPDATE ${db.unsafe(table)} SET checksum = ${checksum} WHERE migration = ${migration}`;
     },
     async remove(migration) {
-      await db`DELETE FROM migrations WHERE migration = ${migration}`;
+      await db`DELETE FROM ${db.unsafe(table)} WHERE migration = ${migration}`;
     },
     transaction: (run) => db.begin(run),
+    ...(dialect.trackingTableExists
+      ? { trackingTableExists: () => dialect.trackingTableExists!(db) }
+      : {}),
     ...(lock
       ? {
           tryLock: (timeoutSeconds: number) => lock.tryLock(timeoutSeconds),

package/src/drivers/sqlite.ts

@@ -1,36 +1,63 @@
-import type { MigrationDriver } from "../core/driver.js";
+import type { DriverTableOptions, MigrationDriver } from "../core/driver.js";
+import { doubleQuoted, validateIdentifier } from "../core/identifiers.js";
 import { createSqlDriver } from "./shared.js";
 
-export function create(databaseUrl: string): MigrationDriver {
-  return createSqlDriver(databaseUrl, {
-    async install(db) {
-      await db`CREATE TABLE IF NOT EXISTS migrations (
-        id INTEGER PRIMARY KEY AUTOINCREMENT,
-        migration TEXT NOT NULL,
-        checksum TEXT
-      )`;
-      const columns = (await db`PRAGMA table_info(migrations)`) as Array<{
-        name: string;
-      }>;
-      const hasChecksum = columns.some((column) => column.name === "checksum");
-      if (!hasChecksum) {
-        await db`ALTER TABLE migrations ADD COLUMN checksum TEXT`;
-      }
-      await db`CREATE UNIQUE INDEX IF NOT EXISTS migrations_migration_unique ON migrations (migration)`;
-    },
-    async record(db, migration, checksum) {
-      await db`INSERT OR IGNORE INTO migrations (migration, checksum)
-        VALUES (${migration}, ${checksum})`;
-    },
-    createLock: (db) => ({
-      async tryLock(timeoutSeconds: number) {
-        await db.unsafe(`PRAGMA busy_timeout = ${timeoutSeconds * 1000}`);
-        return true;
+const TABLE_NAME_MAX_LENGTH = 128;
+const UNIQUE_INDEX_SUFFIX = "_migration_unique";
+
+function resolveTableRef(options: DriverTableOptions): {
+  table: string;
+  index: string;
+  name: string;
+} {
+  const tableName = options.tableName ?? "migrations";
+  validateIdentifier("table", tableName, TABLE_NAME_MAX_LENGTH);
+  return {
+    table: doubleQuoted(tableName),
+    index: doubleQuoted(`${tableName}${UNIQUE_INDEX_SUFFIX}`),
+    name: tableName,
+  };
+}
+
+export function create(databaseUrl: string, options: DriverTableOptions = {}): MigrationDriver {
+  const { table, index, name } = resolveTableRef(options);
+  return createSqlDriver(
+    databaseUrl,
+    {
+      async install(db) {
+        await db`CREATE TABLE IF NOT EXISTS ${db.unsafe(table)} (
+          id INTEGER PRIMARY KEY AUTOINCREMENT,
+          migration TEXT NOT NULL,
+          checksum TEXT
+        )`;
+        const columns = (await db.unsafe(`PRAGMA table_info(${table})`)) as Array<{
+          name: string;
+        }>;
+        const hasChecksum = columns.some((column) => column.name === "checksum");
+        if (!hasChecksum) {
+          await db`ALTER TABLE ${db.unsafe(table)} ADD COLUMN checksum TEXT`;
+        }
+        await db`CREATE UNIQUE INDEX IF NOT EXISTS ${db.unsafe(index)} ON ${db.unsafe(table)} (migration)`;
+      },
+      async trackingTableExists(db) {
+        const rows = await db`SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ${name}`;
+        return rows.length > 0;
       },
-      async releaseLock() {
-        await db.unsafe("PRAGMA busy_timeout = 0");
+      async record(db, migration, checksum) {
+        await db`INSERT OR IGNORE INTO ${db.unsafe(table)} (migration, checksum)
+          VALUES (${migration}, ${checksum})`;
       },
-      dispose() {},
-    }),
-  });
+      createLock: (db) => ({
+        async tryLock(timeoutSeconds: number) {
+          await db.unsafe(`PRAGMA busy_timeout = ${timeoutSeconds * 1000}`);
+          return true;
+        },
+        async releaseLock() {
+          await db.unsafe("PRAGMA busy_timeout = 0");
+        },
+        dispose() {},
+      }),
+    },
+    table,
+  );
 }

package/src/index.ts

@@ -1,12 +1,21 @@
-import { createDriver, type ExecutedMigration, type MigrationDriver } from "./core/driver.js";
+import {
+  createDriver,
+  type DriverTableOptions,
+  type ExecutedMigration,
+  type MigrationDriver,
+} from "./core/driver.js";
+import { InvalidIdentifierError } from "./core/identifiers.js";
 import { migrateUp } from "./api/up.js";
 import { migrateDown } from "./api/down.js";
 import { migrateStatus } from "./api/status.js";
 import { installMigrations } from "./api/install.js";
 import { createMigration } from "./api/create.js";
+import { markMigrationsApplied } from "./api/mark.js";
 import {
   type MigrateDownOptions,
   type MigrateDownResult,
+  type MarkOptions,
+  type MarkResult,
   type MigrateOptions,
   type MigrateStatusResult,
   type MigrateUpOptions,
@@ -24,12 +33,15 @@ export {
   migrateStatus,
   installMigrations,
   createMigration,
+  markMigrationsApplied,
   ChecksumDriftError,
   GitStageError,
+  InvalidIdentifierError,
   MigrationLockError,
   MigrationNotFoundError,
 };
 export type {
+  DriverTableOptions,
   ExecutedMigration,
   MigrationDriver,
   MigrateOptions,
@@ -37,5 +49,7 @@ export type {
   MigrateUpResult,
   MigrateDownOptions,
   MigrateDownResult,
+  MarkOptions,
+  MarkResult,
   MigrateStatusResult,
 };