DMLQueryBuilder::__construct() - Code Metrics - Inspection of "Fix of normalize for column names in insert, batch..." - yiisoft/db-mysql - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e8acbe...849330 )

by Def

created 2022-12-30 16:39 UTC

DMLQueryBuilder::__construct() A

↳ Parent: DMLQueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	6
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	3
crap	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Mysql;

use JsonException;
use Throwable;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Expression\Expression;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\QueryBuilder\DMLQueryBuilder as AbstractDMLQueryBuilder;
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
use Yiisoft\Db\Query\Query;
use Yiisoft\Db\Query\QueryInterface;
use Yiisoft\Db\Schema\QuoterInterface;
use Yiisoft\Db\Schema\SchemaInterface;

use function implode;
use function reset;

final class DMLQueryBuilder extends AbstractDMLQueryBuilder
{
    public function __construct(
        QueryBuilderInterface $queryBuilder,
        private QuoterInterface $quoter,
        private SchemaInterface $schema
    ) {
        parent::__construct($queryBuilder, $quoter, $schema);
    }

    /**
     * Creates a SQL statement for resetting the sequence value of a table's primary key.
     *
     * The sequence will be reset such that the primary key of the next new row inserted will have the specified value
     * or 1.
     *
     * @param string $tableName the name of the table whose primary key sequence will be reset.
     * @param int|string|null $value the value for the primary key of the next new row inserted. If this is not set, the
     * next new row's primary key will have a value 1.
     *
     * @throws Exception|InvalidArgumentException|Throwable
     *
     * @return string the SQL statement for resetting sequence.
     */
    public function resetSequence(string $tableName, int|string $value = null): string
    {
        $table = $this->schema->getTableSchema($tableName);

        if ($table === null) {
            throw new InvalidArgumentException("Table not found: '$tableName'.");
        }

        $sequenceName = $table->getSequenceName();
        if ($sequenceName === null) {
            throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.");
        }

        $tableName = $this->quoter->quoteTableName($tableName);

        if ($value !== null) {
            return 'ALTER TABLE ' . $tableName . ' AUTO_INCREMENT=' . $value . ';';
        }

        $pk = $table->getPrimaryKey();
        $key = (string) reset($pk);

        return "SET @new_autoincrement_value := (SELECT MAX(`$key`) + 1 FROM $tableName);
SET @sql = CONCAT('ALTER TABLE $tableName AUTO_INCREMENT =', @new_autoincrement_value);
PREPARE autoincrement_stmt FROM @sql;
EXECUTE autoincrement_stmt";
    }

