@effect/sql-pg 4.0.0-beta.67 → 4.0.0-beta.68

package/dist/PgClient.d.ts

@@ -18,14 +18,14 @@ import * as Pg from "pg";
 /**
  * Runtime type identifier used to mark `PgClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier used to mark `PgClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-pg/PgClient";
@@ -178,7 +178,7 @@ export declare const layer: (config: PgPoolConfig) => Layer.Layer<PgClient | Cli
 /**
  * Creates the PostgreSQL statement compiler, using `$1` placeholders, double-quoted identifiers, PostgreSQL returning clauses, and optional JSON value transformation.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const makeCompiler: (transform?: (_: string) => string, transformJson?: boolean) => Statement.Compiler;

package/dist/PgClient.js

@@ -45,7 +45,7 @@ import Cursor from "pg-cursor";
 /**
  * Runtime type identifier used to mark `PgClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-pg/PgClient";
@@ -511,7 +511,7 @@ export const layer = config => layerFrom(make(config));
 /**
  * Creates the PostgreSQL statement compiler, using `$1` placeholders, double-quoted identifiers, PostgreSQL returning clauses, and optional JSON value transformation.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const makeCompiler = (transform, transformJson = true) => {

package/dist/PgMigrator.d.ts

@@ -37,7 +37,7 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs PostgreSQL SQL migrations using the configured clients. Schema dumps use `pg_dump` and require child process, filesystem, and path services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const run: <R2 = never>(options: Migrator.MigratorOptions<R2>) => Effect.Effect<ReadonlyArray<readonly [id: number, name: string]>, Migrator.MigrationError | SqlError, SqlClient | PgClient | ChildProcessSpawner.ChildProcessSpawner | FileSystem.FileSystem | Path.Path | R2>;

package/dist/PgMigrator.js

@@ -37,7 +37,7 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs PostgreSQL SQL migrations using the configured clients. Schema dumps use `pg_dump` and require child process, filesystem, and path services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run = /*#__PURE__*/Migrator.make({

package/dist/index.d.ts

@@ -2,10 +2,47 @@
  * @since 4.0.0
  */
 /**
+ * PostgreSQL client implementation for Effect SQL, backed by `pg`.
+ *
+ * This module exposes constructors for creating a scoped `PgClient` from a
+ * managed `pg` pool, a single managed `pg` client, or lower-level connection
+ * acquirers. The resulting service can be provided as both `PgClient` and the
+ * generic `SqlClient`, and is intended for application database access,
+ * migrations, transactional workflows, row streaming, JSON parameters, and
+ * PostgreSQL LISTEN/NOTIFY integration.
+ *
+ * Pool-backed clients acquire connections per operation and reserve dedicated
+ * connections for transactions and cursor streams. Clients built from one
+ * `pg.Client` serialize shared access; enable `acquireForStream` when streams
+ * or listeners need their own client instead of sharing the query connection.
+ * LISTEN uses a scoped long-lived client and automatically issues `UNLISTEN`
+ * when the stream scope closes, so listeners should be scoped for as long as
+ * notifications are needed.
+ *
  * @since 4.0.0
  */
 export * as PgClient from "./PgClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to PostgreSQL databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through
+ * the current PostgreSQL `SqlClient` and `PgClient`. It is typically used at
+ * application startup, during deployment, in integration tests that provision a
+ * temporary PostgreSQL database, or in layer graphs that must prepare the
+ * schema before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so concurrent
+ * application instances should coordinate startup against the same database and
+ * avoid racing to install the same changes. When `schemaDirectory` is enabled,
+ * this adapter shells out to `pg_dump` using the active `PgClient`
+ * configuration, so `pg_dump` must be available on `PATH` and the layer must
+ * provide child process, filesystem, and path services. The generated dumps
+ * intentionally strip comments, session settings, ownership, and privilege
+ * statements to keep schema snapshots portable across PostgreSQL environments.
+ *
  * @since 4.0.0
  */
 export * as PgMigrator from "./PgMigrator.ts";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}

package/dist/index.js

@@ -3,10 +3,47 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * PostgreSQL client implementation for Effect SQL, backed by `pg`.
+ *
+ * This module exposes constructors for creating a scoped `PgClient` from a
+ * managed `pg` pool, a single managed `pg` client, or lower-level connection
+ * acquirers. The resulting service can be provided as both `PgClient` and the
+ * generic `SqlClient`, and is intended for application database access,
+ * migrations, transactional workflows, row streaming, JSON parameters, and
+ * PostgreSQL LISTEN/NOTIFY integration.
+ *
+ * Pool-backed clients acquire connections per operation and reserve dedicated
+ * connections for transactions and cursor streams. Clients built from one
+ * `pg.Client` serialize shared access; enable `acquireForStream` when streams
+ * or listeners need their own client instead of sharing the query connection.
+ * LISTEN uses a scoped long-lived client and automatically issues `UNLISTEN`
+ * when the stream scope closes, so listeners should be scoped for as long as
+ * notifications are needed.
+ *
  * @since 4.0.0
  */
 export * as PgClient from "./PgClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to PostgreSQL databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through
+ * the current PostgreSQL `SqlClient` and `PgClient`. It is typically used at
+ * application startup, during deployment, in integration tests that provision a
+ * temporary PostgreSQL database, or in layer graphs that must prepare the
+ * schema before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so concurrent
+ * application instances should coordinate startup against the same database and
+ * avoid racing to install the same changes. When `schemaDirectory` is enabled,
+ * this adapter shells out to `pg_dump` using the active `PgClient`
+ * configuration, so `pg_dump` must be available on `PATH` and the layer must
+ * provide child process, filesystem, and path services. The generated dumps
+ * intentionally strip comments, session settings, ownership, and privilege
+ * statements to keep schema snapshots portable across PostgreSQL environments.
+ *
  * @since 4.0.0
  */
 export * as PgMigrator from "./PgMigrator.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["PgClient","PgMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["PgClient","PgMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKA,QAAQ,MAAM,eAAe;AAEzC;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-pg",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.68",
   "type": "module",
   "license": "MIT",
   "description": "A PostgreSQL toolkit for Effect",
@@ -46,10 +46,10 @@
     "@testcontainers/postgresql": "^11.14.0",
     "@types/pg": "^8.20.0",
     "@types/pg-cursor": "^2.7.2",
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "peerDependencies": {
-    "effect": "^4.0.0-beta.67"
+    "effect": "^4.0.0-beta.68"
   },
   "dependencies": {
     "pg": "^8.20.0",

package/src/PgClient.ts

@@ -64,7 +64,7 @@ import Cursor from "pg-cursor"
 /**
  * Runtime type identifier used to mark `PgClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-pg/PgClient"
@@ -72,7 +72,7 @@ export const TypeId: TypeId = "~@effect/sql-pg/PgClient"
 /**
  * Type-level identifier used to mark `PgClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-pg/PgClient"
@@ -810,7 +810,7 @@ export const layer = (
 /**
  * Creates the PostgreSQL statement compiler, using `$1` placeholders, double-quoted identifiers, PostgreSQL returning clauses, and optional JSON value transformation.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const makeCompiler = (

package/src/PgMigrator.ts

@@ -41,7 +41,7 @@ export * from "effect/unstable/sql/Migrator"
 /**
  * Runs PostgreSQL SQL migrations using the configured clients. Schema dumps use `pg_dump` and require child process, filesystem, and path services.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run: <R2 = never>(

package/src/index.ts

@@ -5,11 +5,48 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * PostgreSQL client implementation for Effect SQL, backed by `pg`.
+ *
+ * This module exposes constructors for creating a scoped `PgClient` from a
+ * managed `pg` pool, a single managed `pg` client, or lower-level connection
+ * acquirers. The resulting service can be provided as both `PgClient` and the
+ * generic `SqlClient`, and is intended for application database access,
+ * migrations, transactional workflows, row streaming, JSON parameters, and
+ * PostgreSQL LISTEN/NOTIFY integration.
+ *
+ * Pool-backed clients acquire connections per operation and reserve dedicated
+ * connections for transactions and cursor streams. Clients built from one
+ * `pg.Client` serialize shared access; enable `acquireForStream` when streams
+ * or listeners need their own client instead of sharing the query connection.
+ * LISTEN uses a scoped long-lived client and automatically issues `UNLISTEN`
+ * when the stream scope closes, so listeners should be scoped for as long as
+ * notifications are needed.
+ *
  * @since 4.0.0
  */
 export * as PgClient from "./PgClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to PostgreSQL databases.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations through
+ * the current PostgreSQL `SqlClient` and `PgClient`. It is typically used at
+ * application startup, during deployment, in integration tests that provision a
+ * temporary PostgreSQL database, or in layer graphs that must prepare the
+ * schema before dependent services are acquired.
+ *
+ * Migrations are recorded in `effect_sql_migrations` by default and are loaded
+ * using the shared `<id>_<name>` file or record-key convention. Only migrations
+ * with an id greater than the latest recorded id are applied, so concurrent
+ * application instances should coordinate startup against the same database and
+ * avoid racing to install the same changes. When `schemaDirectory` is enabled,
+ * this adapter shells out to `pg_dump` using the active `PgClient`
+ * configuration, so `pg_dump` must be available on `PATH` and the layer must
+ * provide child process, filesystem, and path services. The generated dumps
+ * intentionally strip comments, session settings, ownership, and privilege
+ * statements to keep schema snapshots portable across PostgreSQL environments.
+ *
  * @since 4.0.0
  */
 export * as PgMigrator from "./PgMigrator.ts"