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

package/dist/ClickhouseClient.d.ts

@@ -35,14 +35,14 @@ import type { Readable } from "node:stream";
 /**
  * Unique runtime identifier used to tag `ClickhouseClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export declare const TypeId: TypeId;
 /**
  * Type-level literal for the `ClickhouseClient` runtime identifier.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-clickhouse/ClickhouseClient";
@@ -106,7 +106,7 @@ export declare const make: (options: ClickhouseClientConfig) => Effect.Effect<Cl
  * Fiber reference read by the low-level ClickHouse connection to choose query
  * or command execution for statements; defaults to `query`.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export declare const ClientMethod: Context.Reference<"query" | "command" | "insert">;
@@ -114,7 +114,7 @@ export declare const ClientMethod: Context.Reference<"query" | "command" | "inse
  * Fiber reference for the ClickHouse `query_id` applied to queries and
  * inserts; a random UUID is generated when no query ID is set.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export declare const QueryId: Context.Reference<string | undefined>;
@@ -122,7 +122,7 @@ export declare const QueryId: Context.Reference<string | undefined>;
  * Fiber reference containing ClickHouse settings to attach to queries,
  * commands, and inserts.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export declare const ClickhouseSettings: Context.Reference<NonNullable<Clickhouse.BaseQueryParams["clickhouse_settings"]>>;

package/dist/ClickhouseClient.js

@@ -79,7 +79,7 @@ const classifyError = (cause, message, operation, fallback = "unknown") => {
 /**
  * Unique runtime identifier used to tag `ClickhouseClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId = "~@effect/sql-clickhouse/ClickhouseClient";
@@ -260,7 +260,7 @@ export const make = options => Effect.gen(function* () {
  * Fiber reference read by the low-level ClickHouse connection to choose query
  * or command execution for statements; defaults to `query`.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const ClientMethod = /*#__PURE__*/Context.Reference("@effect/sql-clickhouse/ClickhouseClient/ClientMethod", {
@@ -270,7 +270,7 @@ export const ClientMethod = /*#__PURE__*/Context.Reference("@effect/sql-clickhou
  * Fiber reference for the ClickHouse `query_id` applied to queries and
  * inserts; a random UUID is generated when no query ID is set.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const QueryId = /*#__PURE__*/Context.Reference("@effect/sql-clickhouse/ClickhouseClient/QueryId", {
@@ -280,7 +280,7 @@ export const QueryId = /*#__PURE__*/Context.Reference("@effect/sql-clickhouse/Cl
  * Fiber reference containing ClickHouse settings to attach to queries,
  * commands, and inserts.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const ClickhouseSettings = /*#__PURE__*/Context.Reference("@effect/sql-clickhouse/ClickhouseClient/ClickhouseSettings", {

package/dist/ClickhouseMigrator.d.ts

@@ -31,7 +31,7 @@ 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 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/ClickhouseMigrator.js

@@ -8,7 +8,7 @@ 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 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
  */
 /**
+ * ClickHouse client implementation for Effect SQL, backed by
+ * `@clickhouse/client`.
+ *
+ * This module exposes constructors and layers for providing both the
+ * ClickHouse-specific `ClickhouseClient` service and the generic `SqlClient`
+ * service. It is intended for analytical application queries, migrations,
+ * background jobs, bulk inserts, and streaming reads that need Effect SQL query
+ * compilation, scoped lifecycle management, interruption, and consistent
+ * `SqlError` classification for ClickHouse failures.
+ *
+ * The client uses the ClickHouse HTTP client APIs for `query`, `command`, and
+ * `insert` operations. Regular queries read JSON result sets, `executeValues`
+ * requests `JSONCompact`, streams request `JSONEachRow`, and `insertQuery`
+ * defaults inserts to `JSONEachRow`. Interrupting an operation aborts the
+ * underlying HTTP request and attempts to kill the generated or supplied
+ * `query_id`. The statement compiler emits ClickHouse typed placeholders such
+ * as `{p1: Type}`; use `param` when the inferred type is too broad, and write
+ * ClickHouse-specific clauses such as engines, `SETTINGS`, `FORMAT`, or
+ * cluster directives explicitly.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseClient from "./ClickhouseClient.ts";
 /**
+ * Utilities for applying Effect SQL migrations to ClickHouse 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 ClickHouse `SqlClient`. It is typically used during application
+ * startup, deployment, or integration tests that need to prepare analytical
+ * tables before dependent services begin reading or writing data.
+ *
+ * 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. ClickHouse schema changes often depend
+ * on engine, `ORDER BY`, database, and cluster settings, and many deployments
+ * rely on explicit `ON CLUSTER` clauses or coordinated rollout tooling. This
+ * adapter does not add a ClickHouse-specific table lock or schema dumper, so
+ * coordinate concurrent migrators and do not expect `schemaDirectory` to emit a
+ * ClickHouse schema snapshot.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseMigrator from "./ClickhouseMigrator.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,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA"}

package/dist/index.js

@@ -3,10 +3,47 @@
  */
 // @barrel: Auto-generated exports. Do not edit manually.
 /**
+ * ClickHouse client implementation for Effect SQL, backed by
+ * `@clickhouse/client`.
+ *
+ * This module exposes constructors and layers for providing both the
+ * ClickHouse-specific `ClickhouseClient` service and the generic `SqlClient`
+ * service. It is intended for analytical application queries, migrations,
+ * background jobs, bulk inserts, and streaming reads that need Effect SQL query
+ * compilation, scoped lifecycle management, interruption, and consistent
+ * `SqlError` classification for ClickHouse failures.
+ *
+ * The client uses the ClickHouse HTTP client APIs for `query`, `command`, and
+ * `insert` operations. Regular queries read JSON result sets, `executeValues`
+ * requests `JSONCompact`, streams request `JSONEachRow`, and `insertQuery`
+ * defaults inserts to `JSONEachRow`. Interrupting an operation aborts the
+ * underlying HTTP request and attempts to kill the generated or supplied
+ * `query_id`. The statement compiler emits ClickHouse typed placeholders such
+ * as `{p1: Type}`; use `param` when the inferred type is too broad, and write
+ * ClickHouse-specific clauses such as engines, `SETTINGS`, `FORMAT`, or
+ * cluster directives explicitly.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseClient from "./ClickhouseClient.js";
 /**
+ * Utilities for applying Effect SQL migrations to ClickHouse 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 ClickHouse `SqlClient`. It is typically used during application
+ * startup, deployment, or integration tests that need to prepare analytical
+ * tables before dependent services begin reading or writing data.
+ *
+ * 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. ClickHouse schema changes often depend
+ * on engine, `ORDER BY`, database, and cluster settings, and many deployments
+ * rely on explicit `ON CLUSTER` clauses or coordinated rollout tooling. This
+ * adapter does not add a ClickHouse-specific table lock or schema dumper, so
+ * coordinate concurrent migrators and do not expect `schemaDirectory` to emit a
+ * ClickHouse schema snapshot.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseMigrator from "./ClickhouseMigrator.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["ClickhouseClient","ClickhouseMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;AAGA,OAAO,KAAKA,gBAAgB,MAAM,uBAAuB;AAEzD;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["ClickhouseClient","ClickhouseMigrator"],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,KAAKA,gBAAgB,MAAM,uBAAuB;AAEzD;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/sql-clickhouse",
-  "version": "4.0.0-beta.67",
+  "version": "4.0.0-beta.68",
   "type": "module",
   "license": "MIT",
   "description": "A Clickhouse toolkit for Effect",
@@ -43,12 +43,12 @@
     "provenance": true
   },
   "devDependencies": {
-    "effect": "^4.0.0-beta.67",
-    "@effect/platform-node": "^4.0.0-beta.67"
+    "@effect/platform-node": "^4.0.0-beta.68",
+    "effect": "^4.0.0-beta.68"
   },
   "peerDependencies": {
-    "@effect/platform-node": "^4.0.0-beta.67",
-    "effect": "^4.0.0-beta.67"
+    "@effect/platform-node": "^4.0.0-beta.68",
+    "effect": "^4.0.0-beta.68"
   },
   "dependencies": {
     "@clickhouse/client": "^1.18.4"

package/src/ClickhouseClient.ts

@@ -96,7 +96,7 @@ const classifyError = (
 /**
  * Unique runtime identifier used to tag `ClickhouseClient` values.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~@effect/sql-clickhouse/ClickhouseClient"
@@ -104,7 +104,7 @@ export const TypeId: TypeId = "~@effect/sql-clickhouse/ClickhouseClient"
 /**
  * Type-level literal for the `ClickhouseClient` runtime identifier.
  *
- * @category type ids
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~@effect/sql-clickhouse/ClickhouseClient"
@@ -402,7 +402,7 @@ export const make = (
  * Fiber reference read by the low-level ClickHouse connection to choose query
  * or command execution for statements; defaults to `query`.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const ClientMethod = Context.Reference<"query" | "command" | "insert">(
@@ -416,7 +416,7 @@ export const ClientMethod = Context.Reference<"query" | "command" | "insert">(
  * Fiber reference for the ClickHouse `query_id` applied to queries and
  * inserts; a random UUID is generated when no query ID is set.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const QueryId = Context.Reference<string | undefined>(
@@ -428,7 +428,7 @@ export const QueryId = Context.Reference<string | undefined>(
  * Fiber reference containing ClickHouse settings to attach to queries,
  * commands, and inserts.
  *
- * @category References
+ * @category references
  * @since 4.0.0
  */
 export const ClickhouseSettings: Context.Reference<

package/src/ClickhouseMigrator.ts

@@ -33,7 +33,7 @@ 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 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.
 
 /**
+ * ClickHouse client implementation for Effect SQL, backed by
+ * `@clickhouse/client`.
+ *
+ * This module exposes constructors and layers for providing both the
+ * ClickHouse-specific `ClickhouseClient` service and the generic `SqlClient`
+ * service. It is intended for analytical application queries, migrations,
+ * background jobs, bulk inserts, and streaming reads that need Effect SQL query
+ * compilation, scoped lifecycle management, interruption, and consistent
+ * `SqlError` classification for ClickHouse failures.
+ *
+ * The client uses the ClickHouse HTTP client APIs for `query`, `command`, and
+ * `insert` operations. Regular queries read JSON result sets, `executeValues`
+ * requests `JSONCompact`, streams request `JSONEachRow`, and `insertQuery`
+ * defaults inserts to `JSONEachRow`. Interrupting an operation aborts the
+ * underlying HTTP request and attempts to kill the generated or supplied
+ * `query_id`. The statement compiler emits ClickHouse typed placeholders such
+ * as `{p1: Type}`; use `param` when the inferred type is too broad, and write
+ * ClickHouse-specific clauses such as engines, `SETTINGS`, `FORMAT`, or
+ * cluster directives explicitly.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseClient from "./ClickhouseClient.ts"
 
 /**
+ * Utilities for applying Effect SQL migrations to ClickHouse 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 ClickHouse `SqlClient`. It is typically used during application
+ * startup, deployment, or integration tests that need to prepare analytical
+ * tables before dependent services begin reading or writing data.
+ *
+ * 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. ClickHouse schema changes often depend
+ * on engine, `ORDER BY`, database, and cluster settings, and many deployments
+ * rely on explicit `ON CLUSTER` clauses or coordinated rollout tooling. This
+ * adapter does not add a ClickHouse-specific table lock or schema dumper, so
+ * coordinate concurrent migrators and do not expect `schemaDirectory` to emit a
+ * ClickHouse schema snapshot.
+ *
  * @since 4.0.0
  */
 export * as ClickhouseMigrator from "./ClickhouseMigrator.ts"