Add configuration options to the PgDrizzle layer (#4759)

Author: jrmdayn

.changeset/sharp-mirrors-vanish.md

@@ -0,0 +1,5 @@
+---
+"@effect/sql-drizzle": minor
+---
+
+Export `layerWithConfig` method to build a layer with some Drizzle config

packages/sql-drizzle/package.json

@@ -59,12 +59,12 @@
     "@effect/sql-sqlite-node": "workspace:^",
     "@testcontainers/mysql": "^10.18.0",
     "@testcontainers/postgresql": "^10.18.0",
-    "drizzle-orm": "^0.31.0",
+    "drizzle-orm": "^0.42.0",
     "effect": "workspace:^"
   },
   "peerDependencies": {
     "@effect/sql": "workspace:^",
-    "drizzle-orm": "^0.31",
+    "drizzle-orm": "^0.42",
     "effect": "workspace:^"
   }
 }

packages/sql-drizzle/src/Mysql.ts

@@ -3,6 +3,7 @@
  */
 import * as Client from "@effect/sql/SqlClient"
 import type { SqlError } from "@effect/sql/SqlError"
+import type { DrizzleConfig } from "drizzle-orm"
 import { MySqlSelectBase } from "drizzle-orm/mysql-core"
 import type { MySqlRemoteDatabase } from "drizzle-orm/mysql-proxy"
 import { drizzle } from "drizzle-orm/mysql-proxy"
@@ -23,6 +24,20 @@ export const make: Effect.Effect<MySqlRemoteDatabase, never, Client.SqlClient> =
   return db
 })
 
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const makeWithConfig: (config: DrizzleConfig) => Effect.Effect<MySqlRemoteDatabase, never, Client.SqlClient> = (
+  config
+) =>
+  Effect.gen(function*() {
+    const client = yield* Client.SqlClient
+    const db = drizzle(yield* makeRemoteCallback, config)
+    registerDialect((db as any).dialect, client)
+    return db
+  })
+
 /**
  * @since 1.0.0
  * @category tags
@@ -38,6 +53,14 @@ export class MysqlDrizzle extends Context.Tag("@effect/sql-drizzle/Mysql")<
  */
 export const layer: Layer.Layer<MysqlDrizzle, never, Client.SqlClient> = Layer.effect(MysqlDrizzle, make)
 
+/**
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerWithConfig: (config: DrizzleConfig) => Layer.Layer<MysqlDrizzle, never, Client.SqlClient> = (
+  config
+) => Layer.effect(MysqlDrizzle, makeWithConfig(config))
+
 // patch
 
 declare module "drizzle-orm" {

packages/sql-drizzle/src/Pg.ts

@@ -3,6 +3,7 @@
  */
 import * as Client from "@effect/sql/SqlClient"
 import type { SqlError } from "@effect/sql/SqlError"
+import type { DrizzleConfig } from "drizzle-orm"
 import { PgSelectBase } from "drizzle-orm/pg-core"
 import { drizzle } from "drizzle-orm/pg-proxy"
 import type { PgRemoteDatabase } from "drizzle-orm/pg-proxy"
@@ -23,6 +24,20 @@ export const make: Effect.Effect<PgRemoteDatabase, never, Client.SqlClient> = Ef
   return db
 })
 
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const makeWithConfig: (config: DrizzleConfig) => Effect.Effect<PgRemoteDatabase, never, Client.SqlClient> = (
+  config
+) =>
+  Effect.gen(function*() {
+    const client = yield* Client.SqlClient
+    const db = drizzle(yield* makeRemoteCallback, config)
+    registerDialect((db as any).dialect, client)
+    return db
+  })
+
 /**
  * @since 1.0.0
  * @category tags
@@ -38,6 +53,13 @@ export class PgDrizzle extends Context.Tag("@effect/sql-drizzle/Pg")<
  */
 export const layer: Layer.Layer<PgDrizzle, never, Client.SqlClient> = Layer.effect(PgDrizzle, make)
 
+/**
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerWithConfig: (config: DrizzleConfig) => Layer.Layer<PgDrizzle, never, Client.SqlClient> = (config) =>
+  Layer.effect(PgDrizzle, makeWithConfig(config))
+
 // patch
 
 declare module "drizzle-orm" {

packages/sql-drizzle/src/Sqlite.ts

@@ -3,6 +3,7 @@
  */
 import * as Client from "@effect/sql/SqlClient"
 import type { SqlError } from "@effect/sql/SqlError"
+import type { DrizzleConfig } from "drizzle-orm"
 import { QueryPromise } from "drizzle-orm/query-promise"
 import { SQLiteSelectBase } from "drizzle-orm/sqlite-core"
 import type { SqliteRemoteDatabase } from "drizzle-orm/sqlite-proxy"
@@ -24,6 +25,20 @@ export const make: Effect.Effect<SqliteRemoteDatabase, never, Client.SqlClient |
   return db
 })
 
+/**
+ * @since 1.0.0
+ * @category constructors
+ */
+export const makeWithConfig: (config: DrizzleConfig) => Effect.Effect<SqliteRemoteDatabase, never, Client.SqlClient> = (
+  config
+) =>
+  Effect.gen(function*() {
+    const client = yield* Client.SqlClient
+    const db = drizzle(yield* makeRemoteCallback, config)
+    registerDialect((db as any).dialect, client)
+    return db
+  })
+
 /**
  * @since 1.0.0
  * @category tags
@@ -39,6 +54,14 @@ export class SqliteDrizzle extends Context.Tag("@effect/sql-drizzle/Sqlite")<
  */
 export const layer: Layer.Layer<SqliteDrizzle, never, Client.SqlClient> = Layer.scoped(SqliteDrizzle, make)
 
+/**
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerWithConfig: (config: DrizzleConfig) => Layer.Layer<SqliteDrizzle, never, Client.SqlClient> = (
+  config
+) => Layer.effect(SqliteDrizzle, makeWithConfig(config))
+
 // patch
 
 declare module "drizzle-orm" {

packages/sql-drizzle/src/internal/patch.ts

@@ -73,6 +73,8 @@ export const makeRemoteCallback = Effect.gen(function*() {
       : statement.withoutTransform
     if (method === "get") {
       effect = Effect.map(effect, (rows) => rows[0] ?? [])
+    } else if (method === "execute") {
+      effect = Effect.map(effect, (rows) => rows.length ? rows : [{}])
     }
     return runPromise(Effect.map(effect, (rows) => ({ rows })))
   }