# KpgMigrationsOptions

`interface` in `plugins` · v0.6.1

<https://docs.seedcord.org/packages/plugins/0.6.1/interfaces/kpg-migrations-options>

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

```ts
interface KpgMigrationsOptions
```

## Properties

### allowUnorderedMigrations

```ts
readonly allowUnorderedMigrations: boolean
```

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

### 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
```

Comparator that determines execution order for migrations

### onStartup

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

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

### path

```ts
readonly path: string | string[]
```

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