Skip to content
plasma

Interface: RunMigrationsOptions<S>

Interface: RunMigrationsOptions<S>

Section titled “Interface: RunMigrationsOptions<S>”

Defined in: server/src/migrations.ts:180

Type Parameters

Section titled “Type Parameters”

S

Section titled “S”

S extends Schema<Record<string, AnyTable>>

Properties

Section titled “Properties”

schema

Section titled “schema”

readonly schema: S

Defined in: server/src/migrations.ts:181

executor

Section titled “executor”

readonly executor: SqlExecutor

Defined in: server/src/migrations.ts:182

dialect?

Section titled “dialect?”

readonly optional dialect?: SqlDialect

Defined in: server/src/migrations.ts:183

onLog?

Section titled “onLog?”

readonly optional onLog?: (event) => void

Defined in: server/src/migrations.ts:185

Called once per DDL statement + high-level plan events.

Parameters

Section titled “Parameters”
event
Section titled “event”

MigrationEvent

Returns

Section titled “Returns”

void

dryRun?

Section titled “dryRun?”

readonly optional dryRun?: boolean

Defined in: server/src/migrations.ts:190

When true, compute the diff and return the planned statements but do not execute them. Useful for CI dry-run.