Skip to content
Interfaceplugin-kysely-postgresv0.8.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

dir

Folder holding your migration files, subfolders included. A relative path resolves against root from seedcord.config.ts.

readonly dir: string

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

Orders recorded migrations that ran at the same timestamp. Defaults to localeCompare. Pending migrations always run sorted by name.

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

onStartup

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

readonly onStartup?: boolean | MigrationOptions