    /**
     * Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique
     * constraints), or update them if they do.
     *
     * For example,
     *
     * ```php
     * $sql = $queryBuilder->upsert('pages', [
     *     'name' => 'Front page',
     *     'url' => 'http://example.com/', // url is unique
     *     'visits' => 0,
     * ], [
     *     'visits' => new Expression('visits + 1'),
     * ], $params);
     * ```
     *
     * The method will properly escape the table and column names.
     *
     * @param string $table the table that new rows will be inserted into/updated in.
     * @param array|QueryInterface $insertColumns the column data (name => value) to be inserted into the table or
     * instance of {@see Query} to perform `INSERT INTO ... SELECT` SQL statement.
     * @param array|bool $updateColumns the column data (name => value) to be updated if they already exist. If `true`
     * is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will
     * be performed if the column data already exists.
     * @param array $params the binding parameters that will be generated by this method. They should be bound to the DB
     * command later.
     *
     * @throws Exception|InvalidConfigException|JsonException|NotSupportedException if this is not supported by the
     * underlying DBMS.
     *
     * @return string the resulting SQL.
     */
    public function upsert(
        string $table,
        QueryInterface|array $insertColumns,
        bool|array $updateColumns,
        array &$params
    ): string {
        if (!$insertColumns instanceof QueryInterface) {

            $insertColumns = $this->normalizeColumnNames($table, $insertColumns);
        }

        if (!is_bool($updateColumns)) {

            $updateColumns = $this->normalizeColumnNames($table, $updateColumns);
        }

        $insertSql = $this->insert($table, $insertColumns, $params);

        /** @var array $uniqueNames */
        [$uniqueNames, , $updateNames] = $this->prepareUpsertColumns(
            $table,
            $insertColumns,
            $updateColumns,
        );

        if (empty($uniqueNames)) {
            return $insertSql;
        }

        if ($updateColumns === true) {

            $updateColumns = [];
            /** @var string $name */
            foreach ($updateNames as $name) {
                $updateColumns[$name] = new Expression(
                    'VALUES(' . $this->quoter->quoteColumnName($name) . ')'
                );
            }
        }

        if (empty($updateColumns)) {
            return str_replace('INSERT INTO', 'INSERT IGNORE INTO', $insertSql);
        }

        /**
         *  @psalm-var array<array-key, string> $updates
         *  @psalm-var array<string, ExpressionInterface|string> $updateColumns
         */
        [$updates, $params] = $this->prepareUpdateSets($table, $updateColumns, $params);

        return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates);
    }

    /**
     * Prepares a `VALUES` part for an `INSERT` SQL statement.
     *
     * @param string $table the table that new rows will be inserted into.
     * @param array|QueryInterface $columns the column data (name => value) to be inserted into the table or instance of
     * {@see Query|Query} to perform INSERT INTO ... SELECT SQL statement.
     * @param array $params the binding parameters that will be generated by this method. They should be bound to the DB
     * command later.
     *
     * @throws Exception|InvalidArgumentException|InvalidConfigException|JsonException|NotSupportedException
     *
     * @return array array of column names, placeholders, values and params.
     */
    protected function prepareInsertValues(string $table, QueryInterface|array $columns, array $params = []): array
    {
        /**
         * @var array $names
         * @var array $placeholders
         */
        [$names, $placeholders, $values, $params] = parent::prepareInsertValues($table, $columns, $params);

        if (!$columns instanceof QueryInterface && empty($names)) {

            $tableSchema = $this->schema->getTableSchema($table);

            if ($tableSchema !== null) {
                $columns = $tableSchema->getColumns();
                $columns = !empty($tableSchema->getPrimaryKey())
                    ? $tableSchema->getPrimaryKey() : [reset($columns)->getName()];
                foreach ($columns as $name) {
                    $names[] = $this->quoter->quoteColumnName($name);
                    $placeholders[] = 'DEFAULT';
                }
            }
        }

        return [$names, $placeholders, $values, $params];
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Db\Mysql;
6
7		use JsonException;
8		use Throwable;
9		use Yiisoft\Db\Exception\Exception;
10		use Yiisoft\Db\Exception\InvalidArgumentException;
11		use Yiisoft\Db\Exception\InvalidConfigException;
12		use Yiisoft\Db\Exception\NotSupportedException;
13		use Yiisoft\Db\Expression\Expression;
14		use Yiisoft\Db\Expression\ExpressionInterface;
15		use Yiisoft\Db\QueryBuilder\DMLQueryBuilder as AbstractDMLQueryBuilder;
16		use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
17		use Yiisoft\Db\Query\Query;
18		use Yiisoft\Db\Query\QueryInterface;
19		use Yiisoft\Db\Schema\QuoterInterface;
20		use Yiisoft\Db\Schema\SchemaInterface;
21
22		use function implode;
23		use function reset;
24
25		final class DMLQueryBuilder extends AbstractDMLQueryBuilder
26		{
27	484	public function __construct(
28		QueryBuilderInterface $queryBuilder,
29		private QuoterInterface $quoter,
30		private SchemaInterface $schema
31		) {
32	484	parent::__construct($queryBuilder, $quoter, $schema);
33		}
34
35		/**
36		* Creates a SQL statement for resetting the sequence value of a table's primary key.
37		*
38		* The sequence will be reset such that the primary key of the next new row inserted will have the specified value
39		* or 1.
40		*
41		* @param string $tableName the name of the table whose primary key sequence will be reset.
42		* @param int\|string\|null $value the value for the primary key of the next new row inserted. If this is not set, the
43		* next new row's primary key will have a value 1.
44		*
45		* @throws Exception\|InvalidArgumentException\|Throwable
46		*
47		* @return string the SQL statement for resetting sequence.
48		*/
49	3	public function resetSequence(string $tableName, int\|string $value = null): string
50		{
51	3	$table = $this->schema->getTableSchema($tableName);
52
53	3	if ($table === null) {
54	1	throw new InvalidArgumentException("Table not found: '$tableName'.");
55		}
56
57	2	$sequenceName = $table->getSequenceName();
58	2	if ($sequenceName === null) {
59	1	throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.");
60		}
61
62	1	$tableName = $this->quoter->quoteTableName($tableName);
63
64	1	if ($value !== null) {
65	1	return 'ALTER TABLE ' . $tableName . ' AUTO_INCREMENT=' . $value . ';';
66		}
67
68	1	$pk = $table->getPrimaryKey();
69	1	$key = (string) reset($pk);
70
71	1	return "SET @new_autoincrement_value := (SELECT MAX(`$key`) + 1 FROM $tableName);
72	1	SET @sql = CONCAT('ALTER TABLE $tableName AUTO_INCREMENT =', @new_autoincrement_value);
73		PREPARE autoincrement_stmt FROM @sql;
74	1	EXECUTE autoincrement_stmt";
75		}
76
77		/**
78		* Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique
79		* constraints), or update them if they do.
80		*
81		* For example,
82		*
83		* ```php
84		* $sql = $queryBuilder->upsert('pages', [
85		* 'name' => 'Front page',
86		* 'url' => 'http://example.com/', // url is unique
87		* 'visits' => 0,
88		* ], [
89		* 'visits' => new Expression('visits + 1'),
90		* ], $params);
91		* ```
92		*
93		* The method will properly escape the table and column names.
94		*
95		* @param string $table the table that new rows will be inserted into/updated in.
96		* @param array\|QueryInterface $insertColumns the column data (name => value) to be inserted into the table or
97		* instance of {@see Query} to perform `INSERT INTO ... SELECT` SQL statement.
98		* @param array\|bool $updateColumns the column data (name => value) to be updated if they already exist. If `true`
99		* is passed, the column data will be updated to match the insert column data. If `false` is passed, no update will
100		* be performed if the column data already exists.
101		* @param array $params the binding parameters that will be generated by this method. They should be bound to the DB
102		* command later.
103		*
104		* @throws Exception\|InvalidConfigException\|JsonException\|NotSupportedException if this is not supported by the
105		* underlying DBMS.
106		*
107		* @return string the resulting SQL.
108		*/
109	34	public function upsert(
110		string $table,
111		QueryInterface\|array $insertColumns,
112		bool\|array $updateColumns,
113		array &$params
114		): string {
115	34	if (!$insertColumns instanceof QueryInterface) {
		0 ignored issues – show introduced 2022-12-29 20:30 UTC by Report Bug Copy Issue Report `$insertColumns` is never a sub-type of `Yiisoft\Db\Query\QueryInterface`. Loading history...
116	21	$insertColumns = $this->normalizeColumnNames($table, $insertColumns);
117		}
118
119	34	if (!is_bool($updateColumns)) {
		0 ignored issues – show introduced 2022-12-29 20:30 UTC by Report Bug Copy Issue Report The condition `is_bool($updateColumns)` is always `false`. Loading history...
120	10	$updateColumns = $this->normalizeColumnNames($table, $updateColumns);
121		}
122
123	34	$insertSql = $this->insert($table, $insertColumns, $params);
124
125		/** @var array $uniqueNames */
126	34	[$uniqueNames, , $updateNames] = $this->prepareUpsertColumns(
127	34	$table,
128	34	$insertColumns,
129	34	$updateColumns,
130	34	);
131
132	34	if (empty($uniqueNames)) {
133	2	return $insertSql;
134		}
135
136	32	if ($updateColumns === true) {
		0 ignored issues – show introduced 2022-02-12 12:28 UTC by Report Bug Copy Issue Report The condition `$updateColumns === true` is always `false`. Loading history...
137	10	$updateColumns = [];
138		/** @var string $name */
139	10	foreach ($updateNames as $name) {
140	8	$updateColumns[$name] = new Expression(
141	8	'VALUES(' . $this->quoter->quoteColumnName($name) . ')'
142	8	);
143		}
144		}
145
146	32	if (empty($updateColumns)) {
147	14	return str_replace('INSERT INTO', 'INSERT IGNORE INTO', $insertSql);
148		}
149
150		/**
151		* @psalm-var array<array-key, string> $updates
152		* @psalm-var array<string, ExpressionInterface\|string> $updateColumns
153		*/
154	18	[$updates, $params] = $this->prepareUpdateSets($table, $updateColumns, $params);
155
156	18	return $insertSql . ' ON DUPLICATE KEY UPDATE ' . implode(', ', $updates);
157		}
158
159		/**
160		* Prepares a `VALUES` part for an `INSERT` SQL statement.
161		*
162		* @param string $table the table that new rows will be inserted into.
163		* @param array\|QueryInterface $columns the column data (name => value) to be inserted into the table or instance of
164		* {@see Query\|Query} to perform INSERT INTO ... SELECT SQL statement.
165		* @param array $params the binding parameters that will be generated by this method. They should be bound to the DB
166		* command later.
167		*
168		* @throws Exception\|InvalidArgumentException\|InvalidConfigException\|JsonException\|NotSupportedException
169		*
170		* @return array array of column names, placeholders, values and params.
171		*/
172	72	protected function prepareInsertValues(string $table, QueryInterface\|array $columns, array $params = []): array
173		{
174		/**
175		* @var array $names
176		* @var array $placeholders
177		*/
178	72	[$names, $placeholders, $values, $params] = parent::prepareInsertValues($table, $columns, $params);
179
180	69	if (!$columns instanceof QueryInterface && empty($names)) {
		0 ignored issues – show introduced 2022-05-16 20:14 UTC by Report Bug Copy Issue Report `$columns` is never a sub-type of `Yiisoft\Db\Query\QueryInterface`. Loading history...
181	2	$tableSchema = $this->schema->getTableSchema($table);
182
183	2	if ($tableSchema !== null) {
184	2	$columns = $tableSchema->getColumns();
185	2	$columns = !empty($tableSchema->getPrimaryKey())
186	2	? $tableSchema->getPrimaryKey() : [reset($columns)->getName()];
187	2	foreach ($columns as $name) {
188	2	$names[] = $this->quoter->quoteColumnName($name);
189	2	$placeholders[] = 'DEFAULT';
190		}
191		}
192		}
193
194	69	return [$names, $placeholders, $values, $params];
195		}
196		}
197

yiisoft / db-mysql

Push — master ( e8acbe...849330 )

DMLQueryBuilder::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like