Skip to main content Link Search Menu Expand Document (external link)
effect

PgMigrator overview

Added in v1.0.0

Table of contents

constructor

run

Signature

export declare const run: <R2 = never>(
  options: Migrator.MigratorOptions<R2>
) => Effect.Effect<
  ReadonlyArray<readonly [id: number, name: string]>,
  Migrator.MigrationError | SqlError,
  FileSystem | Path | PgClient | Client.SqlClient | CommandExecutor | R2
>

Added in v1.0.0

exports

From “@effect/sql/Migrator”

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

Signature

export * from "@effect/sql/Migrator"

Added in v1.0.0

From “@effect/sql/Migrator/FileSystem”

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

Signature

export * from "@effect/sql/Migrator/FileSystem"

Added in v1.0.0

layers

layer

Signature

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

Added in v1.0.0