DMLQueryBuilder::truncateTable() - Code Metrics - Inspection of "Check code coverage in branch dev." - yiisoft/db-pgsql - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — remove-test-query-builder-trai... ( 73573f...54249c )

by Wilmer

created 2022-12-06 12:41 UTC

DMLQueryBuilder::truncateTable() A

↳ Parent: DMLQueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Pgsql;

use JsonException;
use PDO;
use Yiisoft\Db\Command\Param;
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\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\Schema;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Yiisoft\Db\Schema\SchemaInterface;

use function implode;
use function is_array;
use function is_string;
use function reset;

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

    public function insertEx(string $table, QueryInterface|array $columns, array &$params = []): string
    {
        $sql = $this->insert($table, $columns, $params);

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

        $returnColumns = [];
        if ($tableSchema !== null) {
            $returnColumns = $tableSchema->getPrimaryKey();
        }

        if (!empty($returnColumns)) {
            $returning = [];
            foreach ($returnColumns as $name) {
                $returning[] = $this->quoter->quoteColumnName($name);
            }
            $sql .= ' RETURNING ' . implode(', ', $returning);
        }

        return $sql;
    }

    /**
     * Creates an INSERT SQL statement.
     *
     * For example,
     *
     * ```php
     * $sql = $queryBuilder->insert('user', [
     *     'name' => 'Sam',
     *     'age' => 30,
     * ], $params);
     * ```
     *
     * The method will properly escape the table and column names.
     *
     * @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} to perform INSERT INTO ... SELECT SQL statement. Passing of {@see Query}.
     * @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|NotSupportedException
     *
     * @return string the INSERT SQL
     *
     * @psalm-suppress UndefinedInterfaceMethod
     * @psalm-suppress MixedArgument
     */
    public function insert(string $table, QueryInterface|array $columns, array &$params = []): string
    {
        return parent::insert($table, $this->normalizeTableRowData($table, $columns), $params);
    }

    /**
     * {@see upsert()} implementation for PostgresSQL 9.5 or higher.
     *
     * @throws Exception|InvalidArgumentException|InvalidConfigException|JsonException|NotSupportedException
     */
    public function newUpsert(
        string $table,
        QueryInterface|array $insertColumns,
        bool|array|QueryInterface $updateColumns,
        array &$params = []
    ): string {
        $insertSql = $this->insert($table, $insertColumns, $params);

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

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

        if ($updateNames === []) {

            /** there are no columns to update */
            $updateColumns = false;
        }

        if ($updateColumns === false) {

            return "$insertSql ON CONFLICT DO NOTHING";
        }

        if ($updateColumns === true) {

            $updateColumns = [];

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

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

        return $insertSql
            . ' ON CONFLICT (' . implode(', ', $uniqueNames) . ') DO UPDATE SET ' . implode(', ', $updates);
    }

    /**
     * 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 if the table does not exist or there is no sequence
     * associated with the table.
     *
     * @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 && ($sequence = $table->getSequenceName()) !== null) {
            /**
             * {@see http://www.postgresql.org/docs/8.1/static/functions-sequence.html}
             */
            $sequence = $this->quoter->quoteTableName($sequence);
            $tableName = $this->quoter->quoteTableName($tableName);

            if ($value === null) {
                $pk = $table->getPrimaryKey();
                $key = $this->quoter->quoteColumnName(reset($pk));
                $value = "(SELECT COALESCE(MAX($key),0) FROM $tableName)+1";
            }

            return "SELECT SETVAL('$sequence',$value,false)";
        }

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

        throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.");
    }

    /**
     * Creates an UPDATE SQL statement.
     *
     * For example,
     *
     * ```php
     * $params = [];
     * $sql = $queryBuilder->update('user', ['status' => 1], 'age > 30', $params);
     * ```
     *
     * The method will properly escape the table and column names.
     *
     * @param string $table the table to be updated.
     * @param array $columns the column data (name => value) to be updated.
     * @param array|string $condition the condition that will be put in the WHERE part. Please refer to
     * {@see Query::where()} on how to specify condition.
     * @param array $params the binding parameters that will be modified by this method so that they can be bound to the
     * DB command later.
     *
     * @return string the UPDATE SQL.
     *
     * @psalm-suppress UndefinedInterfaceMethod
     */
    public function update(string $table, array $columns, array|string $condition, array &$params = []): string
    {
        $normalizeTableRowData = $this->normalizeTableRowData($table, $columns);

        return parent::update(
            $table,
            is_array($normalizeTableRowData) ? $normalizeTableRowData : [],

            $condition,
            $params,
        );
    }

    /**
     * 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 \Yiisoft\Db\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|QueryInterface $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.
     *
     * @link https://www.postgresql.org/docs/9.5/static/sql-insert.html#SQL-ON-CONFLICT
     * @link https://stackoverflow.com/questions/1109061/insert-on-duplicate-update-in-postgresql/8702291#8702291
     *
     * @psalm-suppress UndefinedInterfaceMethod
     */
    public function upsert(
        string $table,
        QueryInterface|array $insertColumns,
        $updateColumns,
        array &$params = []
    ): string {
        $insertColumns = $this->normalizeTableRowData($table, $insertColumns);

        if (!is_bool($updateColumns)) {
            $updateColumns = $this->normalizeTableRowData($table, $updateColumns);
        }

        return $this->newUpsert($table, $insertColumns, $updateColumns, $params);
    }

    /**
     * Normalizes data to be saved into the table, performing extra preparations and type converting, if necessary.
     *
     * @param string $table the table that data will be saved into.
     * @param array|QueryInterface $columns the column data (name => value) to be saved into the table or instance of
     * {@see QueryInterface} to perform INSERT INTO ... SELECT SQL statement. Passing of
     * {@see QueryInterface}.
     *
     * @return array|QueryInterface normalized columns.
     */
    private function normalizeTableRowData(string $table, QueryInterface|array $columns): QueryInterface|array
    {
        if ($columns instanceof QueryInterface) {

            return $columns;
        }

        if (($tableSchema = $this->schema->getTableSchema($table)) !== null) {
            $columnSchemas = $tableSchema->getColumns();
            /** @var mixed $value */
            foreach ($columns as $name => $value) {
                if (
                    isset($columnSchemas[$name]) &&
                    $columnSchemas[$name]->getType() === Schema::TYPE_BINARY &&
                    is_string($value)
                ) {
                    /** explicitly setup PDO param type for binary column */
                    $columns[$name] = new Param($value, PDO::PARAM_LOB);
                }
            }
        }

        return $columns;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Db\Pgsql;
6
7			use JsonException;
8			use PDO;
9			use Yiisoft\Db\Command\Param;
10			use Yiisoft\Db\Exception\Exception;
11			use Yiisoft\Db\Exception\InvalidArgumentException;
12			use Yiisoft\Db\Exception\InvalidConfigException;
13			use Yiisoft\Db\Exception\NotSupportedException;
14			use Yiisoft\Db\Expression\Expression;
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\Schema;
			0 ignored issues – show Bug introduced 2022-05-03 20:17 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Yiisoft\Db\Pgsql\Schema`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
21			use Yiisoft\Db\Schema\SchemaInterface;
22
23			use function implode;
24			use function is_array;
25			use function is_string;
26			use function reset;
27
28			final class DMLQueryBuilder extends AbstractDMLQueryBuilder
29			{
30			public function __construct(
31			private QueryBuilderInterface $queryBuilder,
32			private QuoterInterface $quoter,
33			private SchemaInterface $schema
34			) {
35			parent::__construct($queryBuilder, $quoter, $schema);
36			}
37
38			public function insertEx(string $table, QueryInterface\|array $columns, array &$params = []): string
39			{
40			$sql = $this->insert($table, $columns, $params);
41
42			$tableSchema = $this->schema->getTableSchema($table);
43
44			$returnColumns = [];
45			if ($tableSchema !== null) {
46			$returnColumns = $tableSchema->getPrimaryKey();
47			}
48
49			if (!empty($returnColumns)) {
50			$returning = [];
51			foreach ($returnColumns as $name) {
52			$returning[] = $this->quoter->quoteColumnName($name);
53			}
54			$sql .= ' RETURNING ' . implode(', ', $returning);
55			}
56
57			return $sql;
58			}
59
60			/**
61			* Creates an INSERT SQL statement.
62			*
63			* For example,
64			*
65			* ```php
66			* $sql = $queryBuilder->insert('user', [
67			* 'name' => 'Sam',
68			* 'age' => 30,
69			* ], $params);
70			* ```
71			*
72			* The method will properly escape the table and column names.
73			*
74			* @param string $table the table that new rows will be inserted into.
75			* @param array\|QueryInterface $columns the column data (name => value) to be inserted into the table or instance of
76			* {@see Query} to perform INSERT INTO ... SELECT SQL statement. Passing of {@see Query}.
77			* @param array $params the binding parameters that will be generated by this method. They should be bound to the
78			* DB command later.
79			*
80			* @throws Exception\|InvalidArgumentException\|InvalidConfigException\|NotSupportedException
81			*
82			* @return string the INSERT SQL
83			*
84			* @psalm-suppress UndefinedInterfaceMethod
85			* @psalm-suppress MixedArgument
86			*/
87			public function insert(string $table, QueryInterface\|array $columns, array &$params = []): string
88			{
89			return parent::insert($table, $this->normalizeTableRowData($table, $columns), $params);
90			}
91
92			/**
93			* {@see upsert()} implementation for PostgresSQL 9.5 or higher.
94			*
95			* @throws Exception\|InvalidArgumentException\|InvalidConfigException\|JsonException\|NotSupportedException
96			*/
97			public function newUpsert(
98			string $table,
99			QueryInterface\|array $insertColumns,
100			bool\|array\|QueryInterface $updateColumns,
101			array &$params = []
102			): string {
103			$insertSql = $this->insert($table, $insertColumns, $params);
104
105			/** @var array $uniqueNames */
106			[$uniqueNames, , $updateNames] = $this->prepareUpsertColumns(
107			$table,
108			$insertColumns,
109			$updateColumns,
110			);
111
112			if (empty($uniqueNames)) {
113			return $insertSql;
114			}
115
116			if ($updateNames === []) {
			0 ignored issues – show introduced 2022-05-03 20:58 UTC by Report Bug Copy Issue Report The condition `$updateNames === array()` is always `false`. Loading history...
117			/** there are no columns to update */
118			$updateColumns = false;
119			}
120
121			if ($updateColumns === false) {
			0 ignored issues – show introduced 2022-05-03 20:58 UTC by Report Bug Copy Issue Report The condition `$updateColumns === false` is always `false`. Loading history...
122			return "$insertSql ON CONFLICT DO NOTHING";
123			}
124
125			if ($updateColumns === true) {
			0 ignored issues – show introduced 2022-02-12 12:43 UTC by Report Bug Copy Issue Report The condition `$updateColumns === true` is always `false`. Loading history...
126			$updateColumns = [];
127
128			/** @var string $name */
129			foreach ($updateNames as $name) {
130			$updateColumns[$name] = new Expression(
131			'EXCLUDED.' . $this->quoter->quoteColumnName($name)
132			);
133			}
134			}
135
136			/**
137			* @var array $updateColumns
138			*
139			* @psalm-var string[] $uniqueNames
140			* @psalm-var string[] $updates
141			*/
142			[$updates, $params] = $this->prepareUpdateSets($table, $updateColumns, $params);
143
144			return $insertSql
145			. ' ON CONFLICT (' . implode(', ', $uniqueNames) . ') DO UPDATE SET ' . implode(', ', $updates);
146			}
147
148			/**
149			* Creates a SQL statement for resetting the sequence value of a table's primary key.
150			*
151			* The sequence will be reset such that the primary key of the next new row inserted will have the specified value
152			* or 1.
153			*
154			* @param string $tableName the name of the table whose primary key sequence will be reset.
155			* @param int\|string\|null $value the value for the primary key of the next new row inserted. If this is not set, the
156			* next new row's primary key will have a value 1.
157			*
158			* @throws Exception\|InvalidArgumentException if the table does not exist or there is no sequence
159			* associated with the table.
160			*
161			* @return string the SQL statement for resetting sequence.
162			*/
163			public function resetSequence(string $tableName, int\|string $value = null): string
164			{
165			$table = $this->schema->getTableSchema($tableName);
166
167			if ($table !== null && ($sequence = $table->getSequenceName()) !== null) {
168			/**
169			* {@see http://www.postgresql.org/docs/8.1/static/functions-sequence.html}
170			*/
171			$sequence = $this->quoter->quoteTableName($sequence);
172			$tableName = $this->quoter->quoteTableName($tableName);
173
174			if ($value === null) {
175			$pk = $table->getPrimaryKey();
176			$key = $this->quoter->quoteColumnName(reset($pk));
177			$value = "(SELECT COALESCE(MAX($key),0) FROM $tableName)+1";
178			}
179
180			return "SELECT SETVAL('$sequence',$value,false)";
181			}
182
183			if ($table === null) {
184			throw new InvalidArgumentException("Table not found: $tableName");
185			}
186
187			throw new InvalidArgumentException("There is not sequence associated with table '$tableName'.");
188			}
189
190			/**
191			* Creates an UPDATE SQL statement.
192			*
193			* For example,
194			*
195			* ```php
196			* $params = [];
197			* $sql = $queryBuilder->update('user', ['status' => 1], 'age > 30', $params);
198			* ```
199			*
200			* The method will properly escape the table and column names.
201			*
202			* @param string $table the table to be updated.
203			* @param array $columns the column data (name => value) to be updated.
204			* @param array\|string $condition the condition that will be put in the WHERE part. Please refer to
205			* {@see Query::where()} on how to specify condition.
206			* @param array $params the binding parameters that will be modified by this method so that they can be bound to the
207			* DB command later.
208			*
209			* @return string the UPDATE SQL.
210			*
211			* @psalm-suppress UndefinedInterfaceMethod
212			*/
213			public function update(string $table, array $columns, array\|string $condition, array &$params = []): string
214			{
215			$normalizeTableRowData = $this->normalizeTableRowData($table, $columns);
216
217			return parent::update(
218			$table,
219			is_array($normalizeTableRowData) ? $normalizeTableRowData : [],
			0 ignored issues – show introduced 2022-05-03 20:17 UTC by Report Bug Copy Issue Report The condition `is_array($normalizeTableRowData)` is always `true`. Loading history...
220			$condition,
221			$params,
222			);
223			}
224
225			/**
226			* Creates an SQL statement to insert rows into a database table if they do not already exist (matching unique
227			* constraints), or update them if they do.
228			*
229			* For example,
230			*
231			* ```php
232			* $sql = $queryBuilder->upsert('pages', [
233			* 'name' => 'Front page',
234			* 'url' => 'http://example.com/', // url is unique
235			* 'visits' => 0,
236			* ], [
237			* 'visits' => new \Yiisoft\Db\Expression('visits + 1'),
238			* ], $params);
239			* ```
240			*
241			* The method will properly escape the table and column names.
242			*
243			* @param string $table the table that new rows will be inserted into/updated in.
244			* @param array\|QueryInterface $insertColumns the column data (name => value) to be inserted into the table or
245			* instance of {@see Query} to perform `INSERT INTO ... SELECT` SQL statement.
246			* @param array\|bool\|QueryInterface $updateColumns the column data (name => value) to be updated if they already
247			* exist.
248			* If `true` is passed, the column data will be updated to match the insert column data.
249			* If `false` is passed, no update will be performed if the column data already exists.
250			* @param array $params the binding parameters that will be generated by this method.
251			* They should be bound to the DB command later.
252			*
253			* @throws Exception\|InvalidConfigException\|JsonException\|NotSupportedException if this is not supported by the
254			* underlying DBMS.
255			*
256			* @return string the resulting SQL.
257			*
258			* @link https://www.postgresql.org/docs/9.5/static/sql-insert.html#SQL-ON-CONFLICT
259			* @link https://stackoverflow.com/questions/1109061/insert-on-duplicate-update-in-postgresql/8702291#8702291
260			*
261			* @psalm-suppress UndefinedInterfaceMethod
262			*/
263			public function upsert(
264			string $table,
265			QueryInterface\|array $insertColumns,
266			$updateColumns,
267			array &$params = []
268			): string {
269			$insertColumns = $this->normalizeTableRowData($table, $insertColumns);
270
271			if (!is_bool($updateColumns)) {
272			$updateColumns = $this->normalizeTableRowData($table, $updateColumns);
273			}
274
275			return $this->newUpsert($table, $insertColumns, $updateColumns, $params);
276			}
277
278			/**
279			* Normalizes data to be saved into the table, performing extra preparations and type converting, if necessary.
280			*
281			* @param string $table the table that data will be saved into.
282			* @param array\|QueryInterface $columns the column data (name => value) to be saved into the table or instance of
283			* {@see QueryInterface} to perform INSERT INTO ... SELECT SQL statement. Passing of
284			* {@see QueryInterface}.
285			*
286			* @return array\|QueryInterface normalized columns.
287			*/
288			private function normalizeTableRowData(string $table, QueryInterface\|array $columns): QueryInterface\|array
289			{
290			if ($columns instanceof QueryInterface) {
			0 ignored issues – show introduced 2022-05-03 20:17 UTC by Report Bug Copy Issue Report `$columns` is never a sub-type of `Yiisoft\Db\Query\QueryInterface`. Loading history...
291			return $columns;
292			}
293
294			if (($tableSchema = $this->schema->getTableSchema($table)) !== null) {
295			$columnSchemas = $tableSchema->getColumns();
296			/** @var mixed $value */
297			foreach ($columns as $name => $value) {
298			if (
299			isset($columnSchemas[$name]) &&
300			$columnSchemas[$name]->getType() === Schema::TYPE_BINARY &&
301			is_string($value)
302			) {
303			/** explicitly setup PDO param type for binary column */
304			$columns[$name] = new Param($value, PDO::PARAM_LOB);
305			}
306			}
307			}
308
309			return $columns;
310			}
311			}
312

yiisoft / db-pgsql

Push — remove-test-query-builder-trai... ( 73573f...54249c )

DMLQueryBuilder::truncateTable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like