52 lines
1.5 KiB
TypeScript
52 lines
1.5 KiB
TypeScript
/**
|
|
* ClickHouse adapter for the shared Effect SQL migration runner.
|
|
*
|
|
* This module re-exports the common `Migrator` loaders and error types, then
|
|
* provides `run` and `layer` helpers that apply ordered migrations through the
|
|
* current ClickHouse `SqlClient`. `run` returns the applied migration IDs and
|
|
* names, while `layer` runs the migrations during layer construction and
|
|
* provides no services.
|
|
*
|
|
* @since 4.0.0
|
|
*/
|
|
import type * as Effect from "effect/Effect"
|
|
import * as Layer from "effect/Layer"
|
|
import * as Migrator from "effect/unstable/sql/Migrator"
|
|
import type * as Client from "effect/unstable/sql/SqlClient"
|
|
import type { SqlError } from "effect/unstable/sql/SqlError"
|
|
|
|
/**
|
|
* @since 4.0.0
|
|
*/
|
|
export * from "effect/unstable/sql/Migrator"
|
|
|
|
/**
|
|
* Runs SQL migrations for ClickHouse using the supplied migrator options and
|
|
* returns the applied migration IDs and names.
|
|
*
|
|
* @category constructors
|
|
* @since 4.0.0
|
|
*/
|
|
export const run: <R2 = never>(
|
|
{ loader, schemaDirectory, table }: Migrator.MigratorOptions<R2>
|
|
) => Effect.Effect<
|
|
ReadonlyArray<readonly [id: number, name: string]>,
|
|
Migrator.MigrationError | SqlError,
|
|
Client.SqlClient | R2
|
|
> = Migrator.make({})
|
|
|
|
/**
|
|
* Creates a layer that runs the configured ClickHouse migrations during layer
|
|
* construction and provides no services.
|
|
*
|
|
* @category layers
|
|
* @since 4.0.0
|
|
*/
|
|
export const layer = <R>(
|
|
options: Migrator.MigratorOptions<R>
|
|
): Layer.Layer<
|
|
never,
|
|
Migrator.MigrationError | SqlError,
|
|
Client.SqlClient | R
|
|
> => Layer.effectDiscard(run(options))
|