Add BaseBuilder::deleteBatch()

[sclubricants]

Needs #6741

The *Batch() saga continues..

This adds deleteBatch() to Builder. This allows using a set of data to selectively delete items from a table.

$data = [
    ['userid' => 1, 'username' => 'Derek Does Not Match', 'unused' => 'You can have fields you dont use'],
    ['userid' => 2, 'username' => 'Ahmadinejad', 'unused' => 'You can have fields you dont use'],
];

$this->db->table('user')
    ->setData($data)
    ->onConstraint(['id' => 'userid', 'name' => 'username'])
    ->deleteBatch();

$this->seeInDatabase('user', ['email' => '[email protected]', 'name' => 'Derek Jones']);

$this->dontSeeInDatabase('user', ['email' => '[email protected]', 'name' => 'Ahmadinejad']);

You can also use where() for additional conditions except with SQLite.

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[sclubricants]

One thing that this PR does is allow to delete a set of data with a composite primary key.

$orderLineItems = [
    ['order' => 48321, 'line' => 3, 'product' => '500G Hardrive',    'qty' => 1, 'price' => 149.99],
    ['order' => 48321, 'line' => 5, 'product' => '32G DDR4 Ram',     'qty' => 2, 'price' => 284.75],
    ['order' => 48321, 'line' => 6, 'product' => 'English Keyboard', 'qty' => 1, 'price' =>  49.87],
];

$this->db->table('order_line_items')
         ->setData($orderLineItems)
         ->onConstraint('order, line')
         ->deleteBatch();

[sclubricants]

If we can merge #6689 then I will also add delete from query.

[sclubricants]

Or we could merge this first and add delete from query to #6689

[kenjis]

This is just an English question.
What do you mean by sudo or sudo table ?

CodeIgniter4/system/Database/BaseBuilder.php

Lines 1971 to 1974 in 0fff1c9

	/**
	* Set table alias for dataset sudo table.
	*/
	public function setAlias(string $alias): BaseBuilder

[kenjis]

You can also use where() for additional conditions except with SQLite.

Please add a note in the user guide.

[sclubricants]

What do you mean by sudo or sudo table ?

I spelled it wrong, it should be pseudo.

I mean that when you have:

(
    SELECT 1 id, 'Jason' name UNION ALL
    SELECT 2 id, 'Todd'  name
) AS pseudo_table

You are creating a table in SQL. This snippet of code can be dropped anywhere a table name can go. By itself though it is not a valid query. You can query this pseudo table just like any other table.. you can join this table like any other table. Its a pseudo table because the table as aliased doesn't really exist as a table in the schema but is generated on the fly.

SELECT pseudo_table.name
FROM
(
    SELECT 1 id, 'Jason' name UNION ALL
    SELECT 2 id, 'Todd'  name
) AS pseudo_table
WHERE pseudo_table.id = 1

# Here is with a real table
SELECT pseudo_table.name
FROM pseudo_table
WHERE pseudo_table.id = 1

pseudo-

prefix: pseudo-; prefix: pseud-
1. supposed or purporting to be but not really so; false; not genuine.
2. resembling or imitating.

https://en.wikipedia.org/wiki/Pseudo-

[kenjis]

I spelled it wrong, it should be pseudo.

Ah, it's pronounced the same.
I got it!

[michalsn]

I would like to ask you to check one thing, but other than that, I think this is ready.

[sclubricants]

I would like to ask you to check one thing, but other than that, I think this is ready.

This PR is pretty strait forward I think. This mostly falls in the footprint of the other *Batch() methods. I don't think there are any major controversies to discuss here are there? I know for me this would be very helpful as most of my database has composite primary keys. I think the order line item is a good example of where this is useful.

@kenjis what do you think? Any chance of getting this committed before 4.3?

[kenjis]

I would like to include this in v4.3.0.
I will see this today or tomorrow.

[MGatner]

Great news! Let me know how I can help.

[kenjis]

I have made some minor comments, but overall it looks good.

Also, the base is a bit old, so please rebase.