@effect/sql-pg 4.0.0-beta.8 → 4.0.0-beta.81

package/src/PgMigrator.ts

@@ -1,5 +1,13 @@
 /**
- * @since 1.0.0
+ * Runs database migrations for PostgreSQL projects that use Effect SQL.
+ *
+ * This module reuses the shared SQL migrator and connects it to PostgreSQL. It
+ * exposes the common migration helpers and adds `run` and `layer` functions
+ * that apply pending migration files with the current SQL client. When schema
+ * dumps are requested, it uses `pg_dump` and the usual process and filesystem
+ * services.
+ *
+ * @since 4.0.0
  */
 import * as Effect from "effect/Effect"
 import * as FileSystem from "effect/FileSystem"
@@ -7,20 +15,22 @@ import * as Layer from "effect/Layer"
 import * as Path from "effect/Path"
 import * as Redacted from "effect/Redacted"
 import * as ChildProcess from "effect/unstable/process/ChildProcess"
-import type * as ChildProcessSpawner from "effect/unstable/process/ChildProcessSpawner"
+import * as ChildProcessSpawner from "effect/unstable/process/ChildProcessSpawner"
 import * as Migrator from "effect/unstable/sql/Migrator"
 import type { SqlClient } from "effect/unstable/sql/SqlClient"
 import type { SqlError } from "effect/unstable/sql/SqlError"
 import { PgClient } from "./PgClient.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * from "effect/unstable/sql/Migrator"
 
 /**
- * @category constructor
- * @since 1.0.0
+ * Runs PostgreSQL SQL migrations using the configured clients. Schema dumps use `pg_dump` and require child process, filesystem, and path services.
+ *
+ * @category constructors
+ * @since 4.0.0
  */
 export const run: <R2 = never>(
   options: Migrator.MigratorOptions<R2>
@@ -38,6 +48,7 @@ export const run: <R2 = never>(
     const pgDump = (args: Array<string>) =>
       Effect.gen(function*() {
         const sql = yield* PgClient
+        const spawner = yield* ChildProcessSpawner.ChildProcessSpawner
         const dump = yield* ChildProcess.make("pg_dump", [...args, "--no-owner", "--no-privileges"], {
           env: {
             PATH: (globalThis as any).process?.env.PATH,
@@ -50,7 +61,7 @@ export const run: <R2 = never>(
             PGDATABASE: sql.config.database,
             PGSSLMODE: sql.config.ssl ? "require" : "prefer"
           }
-        }).pipe(ChildProcess.string)
+        }).pipe(spawner.string)
 
         return dump.replace(/^--.*$/gm, "")
           .replace(/^SET .*$/gm, "")
@@ -90,8 +101,10 @@ export const run: <R2 = never>(
 })
 
 /**
+ * Creates a layer that runs PostgreSQL migrations during layer construction, including `pg_dump`-based schema dump support when requested.
+ *
  * @category layers
- * @since 1.0.0
+ * @since 4.0.0
  */
 export const layer = <R>(
   options: Migrator.MigratorOptions<R>

package/src/index.ts

@@ -1,15 +1,15 @@
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as PgClient from "./PgClient.ts"
 
 /**
- * @since 1.0.0
+ * @since 4.0.0
  */
 export * as PgMigrator from "./PgMigrator.ts"