# KyselyMigrationsOptions

`interface` in `plugin-kysely-postgres` · v0.8.0

<https://seedcord.org/docs/packages/plugin-kysely-postgres/0.8.0/interfaces/kysely-migrations-options>

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

```ts
interface KyselyMigrationsOptions
```

## Properties

### allowUnorderedMigrations

```ts
readonly allowUnorderedMigrations?: boolean
```

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

### dir

```ts
readonly dir: string
```

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

### migrationLockTableName

```ts
readonly migrationLockTableName?: string
```

Custom lock table name used by the migrator

### migrationTableName

```ts
readonly migrationTableName?: string
```

Custom table name used to track executed migrations

### migrationTableSchema

```ts
readonly migrationTableSchema?: string
```

Schema that contains the migration bookkeeping tables

### nameComparator

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

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

### onStartup

```ts
readonly onStartup?: boolean | MigrationOptions
```

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