effect-sql-kysely
Version:
A full-featured integration between `@effect/sql` and `Kysely` that provides type-safe database operations with Effect's powerful error handling and resource management.
31 lines (30 loc) • 1.82 kB
TypeScript
import { SqlClient, SqlError, Statement } from "@effect/sql";
import type { Row } from "@effect/sql/SqlConnection";
import * as Context from "effect/Context";
import * as Effect from "effect/Effect";
import * as Layer from "effect/Layer";
import type * as Scope from "effect/Scope";
import type * as kysely from "kysely";
import { makeResolver } from "./makeResolver.js";
import { makeSchema } from "./makeSchema.js";
export interface KyselyDatabase<DB> {
readonly sql: SqlClient.SqlClient;
readonly db: kysely.Kysely<DB>;
readonly kysely: <Out extends Row>(f: (db: kysely.Kysely<DB>) => kysely.Compilable<Out>) => Effect.Effect<ReadonlyArray<Out>, SqlError.SqlError, never>;
}
export declare const make: <DB, Self>(id: string) => DatabaseConstructor<DB, Self>;
export interface CoreDatabaseConstructor<DB, Self> extends Context.TagClass<Self, string, KyselyDatabase<DB>> {
readonly resolver: ReturnType<typeof makeResolver<DB, never, Self>>;
readonly schema: ReturnType<typeof makeSchema<DB, never, Self>>;
readonly client: Effect.Effect<SqlClient.SqlClient, never, Self>;
readonly kysely: <Out extends Row>(f: (db: kysely.Kysely<DB>) => kysely.Compilable<Out>) => Effect.Effect<ReadonlyArray<Out>, SqlError.SqlError, Self>;
readonly withTransaction: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, SqlError.SqlError | E, Self | R>;
}
export interface DatabaseConstructor<DB, Self> extends CoreDatabaseConstructor<DB, Self> {
readonly layerWithCompiler: <E, R>(options: {
readonly acquire: Effect.Effect<kysely.Kysely<DB>, E, R | Scope.Scope>;
readonly compiler: Statement.Compiler;
readonly spanAttributes?: ReadonlyArray<readonly [string, string]>;
readonly chunkSize?: number;
}) => Layer.Layer<Self, E, Exclude<R, Scope.Scope>>;
}