Added Documentation

Author: sclubricants

system/Database/BaseBuilder.php

@@ -2657,7 +2657,7 @@ public function delete($where = '', ?int $limit = null, bool $resetData = true)
      * Sets data and calls batchExecute to run queries
      *
      * @param array|object|null        $set         a dataset or select query
-     * @param array|RawSql|string|null $constraints
+     * @param array|RawSql|null $constraints
      *
      * @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
      */

user_guide_src/source/changelogs/v4.3.0.rst

@@ -159,6 +159,7 @@ Query Builder
 - Improved the SQL structure for ``Builder::updateBatch()``. See :ref:`update-batch` for the details.
 - Added ``when()`` and ``whenNot()`` methods to conditionally add clauses to the query. See :ref:`BaseBuilder::when() <db-builder-when>` for details.
 - Added ``upsert()`` and ``upsertBatch()`` methods to QueryBuilder. See :ref:`upsert-data`.
+- Added ``deleteBatch()`` methods to QueryBuilder. See :ref:`delete-batch`.
 
 Forge
 -----

user_guide_src/source/database/query_builder.rst

@@ -1107,6 +1107,17 @@ the data to the first parameter of the method:
 If you want to delete all data from a table, you can use the ``truncate()``
 method, or ``emptyTable()``.
 
+.. _delete-batch:
+
+$builder->deleteBatch()
+------------------
+
+Generates a batch **DELETE** statement based on a set of data.
+
+.. literalinclude:: query_builder/118.php
+
+This method may be especially useful when deleting data in a table with a composite primary key.
+
 $builder->emptyTable()
 ----------------------
 
@@ -1882,6 +1893,16 @@ Class Reference
 
         Compiles and executes a ``DELETE`` query.
 
+    .. php:method:: deleteBatch([$set = null[, $constraints = null[, $batchSize = 100]]])
+
+        :param array|object|null $set: Field name, or an associative array of field/value pairs
+        :param array|RawSql|string|null $constraints: The field or fields used as keys to delete on.
+        :param int $batchSize: Count of conditions to group in a single query
+        :returns:   Number of rows deleted or ``false`` on failure
+        :rtype:     int|false
+
+        Compiles and executes batch ``DELETE`` query.
+
     .. php:method:: increment($column[, $value = 1])
 
         :param string $column: The name of the column to increment

user_guide_src/source/database/query_builder/118.php

@@ -0,0 +1,43 @@
+<?php
+
+$data = [
+    [
+        'order' => 48372,
+        'line'    => 3,
+        'product' => 'Keyboard',
+        'qty'     => 1,
+    ],
+    [
+        'order' => 48372,
+        'line'    => 4,
+        'product' => 'Mouse',
+        'qty'     => 1,
+    ],
+    [
+        'order' => 48372,
+        'line'    => 5,
+        'product' => 'Monitor',
+        'qty'     => 2,
+    ],
+];
+
+$builder->setAlias('del')->where('order_line.qty >', 1)->deleteBatch($data, 'order, line');
+
+// OR
+$builder
+    ->setData($data, true, 'del')
+    ->onConstraint('order, line')
+    ->where('order_line.qty >', 1)
+    ->deleteBatch();
+
+/*
+ * MySQL Produces:
+ * DELETE `order_line` FROM `order_line`
+ * INNER JOIN (
+ * SELECT 48372 `order`, 3 `line`, 'Keyboard' `product`, 1 `qty` UNION ALL
+ * SELECT 48372 `order`, 4 `line`, 'Mouse'    `product`, 1 `qty` UNION ALL
+ * SELECT 48372 `order`, 5 `line`, 'Monitor'  `product`, 2 `qty`
+ * ) `del`
+ * ON `order_line`.`order` = `del`.`order` AND `order_line`.`line` = `del`.`line`
+ * WHERE `order_line`.`qty` > 1
+ */