Support Joins and Using syntax for PostgreSQL Delete Statement (#4591)

lib/dialects/postgres/query/pg-querycompiler.js

@@ -57,9 +57,44 @@ class QueryCompiler_PG extends QueryCompiler {
     };
   }
 
-  // Compiles an `update` query, allowing for a return value.
+  using() {
+    const usingTables = this.single.using;
+    if (!usingTables) return;
+    let sql = 'using ';
+    if (Array.isArray(usingTables)) {
+      sql += usingTables
+        .map((table) => {
+          return this.formatter.wrap(table);
+        })
+        .join(',');
+    } else {
+      sql += this.formatter.wrap(usingTables);
+    }
+    return sql;
+  }
+
+  // Compiles an `delete` query, allowing for a return value.
   del() {
-    const sql = super.del(...arguments);
+    // Make sure tableName is processed by the formatter first.
+    const { tableName } = this;
+    const withSQL = this.with();
+    const wheres = this.where();
+    // Joins in PG with delete it's not valid, we throw an error and ask to use 'using'
+    if (this.join().length > 0) {
+      throw new Error(
+        "Joins with delete query isn't valid in PostgreSQL, use 'using' with 'where' functions instead."
+      );
+    }
+    const using = this.using();
+    // When using the clause 'using' we delete the "from" table name (like joins)
+    const deleteSelector = using ? tableName + ' ' : '';
+    const sql =
+      withSQL +
+      `delete ${deleteSelector}from ${
+        this.single.only ? 'only ' : ''
+      }${tableName}` +
+      (using ? ` ${using}` : '') +
+      (wheres ? ` ${wheres}` : '');
     const { returning } = this.single;
     return {
       sql: sql + this._returning(returning),

lib/query/querybuilder.js

@@ -269,6 +269,11 @@ class Builder extends EventEmitter {
     return this;
   }
 
+  using(tables) {
+    this._single.using = tables;
+    return this;
+  }
+
   // JOIN blocks:
   innerJoin(...args) {
     return this._joinType('inner').join(...args);

test/unit/query/builder.js

@@ -10161,6 +10161,53 @@ describe('QueryBuilder', () => {
   });
 
   it('should include join when deleting', () => {
+    // We except error in PG because delete with joins is not possible.
+    expect(() => {
+      testquery(
+        qb()
+          .del()
+          .from('users')
+          .join('photos', 'photos.id', 'users.id')
+          .where({ 'user.email': 'mock@example.com' }),
+        {
+          pg: '',
+        }
+      );
+    }).to.throw(Error);
+
+    testsql(
+      qb()
+        .del()
+        .from('users')
+        .using('photos')
+        .where({ 'user.email': 'mock@example.com', 'photos.id': 'users.id' }),
+      {
+        pg: {
+          sql: 'delete "users" from "users" using "photos" where "user"."email" = ? and "photos"."id" = ?',
+          bindings: ['mock@example.com', 'users.id'],
+        },
+      }
+    );
+
+    // Test with multiple tables 'using'
+    testsql(
+      qb()
+        .del()
+        .from('users')
+        .using(['photos', 'docs'])
+        .where({
+          'user.email': 'mock@example.com',
+          'photos.id': 'users.id',
+          'docs.id': 'users.id',
+        }),
+      {
+        pg: {
+          sql: 'delete "users" from "users" using "photos","docs" where "user"."email" = ? and "photos"."id" = ? and "docs"."id" = ?',
+          bindings: ['mock@example.com', 'users.id', 'users.id'],
+        },
+      }
+    );
+
     testsql(
       qb()
         .del()
@@ -10180,10 +10227,6 @@ describe('QueryBuilder', () => {
           sql: 'delete "users" from "users" inner join "photos" on "photos"."id" = "users"."id" where "user"."email" = ?',
           bindings: ['mock@example.com'],
         },
-        pg: {
-          sql: 'delete "users" from "users" inner join "photos" on "photos"."id" = "users"."id" where "user"."email" = ?',
-          bindings: ['mock@example.com'],
-        },
         'pg-redshift': {
           sql: 'delete "users" from "users" inner join "photos" on "photos"."id" = "users"."id" where "user"."email" = ?',
           bindings: ['mock@example.com'],

types/index.d.ts

@@ -482,7 +482,7 @@ export declare namespace Knex {
   //
   // QueryInterface
   //
-  type ClearStatements = "with" | "select" | "columns" | "hintComments" | "where" | "union" | "join" | "group" | "order" | "having" | "limit" | "offset" | "counter" | "counters";
+  type ClearStatements = "with" | "select" | "columns" | "hintComments" | "where" | "union" | "using" | "join" | "group" | "order" | "having" | "limit" | "offset" | "counter" | "counters";
 
   interface QueryInterface<TRecord extends {} = any, TResult = any> {
     select: Select<TRecord, TResult>;
@@ -509,6 +509,9 @@ export declare namespace Knex {
     fullOuterJoin: Join<TRecord, TResult>;
     crossJoin: Join<TRecord, TResult>;
 
+    // Using
+    using: Using<TRecord, TResult>;
+
     // Withs
     with: With<TRecord, TResult>;
     withRecursive: With<TRecord, TResult>;
@@ -1338,6 +1341,10 @@ export declare namespace Knex {
     >;
   }
 
+  interface Using<TRecord = any, TResult = unknown[]> {
+    (tables: string[]): QueryBuilder<TRecord, TResult>;
+  }
+
   interface With<TRecord = any, TResult = unknown[]>
     extends WithRaw<TRecord, TResult>,
     WithWrapped<TRecord, TResult> {}