feat: bulk inserts/upserts w/ column defaults

Author: soedirgo

src/PostgrestQueryBuilder.ts

@@ -113,24 +113,31 @@ export default class PostgrestQueryBuilder<
    *
    * `"estimated"`: Uses exact count for low numbers and planned count for high
    * numbers.
+   *
+   * @param options.defaultToNull - Make missing fields default to `null`.
+   * Otherwise, use the default value for the column.
    */
   insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row | Row[],
     {
       count,
+      defaultToNull = true,
     }: {
       count?: 'exact' | 'planned' | 'estimated'
+      defaultToNull?: boolean
     } = {}
   ): PostgrestFilterBuilder<Schema, Relation['Row'], null> {
     const method = 'POST'
 
     const prefersHeaders = []
-    const body = values
+    if (this.headers['Prefer']) {
+      prefersHeaders.push(this.headers['Prefer'])
+    }
     if (count) {
       prefersHeaders.push(`count=${count}`)
     }
-    if (this.headers['Prefer']) {
-      prefersHeaders.unshift(this.headers['Prefer'])
+    if (!defaultToNull) {
+      prefersHeaders.push('missing=default')
     }
     this.headers['Prefer'] = prefersHeaders.join(',')
 
@@ -147,7 +154,7 @@ export default class PostgrestQueryBuilder<
       url: this.url,
       headers: this.headers,
       schema: this.schema,
-      body,
+      body: values,
       fetch: this.fetch,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<null>)
@@ -185,30 +192,37 @@ export default class PostgrestQueryBuilder<
    *
    * `"estimated"`: Uses exact count for low numbers and planned count for high
    * numbers.
+   *
+   * @param options.defaultToNull - Make missing fields default to `null`.
+   * Otherwise, use the default value for the column.
    */
   upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
     values: Row | Row[],
     {
       onConflict,
       ignoreDuplicates = false,
       count,
+      defaultToNull = true,
     }: {
       onConflict?: string
       ignoreDuplicates?: boolean
       count?: 'exact' | 'planned' | 'estimated'
+      defaultToNull?: boolean
     } = {}
   ): PostgrestFilterBuilder<Schema, Relation['Row'], null> {
     const method = 'POST'
 
     const prefersHeaders = [`resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`]
 
     if (onConflict !== undefined) this.url.searchParams.set('on_conflict', onConflict)
-    const body = values
+    if (this.headers['Prefer']) {
+      prefersHeaders.push(this.headers['Prefer'])
+    }
     if (count) {
       prefersHeaders.push(`count=${count}`)
     }
-    if (this.headers['Prefer']) {
-      prefersHeaders.unshift(this.headers['Prefer'])
+    if (!defaultToNull) {
+      prefersHeaders.push('missing=default')
     }
     this.headers['Prefer'] = prefersHeaders.join(',')
 
@@ -217,7 +231,7 @@ export default class PostgrestQueryBuilder<
       url: this.url,
       headers: this.headers,
       schema: this.schema,
-      body,
+      body: values,
       fetch: this.fetch,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<null>)
@@ -254,21 +268,20 @@ export default class PostgrestQueryBuilder<
   ): PostgrestFilterBuilder<Schema, Relation['Row'], null> {
     const method = 'PATCH'
     const prefersHeaders = []
-    const body = values
+    if (this.headers['Prefer']) {
+      prefersHeaders.push(this.headers['Prefer'])
+    }
     if (count) {
       prefersHeaders.push(`count=${count}`)
     }
-    if (this.headers['Prefer']) {
-      prefersHeaders.unshift(this.headers['Prefer'])
-    }
     this.headers['Prefer'] = prefersHeaders.join(',')
 
     return new PostgrestFilterBuilder({
       method,
       url: this.url,
       headers: this.headers,
       schema: this.schema,
-      body,
+      body: values,
       fetch: this.fetch,
       allowEmpty: false,
     } as unknown as PostgrestBuilder<null>)

test/basic.ts

@@ -1078,6 +1078,24 @@ describe("insert, update, delete with count: 'exact'", () => {
     `)
   })
 
+  test('bulk insert with column defaults', async () => {
+    let res = await postgrest
+      .from('channels')
+      .insert([{ id: 100 }, { slug: 'test-slug' }], { defaultToNull: false })
+      .select()
+      .rollback()
+    expect(res).toMatchInlineSnapshot()
+  })
+
+  test('bulk upsert with column defaults', async () => {
+    let res = await postgrest
+      .from('channels')
+      .upsert([{ id: 1 }, { slug: 'test-slug' }], { defaultToNull: false })
+      .select()
+      .rollback()
+    expect(res).toMatchInlineSnapshot()
+  })
+
   test("update with count: 'exact'", async () => {
     let res = await postgrest
       .from('messages')