support partial objects in sql helpers (#3460)

Effect-TS · Aug 15, 2024 · 4fabf75 · 4fabf75
1 parent a2aea87
commit 4fabf75
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/.changeset/smooth-hounds-travel.md b/.changeset/smooth-hounds-travel.md
@@ -0,0 +1,5 @@
+---
+"@effect/sql": patch
+---
+
+support partial objects in sql helpers
diff --git a/packages/sql/src/Statement.ts b/packages/sql/src/Statement.ts
@@ -177,7 +177,8 @@ export interface ArrayHelper {
  */
 export interface RecordInsertHelper {
   readonly _tag: "RecordInsertHelper"
-  readonly value: ReadonlyArray<Record<string, Primitive | Fragment>>
+  readonly value: ReadonlyArray<Record<string, Primitive | Fragment | undefined>>
+  /** @internal */
   readonly returningIdentifier: string | Fragment | undefined
   readonly returning: (sql: string | Identifier | Fragment) => RecordInsertHelper
 }
@@ -188,8 +189,9 @@ export interface RecordInsertHelper {
  */
 export interface RecordUpdateHelper {
   readonly _tag: "RecordUpdateHelper"
-  readonly value: ReadonlyArray<Record<string, Primitive | Fragment>>
+  readonly value: ReadonlyArray<Record<string, Primitive | Fragment | undefined>>
   readonly alias: string
+  /** @internal */
   readonly returningIdentifier: string | Fragment | undefined
   readonly returning: (sql: string | Identifier | Fragment) => RecordUpdateHelper
 }
@@ -200,8 +202,9 @@ export interface RecordUpdateHelper {
  */
 export interface RecordUpdateHelperSingle {
   readonly _tag: "RecordUpdateHelperSingle"
-  readonly value: Record<string, Primitive | Fragment>
+  readonly value: Record<string, Primitive | Fragment | undefined>
   readonly omit: ReadonlyArray<string>
+  /** @internal */
   readonly returningIdentifier: string | Fragment | undefined
   readonly returning: (sql: string | Identifier | Fragment) => RecordUpdateHelperSingle
 }
@@ -306,13 +309,13 @@ export interface Constructor {
 
   readonly insert: {
     (
-      value: ReadonlyArray<Record<string, Primitive | Fragment>>
+      value: ReadonlyArray<Record<string, Primitive | Fragment | undefined>>
     ): RecordInsertHelper
-    (value: Record<string, Primitive | Fragment>): RecordInsertHelper
+    (value: Record<string, Primitive | Fragment | undefined>): RecordInsertHelper
   }
 
   /** Update a single row */
-  readonly update: <A extends Record<string, Primitive | Fragment>>(
+  readonly update: <A extends Record<string, Primitive | Fragment | undefined>>(
     value: A,
     omit?: ReadonlyArray<keyof A>
   ) => RecordUpdateHelperSingle
@@ -323,7 +326,7 @@ export interface Constructor {
    * **Note:** Not supported in sqlite
    */
   readonly updateValues: (
-    value: ReadonlyArray<Record<string, Primitive | Fragment>>,
+    value: ReadonlyArray<Record<string, Primitive | Fragment | undefined>>,
     alias: string
   ) => RecordUpdateHelper
 

diff --git a/packages/sql/src/internal/statement.ts b/packages/sql/src/internal/statement.ts
@@ -848,7 +848,7 @@ export const primitiveKind = (value: Statement.Primitive): Statement.PrimitiveKi
 }
 
 const extractPrimitive = (
-  value: Statement.Primitive | Statement.Fragment,
+  value: Statement.Primitive | Statement.Fragment | undefined,
   onCustom: (
     type: Statement.Custom<string, unknown, unknown>,
     placeholder: () => string,
@@ -857,7 +857,9 @@ const extractPrimitive = (
   placeholder: () => string,
   withoutTransform: boolean
 ): Statement.Primitive => {
-  if (isFragment(value)) {
+  if (value === undefined) {
+    return null
+  } else if (isFragment(value)) {
     const head = value.segments[0]
     if (head._tag === "Custom") {
       const compiled = onCustom(head, placeholder, withoutTransform)