[QueryBuilder] The combination of the setUpdateBatch() and the updateBatch() is difficult to use.

[ytetsuro]

The combination of the setUpdateBatch method and the updateBatch method is difficult to use.

If you try to use it, it will look like the following.

$builder->setUpdateBatch([
    [
        'id'          => 2,
        'name'        => 'SUBSTRING(name, 1)',
        'description' => 'SUBSTRING(description, 3)',
    ],
    [
        'id'          => 3,
        'name'        => 'SUBSTRING(name, 2)',
        'description' => 'SUBSTRING(description, 4)',
    ],
], 'id', false);

$builder->updateBatch(null, 'id', 100);

1. updateBatch method hasn't escape argument.
2. We have specified index as the second argument of the setUpdateBatch method, but we need to specify the same value for the second argument of updateBatch.
3. In combination with 2, when using setUpdateBatch, you need to specify null as the first argument of the updateBatch method. It is difficult for a client to write such a code without knowing the implementation.

In my opinion, it would be easier for developers to use if they can write the following.

$builder->updateBatch([
    [
        'id'          => 2,
        'name'        => 'SUBSTRING(name, 1)',
        'description' => 'SUBSTRING(description, 3)',
    ],
    [
        'id'          => 3,
        'name'        => 'SUBSTRING(name, 2)',
        'description' => 'SUBSTRING(description, 4)',
    ],
], 'id', false, 100);

or

 $builder->setUpdateBatch([
    [
        'id'          => 2,
        'name'        => 'SUBSTRING(name, 1)',
        'description' => 'SUBSTRING(description, 3)',
    ],
    [
        'id'          => 3,
        'name'        => 'SUBSTRING(name, 2)',
        'description' => 'SUBSTRING(description, 4)',
    ],
], 'id', false);

$builder->updateBatch(100);

What do you think?

[kenjis]

In both cases, it is a breaking change in the public API of updateBatch().

[ytetsuro]

Thanks, response.
You are right.

[ytetsuro]

@kenjis

I was wondering if the following code could be implemented without adding breaking change if the user has called setUpdateBatch at least once.

The concrete method is to change the behavior of updateBatch when the following conditions are met.

• Only the first argument of updateBatch is specified.
• A number is passed as the first argument of updateBatch.
• QBSet is not empty.

 $builder->setUpdateBatch([
    [
        'id'          => 2,
        'name'        => 'SUBSTRING(name, 1)',
        'description' => 'SUBSTRING(description, 3)',
    ],
    [
        'id'          => 3,
        'name'        => 'SUBSTRING(name, 2)',
        'description' => 'SUBSTRING(description, 4)',
    ],
], 'id', false);

$builder->updateBatch(100);

[kenjis]

@ytetsuro I think the API you propose is better. It is easy to use.

But unfortunately, the first param of updateBatch() is ?array.

CodeIgniter4/system/Database/BaseBuilder.php

Line 1935 in 4576b12

public function updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100)

If you change it to accept int, it is breaking change.
https://3v4l.org/oIIBP

[kenjis]

You could write code like this on PHP8:

$builder->updateBatch(batchSize: 100);

https://www.php.net/manual/en/functions.arguments.php#functions.named-arguments

[kenjis]

Or how about this?

$builder->setUpdateBatch([
    [
        'id'          => 2,
        'name'        => 'SUBSTRING(name, 1)',
        'description' => 'SUBSTRING(description, 3)',
    ],
    [
        'id'          => 3,
        'name'        => 'SUBSTRING(name, 2)',
        'description' => 'SUBSTRING(description, 4)',
    ],
], 'id', false);

$builder->setBatchSize(100);
$builder->updateBatch();

[ytetsuro]

@kenjis

Thanks, response.

If you change it to accept int, it is breaking change.

Sure!
I'm sorry.😞

You could write code like this on PHP8:

Oh! You are great!
This is very readable.

Or how about this?

Thanks.
I think very very well.😍
I will make this PR.