@remix-run/data-table 0.2.1 → 0.3.0

package/src/lib/adapter.ts

@@ -147,7 +147,7 @@ export type DataManipulationOperation =
   | RawOperation
 
 /**
- * Qualified table reference used in migration operations.
+ * Qualified table reference.
  */
 export type TableRef = {
   name: string
@@ -242,313 +242,6 @@ export type ColumnDefinition = {
   charset?: string
 }
 
-/**
- * Primary key constraint definition.
- */
-export type PrimaryKeyConstraint = {
-  columns: string[]
-  name: string
-}
-
-/**
- * Unique constraint definition.
- */
-export type UniqueConstraint = {
-  columns: string[]
-  name: string
-}
-
-/**
- * Check constraint definition.
- */
-export type CheckConstraint = {
-  expression: string
-  name: string
-}
-
-/**
- * Foreign key constraint definition.
- */
-export type ForeignKeyConstraint = {
-  columns: string[]
-  references: {
-    table: TableRef
-    columns: string[]
-  }
-  name: string
-  onDelete?: ForeignKeyAction
-  onUpdate?: ForeignKeyAction
-}
-
-/**
- * Index method used when creating an index.
- */
-export type IndexMethod = 'btree' | 'hash' | 'gin' | 'gist' | 'fulltext' | (string & {})
-
-/**
- * Index definition used in schema operations.
- */
-export type IndexDefinition = {
-  table: TableRef
-  name: string
-  columns: string[]
-  unique?: boolean
-  where?: string
-  using?: IndexMethod
-}
-
-/**
- * Operation that creates a new table.
- */
-export type CreateTableOperation = {
-  kind: 'createTable'
-  table: TableRef
-  ifNotExists?: boolean
-  columns: Record<string, ColumnDefinition>
-  primaryKey?: PrimaryKeyConstraint
-  uniques?: UniqueConstraint[]
-  checks?: CheckConstraint[]
-  foreignKeys?: ForeignKeyConstraint[]
-  comment?: string
-}
-
-/**
- * Alter-table change that adds a column.
- */
-export type AddColumnChange = {
-  kind: 'addColumn'
-  column: string
-  definition: ColumnDefinition
-}
-
-/**
- * Alter-table change that replaces a column definition.
- */
-export type ChangeColumnChange = {
-  kind: 'changeColumn'
-  column: string
-  definition: ColumnDefinition
-}
-
-/**
- * Alter-table change that renames a column.
- */
-export type RenameColumnChange = {
-  kind: 'renameColumn'
-  from: string
-  to: string
-}
-
-/**
- * Alter-table change that drops a column.
- */
-export type DropColumnChange = {
-  kind: 'dropColumn'
-  column: string
-  ifExists?: boolean
-}
-
-/**
- * Alter-table change that adds a primary key.
- */
-export type AddPrimaryKeyChange = {
-  kind: 'addPrimaryKey'
-  constraint: PrimaryKeyConstraint
-}
-
-/**
- * Alter-table change that drops a primary key.
- */
-export type DropPrimaryKeyChange = {
-  kind: 'dropPrimaryKey'
-  name: string
-}
-
-/**
- * Alter-table change that adds a unique constraint.
- */
-export type AddUniqueChange = {
-  kind: 'addUnique'
-  constraint: UniqueConstraint
-}
-
-/**
- * Alter-table change that drops a unique constraint.
- */
-export type DropUniqueChange = {
-  kind: 'dropUnique'
-  name: string
-}
-
-/**
- * Alter-table change that adds a foreign key constraint.
- */
-export type AddForeignKeyChange = {
-  kind: 'addForeignKey'
-  constraint: ForeignKeyConstraint
-}
-
-/**
- * Alter-table change that drops a foreign key constraint.
- */
-export type DropForeignKeyChange = {
-  kind: 'dropForeignKey'
-  name: string
-}
-
-/**
- * Alter-table change that adds a check constraint.
- */
-export type AddCheckChange = {
-  kind: 'addCheck'
-  constraint: CheckConstraint
-}
-
-/**
- * Alter-table change that drops a check constraint.
- */
-export type DropCheckChange = {
-  kind: 'dropCheck'
-  name: string
-}
-
-/**
- * Alter-table change that updates a table comment.
- */
-export type SetTableCommentChange = {
-  kind: 'setTableComment'
-  comment: string
-}
-
-/**
- * Union of supported `alterTable` changes.
- */
-export type AlterTableChange =
-  | AddColumnChange
-  | ChangeColumnChange
-  | RenameColumnChange
-  | DropColumnChange
-  | AddPrimaryKeyChange
-  | DropPrimaryKeyChange
-  | AddUniqueChange
-  | DropUniqueChange
-  | AddForeignKeyChange
-  | DropForeignKeyChange
-  | AddCheckChange
-  | DropCheckChange
-  | SetTableCommentChange
-
-/**
- * Operation that applies one or more table changes.
- */
-export type AlterTableOperation = {
-  kind: 'alterTable'
-  table: TableRef
-  changes: AlterTableChange[]
-  ifExists?: boolean
-}
-
-/**
- * Operation that renames a table.
- */
-export type RenameTableOperation = {
-  kind: 'renameTable'
-  from: TableRef
-  to: TableRef
-}
-
-/**
- * Operation that drops a table.
- */
-export type DropTableOperation = {
-  kind: 'dropTable'
-  table: TableRef
-  ifExists?: boolean
-  cascade?: boolean
-}
-
-/**
- * Operation that creates an index.
- */
-export type CreateIndexOperation = {
-  kind: 'createIndex'
-  index: IndexDefinition
-  ifNotExists?: boolean
-}
-
-/**
- * Operation that drops an index.
- */
-export type DropIndexOperation = {
-  kind: 'dropIndex'
-  table: TableRef
-  name: string
-  ifExists?: boolean
-}
-
-/**
- * Operation that renames an index.
- */
-export type RenameIndexOperation = {
-  kind: 'renameIndex'
-  table: TableRef
-  from: string
-  to: string
-}
-
-/**
- * Operation that adds a table-level foreign key.
- */
-export type AddForeignKeyOperation = {
-  kind: 'addForeignKey'
-  table: TableRef
-  constraint: ForeignKeyConstraint
-}
-
-/**
- * Operation that drops a table-level foreign key.
- */
-export type DropForeignKeyOperation = {
-  kind: 'dropForeignKey'
-  table: TableRef
-  name: string
-}
-
-/**
- * Operation that adds a table-level check constraint.
- */
-export type AddCheckOperation = {
-  kind: 'addCheck'
-  table: TableRef
-  constraint: CheckConstraint
-}
-
-/**
- * Operation that drops a table-level check constraint.
- */
-export type DropCheckOperation = {
-  kind: 'dropCheck'
-  table: TableRef
-  name: string
-}
-
-/**
- * Union of schema and migration operations understood by adapters.
- */
-export type DataMigrationOperation =
-  | CreateTableOperation
-  | AlterTableOperation
-  | RenameTableOperation
-  | DropTableOperation
-  | CreateIndexOperation
-  | DropIndexOperation
-  | RenameIndexOperation
-  | AddForeignKeyOperation
-  | DropForeignKeyOperation
-  | AddCheckOperation
-  | DropCheckOperation
-  | RawOperation
-
 /**
  * Opaque transaction handle supplied by adapters.
  */
@@ -573,14 +266,6 @@ export type DataManipulationRequest = {
   transaction?: TransactionToken
 }
 
-/**
- * Adapter migration request payload.
- */
-export type DataMigrationRequest = {
-  operation: DataMigrationOperation
-  transaction?: TransactionToken
-}
-
 /**
  * Adapter data-manipulation result payload.
  */
@@ -590,16 +275,6 @@ export type DataManipulationResult = {
   insertId?: unknown
 }
 
-/**
- * Adapter data-migration result payload.
- */
-export type DataMigrationResult = {
-  /**
-   * Number of migration operations processed by the adapter call.
-   */
-  affectedOperations?: number
-}
-
 /**
  * Declares adapter feature support.
  */
@@ -624,12 +299,17 @@ export interface DatabaseAdapter {
   dialect: string
   /** Feature flags describing the adapter's supported behaviors. */
   capabilities: AdapterCapabilities
-  /** Compiles a data or migration operation into executable SQL statements. */
-  compileSql(operation: DataManipulationOperation | DataMigrationOperation): SqlStatement[]
+  /** Compiles a data-manipulation operation into executable SQL statements. */
+  compileSql(operation: DataManipulationOperation): SqlStatement[]
   /** Executes a data-manipulation request. */
   execute(request: DataManipulationRequest): Promise<DataManipulationResult>
-  /** Executes a migration request. */
-  migrate(request: DataMigrationRequest): Promise<DataMigrationResult>
+  /**
+   * Executes a raw SQL script that may contain multiple statements.
+   *
+   * Drivers must be configured to accept multi-statement scripts where required
+   * (for example, mysql2 needs `multipleStatements: true`).
+   */
+  executeScript(sql: string, transaction?: TransactionToken): Promise<void>
   /** Checks whether a table exists. */
   hasTable(table: TableRef, transaction?: TransactionToken): Promise<boolean>
   /** Checks whether a column exists on a table. */

package/src/lib/column.ts

@@ -1,5 +1,17 @@
-import type { ColumnDefinition, ForeignKeyAction, IdentityOptions } from './adapter.ts'
-import { toTableRef } from './migrations/helpers.ts'
+import type { ColumnDefinition, ForeignKeyAction, IdentityOptions, TableRef } from './adapter.ts'
+
+function toTableRef(name: string): TableRef {
+  let segments = name.split('.')
+
+  if (segments.length === 1) {
+    return { name }
+  }
+
+  return {
+    schema: segments[0],
+    name: segments.slice(1).join('.'),
+  }
+}
 
 /**
  * Chainable builder used to describe physical column definitions.

package/src/lib/migrations/directive.ts

@@ -0,0 +1,38 @@
+import type { MigrationTransactionMode } from '../migrations.ts'
+
+const directivePattern = /^\s*--\s*data-table\/transaction\s*:\s*(auto|required|none)\s*$/i
+
+/**
+ * Parses an optional `-- data-table/transaction: auto|required|none` directive
+ * from any single-line SQL comment in the script.
+ *
+ * Returns `undefined` when no directive is present.
+ * @param sql SQL script contents.
+ * @returns The declared transaction mode, or `undefined` when not declared.
+ * @throws when more than one directive is present or the value is invalid.
+ */
+export function parseTransactionDirective(sql: string): MigrationTransactionMode | undefined {
+  let match: MigrationTransactionMode | undefined
+
+  for (let line of sql.split(/\r?\n/)) {
+    let trimmed = line.trim()
+
+    if (!trimmed.startsWith('--')) {
+      continue
+    }
+
+    let result = directivePattern.exec(trimmed)
+
+    if (!result) {
+      continue
+    }
+
+    if (match !== undefined) {
+      throw new Error('Migration script declares more than one transaction directive')
+    }
+
+    match = result[1].toLowerCase() as MigrationTransactionMode
+  }
+
+  return match
+}

package/src/lib/migrations/directory-name.ts

@@ -0,0 +1,23 @@
+const migrationDirectoryPattern = /^(\d{14})_(.+)$/
+
+/**
+ * Parses a migration directory name into `{ id, name }`.
+ *
+ * Expected format: `YYYYMMDDHHmmss_name`.
+ * @param name Migration directory basename.
+ * @returns Parsed migration id and name.
+ */
+export function parseMigrationDirectoryName(name: string): { id: string; name: string } {
+  let match = name.match(migrationDirectoryPattern)
+
+  if (!match) {
+    throw new Error(
+      'Invalid migration directory name "' + name + '". Expected format YYYYMMDDHHmmss_name',
+    )
+  }
+
+  return {
+    id: match[1],
+    name: match[2],
+  }
+}

package/src/lib/migrations/journal-store.ts

@@ -2,32 +2,36 @@ import type { DatabaseAdapter, TransactionToken } from '../adapter.ts'
 import { rawSql } from '../sql.ts'
 import type { MigrationDescriptor, MigrationJournalRow } from '../migrations.ts'
 
-export function normalizeChecksum(migration: MigrationDescriptor): string {
-  if (migration.checksum) {
-    return migration.checksum
+export async function computeChecksum(migration: MigrationDescriptor): Promise<string> {
+  let digest = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(migration.up))
+  return bytesToHex(new Uint8Array(digest))
+}
+
+function bytesToHex(bytes: Uint8Array): string {
+  let hex = ''
+
+  for (let byte of bytes) {
+    hex += byte.toString(16).padStart(2, '0')
   }
 
-  return migration.id + ':' + migration.name
+  return hex
 }
 
 export async function ensureMigrationJournal(
   adapter: DatabaseAdapter,
   tableName: string,
 ): Promise<void> {
-  await adapter.migrate({
-    operation: {
-      kind: 'createTable',
-      table: { name: tableName },
-      ifNotExists: true,
-      columns: {
-        id: { type: 'varchar', length: 64, nullable: false, primaryKey: true },
-        name: { type: 'varchar', length: 255, nullable: false },
-        checksum: { type: 'varchar', length: 128, nullable: false },
-        batch: { type: 'integer', nullable: false },
-        applied_at: { type: 'timestamp', nullable: false, default: { kind: 'now' } },
-      },
-    },
-  })
+  await adapter.executeScript(
+    'create table if not exists ' +
+      tableName +
+      ' (' +
+      'id varchar(64) not null primary key, ' +
+      'name varchar(255) not null, ' +
+      'checksum varchar(128) not null, ' +
+      'batch integer not null, ' +
+      'applied_at timestamp not null default current_timestamp' +
+      ')',
+  )
 }
 
 export async function hasMigrationJournal(

package/src/lib/migrations/registry.ts

@@ -33,7 +33,7 @@ export function resolveMigrations(
  * import { createMigrationRegistry } from 'remix/data-table/migrations'
  *
  * let registry = createMigrationRegistry()
- * registry.register({ id, name, migration })
+ * registry.register({ id, name, up, down })
  * ```
  */
 export function createMigrationRegistry(initial: MigrationDescriptor[] = []): MigrationRegistry {