MysqlMigrator.ts

MysqlMigrator.ts overview

MySQL adapter for the shared Effect SQL migration runner.

This module re-exports the shared Migrator loaders and error types, then provides run and layer helpers that apply ordered migrations through the current mysql2-backed SqlClient. run returns the applied migration IDs and names, while layer runs migrations during layer construction and provides no services.

Since v4.0.0

---

Exports Grouped by Category

• constructors
  • run
• layers
  • layer
• utils
  • “effect/unstable/sql/Migrator” (namespace export)

---

constructors

run

Runs SQL migrations using the configured SqlClient, returning the migrations that were applied.

Signature

declare const run: <R2 = never>({
  loader,
  schemaDirectory,
  table
}: Migrator.MigratorOptions<R2>) => Effect.Effect<
  ReadonlyArray<readonly [id: number, name: string]>,
  Migrator.MigrationError | SqlError,
  Client.SqlClient | R2
>

Source

Since v4.0.0

layers

layer

Creates a layer that runs the configured SQL migrations during layer construction.

Signature

declare const layer: <R>(
  options: Migrator.MigratorOptions<R>
) => Layer.Layer<never, Migrator.MigrationError | SqlError, Client.SqlClient | R>

Source

Since v4.0.0

utils

“effect/unstable/sql/Migrator” (namespace export)

Re-exports all named exports from the “effect/unstable/sql/Migrator” module.

Signature

export * from "effect/unstable/sql/Migrator"

Source

Since v4.0.0