Skip to content
plasma

Interface: RunMigrationsOptions<S>

Interface: RunMigrationsOptions<S>

Section titled “Interface: RunMigrationsOptions<S>”

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

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:198

executor

Section titled “executor”

readonly executor: SqlExecutor

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

dialect?

Section titled “dialect?”

readonly optional dialect?: SqlDialect

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

onLog?

Section titled “onLog?”

readonly optional onLog?: (event) => void

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

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:207

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

audit?

Section titled “audit?”

readonly optional audit?: boolean

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

Enables the opt-in audit-log tables (_plasma_audit_log, _plasma_audit_touched_rows, _plasma_audit_checkpoints). Omit or pass false to keep the audit primitive out of the deployment entirely — no DDL, no runtime cost. Must match SyncHandlerOptions.audit at the sync-handler boundary; a mismatch fires PlasmaAuditSchemaError on the first push/pull.