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

package/dist/MysqlClient.d.ts

@@ -33,14 +33,14 @@ import * as Mysql from "mysql2";
 /**
  * Runtime type identifier used to mark `MysqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level identifier used to mark `MysqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-mysql2/MysqlClient";

package/dist/MysqlClient.js

@@ -122,7 +122,7 @@ const classifyError = (cause, message, operation) => {
 /**
  * Runtime type identifier used to mark `MysqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-mysql2/MysqlClient";

package/dist/MysqlMigrator.d.ts

@@ -31,7 +31,7 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export declare const run: <R2 = never>({ loader, schemaDirectory, table }: Migrator.MigratorOptions<R2>) => Effect.Effect<ReadonlyArray<readonly [id: number, name: string]>, Migrator.MigrationError | SqlError, Client.SqlClient | R2>;

package/dist/MysqlMigrator.js

@@ -7,7 +7,7 @@ export * from "effect/unstable/sql/Migrator";
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run = /*#__PURE__*/Migrator.make({

package/dist/index.d.ts

@@ -2,10 +2,45 @@
  * @since 4.0.0
  */
 /**
+ * MySQL client implementation for Effect SQL, backed by the `mysql2` driver.
+ *
+ * This module exposes constructors and layers for providing both the MySQL-specific
+ * `MysqlClient` service and the generic `SqlClient` service. It is intended for server
+ * applications, background workers, migrations, and tests that need Effect SQL query
+ * compilation, scoped resource management, streaming queries, and consistent `SqlError`
+ * classification for MySQL driver failures.
+ *
+ * Each client owns a scoped mysql2 pool, validates connectivity with `SELECT 1` during
+ * acquisition, and closes the pool when the surrounding scope is released. You can configure
+ * the pool from a connection URI or discrete connection fields; when `url` is supplied it
+ * takes precedence over the host, port, database, username, and password fields. Regular
+ * queries run through the shared pool, while transactions acquire a dedicated pooled
+ * connection for their lifetime, so long-running transactions and streams can occupy pool
+ * capacity. Size `maxConnections`, `connectionTTL`, and any mysql2 `poolConfig` with that in
+ * mind.
+ *
  * @since 4.0.0
  */
 export * as MysqlClient from "./MysqlClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to MySQL databases through the
+ * mysql2-backed `SqlClient`.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations using the
+ * currently configured MySQL `SqlClient`. It is commonly used during application
+ * startup, in integration tests that provision a temporary schema, or in layer
+ * graphs where dependent services should not start until the database schema is
+ * current.
+ *
+ * Applied migrations are stored in `effect_sql_migrations` by default and use
+ * the shared `<id>_<name>` loader convention. Only migrations with ids greater
+ * than the latest recorded id are run. MySQL DDL can cause implicit commits, and
+ * this adapter relies on migration table constraints to detect concurrent
+ * runners, so coordinate startup runners and write migrations to tolerate
+ * MySQL's transactional semantics. Schema dump support is not enabled in this
+ * adapter, so `schemaDirectory` does not emit a MySQL dump.
+ *
  * @since 4.0.0
  */
 export * as MysqlMigrator from "./MysqlMigrator.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,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA"}

package/dist/index.js

@@ -3,10 +3,45 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * MySQL client implementation for Effect SQL, backed by the `mysql2` driver.
+ *
+ * This module exposes constructors and layers for providing both the MySQL-specific
+ * `MysqlClient` service and the generic `SqlClient` service. It is intended for server
+ * applications, background workers, migrations, and tests that need Effect SQL query
+ * compilation, scoped resource management, streaming queries, and consistent `SqlError`
+ * classification for MySQL driver failures.
+ *
+ * Each client owns a scoped mysql2 pool, validates connectivity with `SELECT 1` during
+ * acquisition, and closes the pool when the surrounding scope is released. You can configure
+ * the pool from a connection URI or discrete connection fields; when `url` is supplied it
+ * takes precedence over the host, port, database, username, and password fields. Regular
+ * queries run through the shared pool, while transactions acquire a dedicated pooled
+ * connection for their lifetime, so long-running transactions and streams can occupy pool
+ * capacity. Size `maxConnections`, `connectionTTL`, and any mysql2 `poolConfig` with that in
+ * mind.
+ *
  * @since 4.0.0
  */
 export * as MysqlClient from "./MysqlClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to MySQL databases through the
+ * mysql2-backed `SqlClient`.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations using the
+ * currently configured MySQL `SqlClient`. It is commonly used during application
+ * startup, in integration tests that provision a temporary schema, or in layer
+ * graphs where dependent services should not start until the database schema is
+ * current.
+ *
+ * Applied migrations are stored in `effect_sql_migrations` by default and use
+ * the shared `<id>_<name>` loader convention. Only migrations with ids greater
+ * than the latest recorded id are run. MySQL DDL can cause implicit commits, and
+ * this adapter relies on migration table constraints to detect concurrent
+ * runners, so coordinate startup runners and write migrations to tolerate
+ * MySQL's transactional semantics. Schema dump support is not enabled in this
+ * adapter, so `schemaDirectory` does not emit a MySQL dump.
+ *
  * @since 4.0.0
  */
 export * as MysqlMigrator from "./MysqlMigrator.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["MysqlClient","MysqlMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["MysqlClient","MysqlMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKA,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKC,aAAa,MAAM,oBAAoB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-mysql2",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.68",
   "type": "module",
   "license": "MIT",
   "description": "A MySQL toolkit for Effect",
@@ -44,10 +44,10 @@
   },
   "devDependencies": {
     "@testcontainers/mysql": "^11.14.0",
-    "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": {
     "mysql2": "^3.22.3"

package/src/MysqlClient.ts

@@ -145,7 +145,7 @@ const classifyError = (
 /**
  * Runtime type identifier used to mark `MysqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-mysql2/MysqlClient"
@@ -153,7 +153,7 @@ export const TypeId: TypeId = "~@effect/sql-mysql2/MysqlClient"
 /**
  * Type-level identifier used to mark `MysqlClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-mysql2/MysqlClient"

package/src/MysqlMigrator.ts

@@ -33,7 +33,7 @@ export * from "effect/unstable/sql/Migrator"
 /**
  * Runs SQL migrations using the configured `SqlClient`, returning the migrations that were applied.
  *
- * @category constructor
+ * @category constructors
  * @since 4.0.0
  */
 export const run: <R2 = never>(

package/src/index.ts

@@ -5,11 +5,46 @@
 // @barrel: Auto-generated exports. Do not edit manually.
 
 /**
+ * MySQL client implementation for Effect SQL, backed by the `mysql2` driver.
+ *
+ * This module exposes constructors and layers for providing both the MySQL-specific
+ * `MysqlClient` service and the generic `SqlClient` service. It is intended for server
+ * applications, background workers, migrations, and tests that need Effect SQL query
+ * compilation, scoped resource management, streaming queries, and consistent `SqlError`
+ * classification for MySQL driver failures.
+ *
+ * Each client owns a scoped mysql2 pool, validates connectivity with `SELECT 1` during
+ * acquisition, and closes the pool when the surrounding scope is released. You can configure
+ * the pool from a connection URI or discrete connection fields; when `url` is supplied it
+ * takes precedence over the host, port, database, username, and password fields. Regular
+ * queries run through the shared pool, while transactions acquire a dedicated pooled
+ * connection for their lifetime, so long-running transactions and streams can occupy pool
+ * capacity. Size `maxConnections`, `connectionTTL`, and any mysql2 `poolConfig` with that in
+ * mind.
+ *
  * @since 4.0.0
  */
 export * as MysqlClient from "./MysqlClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to MySQL databases through the
+ * mysql2-backed `SqlClient`.
+ *
+ * This module re-exports the shared `Migrator` loaders and error types, then
+ * provides `run` and `layer` helpers for applying ordered migrations using the
+ * currently configured MySQL `SqlClient`. It is commonly used during application
+ * startup, in integration tests that provision a temporary schema, or in layer
+ * graphs where dependent services should not start until the database schema is
+ * current.
+ *
+ * Applied migrations are stored in `effect_sql_migrations` by default and use
+ * the shared `<id>_<name>` loader convention. Only migrations with ids greater
+ * than the latest recorded id are run. MySQL DDL can cause implicit commits, and
+ * this adapter relies on migration table constraints to detect concurrent
+ * runners, so coordinate startup runners and write migrations to tolerate
+ * MySQL's transactional semantics. Schema dump support is not enabled in this
+ * adapter, so `schemaDirectory` does not emit a MySQL dump.
+ *
  * @since 4.0.0
  */
 export * as MysqlMigrator from "./MysqlMigrator.ts"