createMigrationRunner

Summary

Creates a migration runner for applying/reverting SQL migrations against an adapter.

Signature

function createMigrationRunner(
  adapter: DatabaseAdapter,
  migrations: MigrationRegistry | MigrationDescriptor[],
  options: MigrationRunnerOptions,
): MigrationRunner

Example

import { createMigrationRunner } from 'remix/data-table/migrations'

let runner = createMigrationRunner(adapter, migrations, {
  journalTable: 'app_migrations',
})
await runner.up()

Parameters

adapter

Database adapter used to execute migration scripts.

migrations

Migration descriptors or registry.

options

Optional runner configuration.

Returns

A migration runner instance.