BulkInsertQuery.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Database\Query;
 
use Doctrine\DBAL\Connection;
 
class ‪BulkInsertQuery
{
    protected ‪$columns;
 
    protected ‪$connection;
 
    protected ‪$table;
 
    protected ‪$parameters = [];
 
    protected ‪$types = [];
 
    protected ‪$values = [];
 
    public function ‪__construct(‪Connection ‪$connection, string ‪$table, array ‪$columns = [])
    {
        $this->connection = ‪$connection;
        $this->table = ‪$connection->‪quoteIdentifier(‪$table);
        $this->columns = ‪$columns;
    }
 
    public function ‪__toString(): string
    {
        return $this->‪getSQL();
    }
 
    public function ‪addValues(array ‪$values, array ‪$types = [])
    {
        $valueSet = [];
 
        if (empty($this->columns)) {
            foreach (‪$values as $index => $value) {
                $this->parameters[] = $value;
                $this->types[] = ‪$types[$index] ?? null;
                $valueSet[] = '?';
            }
 
            $this->values[] = $valueSet;
 
            return;
        }
 
        foreach ($this->columns as $index => $column) {
            $namedValue = isset(‪$values[$column]) || array_key_exists($column, ‪$values);
            $positionalValue = isset(‪$values[$index]) || array_key_exists($index, ‪$values);
 
            if (!$namedValue && !$positionalValue) {
                throw new \InvalidArgumentException(
                    sprintf('No value specified for column %s (index %d).', $column, $index),
                    1476049651
                );
            }
 
            if ($namedValue && $positionalValue && ‪$values[$column] !== ‪$values[$index]) {
                throw new \InvalidArgumentException(
                    sprintf('Multiple values specified for column %s (index %d).', $column, $index),
                    1476049652
                );
            }
 
            $this->parameters[] = $namedValue ? ‪$values[$column] : ‪$values[$index];
            $valueSet[] = '?';
 
            $namedType = isset(‪$types[$column]);
            $positionalType = isset(‪$types[$index]);
 
            if ($namedType && $positionalType && ‪$types[$column] !== ‪$types[$index]) {
                throw new \InvalidArgumentException(
                    sprintf('Multiple types specified for column %s (index %d).', $column, $index),
                    1476049653
                );
            }
 
            if ($namedType) {
                $this->types[] = ‪$types[$column];
 
                continue;
            }
 
            if ($positionalType) {
                $this->types[] = ‪$types[$index];
 
                continue;
            }
 
            $this->types[] = null;
        }
 
        $this->values[] = $valueSet;
    }
 
    public function ‪execute(): int
    {
        $platform = $this->connection->getDatabasePlatform();
        $insertMaxRows = $this->‪getInsertMaxRows();
 
        if ($insertMaxRows > 0 && count($this->values) > $insertMaxRows) {
            throw new \LogicException(
                sprintf(
                    'You can only insert %d rows in a single INSERT statement with platform "%s".',
                    $insertMaxRows,
                    $platform->getName()
                ),
                1476049654
            );
        }
 
        return $this->connection->executeUpdate($this->‪getSQL(), $this->parameters, $this->types);
    }
 
    protected function ‪getInsertMaxRows(): int
    {
        $platform = $this->connection->getDatabasePlatform();
        if ($platform->getName() === 'mssql' && $platform->getReservedKeywordsList()->isKeyword('MERGE')) {
            return 1000;
        }
 
        return 0;
    }
 
    public function ‪getParameters(): array
    {
        return ‪$this->parameters;
    }
 
    public function ‪getParameterTypes(): array
    {
        return ‪$this->types;
    }
 
    public function ‪getSQL(): string
    {
        if (empty($this->values)) {
            throw new \LogicException(
                'You need to add at least one set of values before generating the SQL.',
                1476049702
            );
        }
 
        ‪$connection = ‪$this->connection;
        $columnList = '';
 
        if (!empty($this->columns)) {
            $columnList = sprintf(
                ' (%s)',
                implode(
                    ', ',
                    array_map(
                        function ($column) use (‪$connection) {
                            return ‪$connection->‪quoteIdentifier($column);
                        },
                        ‪$this->columns
                    )
                )
            );
        }
 
        return sprintf(
            'INSERT INTO %s%s VALUES (%s)',
            $this->table,
            $columnList,
            implode(
                '), (',
                array_map(
                    function (array $valueSet) {
                        return implode(', ', $valueSet);
                    },
                    ‪$this->values
                )
            )
        );
    }
}