Skip to content
Interfaceplugin-kysely-postgresv0.6.0

KyselyMigrationsOptions

Options that describe where migrations live and how the migrator should behave.

interface KyselyMigrationsOptions

allowUnorderedMigrations

Allow running migrations even if new ones are inserted out of order

readonly allowUnorderedMigrations?: boolean

migrationLockTableName

Custom lock table name used by the migrator

readonly migrationLockTableName?: string

migrationTableName

Custom table name used to track executed migrations

readonly migrationTableName?: string

migrationTableSchema

Schema that contains the migration bookkeeping tables

readonly migrationTableSchema?: string

nameComparator

Comparator that determines execution order for migrations

readonly nameComparator?: (nameA: string, nameB: string) => number

onStartup

Behavior when the plugin connects. true/undefined runs to latest.

readonly onStartup?: boolean | MigrationOptions

path

Directory path, single file path, or array of migration files

readonly path: string | string[]