Yiisoft\Db\QueryBuilder\AbstractDDLQueryBuilder

Complexity

Total Complexity

44

Size/Duplication

Total Lines	297
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	dropDefaultValue()	0	3	1
A	dropTable()	0	3	1
A	renameTable()	0	5	1
A	truncateTable()	0	3	1
A	dropUnique()	0	6	1
A	dropView()	0	3	1
A	dropForeignKey()	0	6	1
A	dropIndex()	0	6	1
A	dropCommentFromTable()	0	5	1
A	createView()	0	15	3
A	dropCommentFromColumn()	0	7	1
A	renameColumn()	0	6	1
A	dropPrimaryKey()	0	6	1
A	dropCheck()	0	6	1
A	dropColumn()	0	6	1
A	addDefaultValue()	0	3	1
A	addUnique()	0	15	3
A	refreshMaterializedView()	0	15	4
A	addPrimaryKey()	0	15	3
A	addForeignKey()	0	25	3
A	addCommentOnColumn()	0	8	1
A	checkIntegrity()	0	3	1
A	addCheck()	0	7	1
A	__construct()	0	5	1
A	createTable()	0	20	4
A	createIndex()	0	11	2
A	addColumn()	0	8	1
A	alterColumn()	0	12	1
A	addCommentOnTable()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\QueryBuilder;

use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Query\QueryInterface;
use Yiisoft\Db\Schema\Builder\ColumnInterface;
use Yiisoft\Db\Schema\QuoterInterface;
use Yiisoft\Db\Schema\SchemaInterface;

use function implode;
use function is_bool;
use function is_string;
use function preg_split;

/**
 * It's used to create and change the structure of database objects in a database.
 *
 * These database objects include views, schemas, tables, indexes, etc.
 *
 * @link https://en.wikipedia.org/wiki/Data_definition_language
 */
abstract class AbstractDDLQueryBuilder implements DDLQueryBuilderInterface
{
    public function __construct(
        protected QueryBuilderInterface $queryBuilder,
        protected QuoterInterface $quoter,
        protected SchemaInterface $schema
    ) {
    }

    public function addCheck(string $table, string $name, string $expression): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' ADD CONSTRAINT '
            . $this->quoter->quoteColumnName($name)
            . ' CHECK (' . $this->quoter->quoteSql($expression) . ')';
    }

    public function addColumn(string $table, string $column, string $type): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' ADD '
            . $this->quoter->quoteColumnName($column)
            . ' '
            . $this->queryBuilder->getColumnType($type);
    }

    public function addCommentOnColumn(string $table, string $column, string $comment): string
    {
        return 'COMMENT ON COLUMN '
            . $this->quoter->quoteTableName($table)
            . '.'
            . $this->quoter->quoteColumnName($column)
            . ' IS '
            . (string) $this->quoter->quoteValue($comment);
    }

    public function addCommentOnTable(string $table, string $comment): string
    {
        return 'COMMENT ON TABLE '
            . $this->quoter->quoteTableName($table)
            . ' IS '
            . (string) $this->quoter->quoteValue($comment);
    }

    public function addDefaultValue(string $table, string $name, string $column, mixed $value): string
    {
        throw new NotSupportedException(__METHOD__ . ' is not supported by this DBMS.');
    }

    public function addForeignKey(
        string $table,
        string $name,
        array|string $columns,
        string $referenceTable,
        array|string $referenceColumns,
        string|null $delete = null,
        string|null $update = null
    ): string {
        $sql = 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' ADD CONSTRAINT ' . $this->quoter->quoteColumnName($name)
            . ' FOREIGN KEY (' . $this->queryBuilder->buildColumns($columns) . ')'
            . ' REFERENCES ' . $this->quoter->quoteTableName($referenceTable)
            . ' (' . $this->queryBuilder->buildColumns($referenceColumns) . ')';

        if ($delete !== null) {
            $sql .= ' ON DELETE ' . $delete;
        }

        if ($update !== null) {
            $sql .= ' ON UPDATE ' . $update;
        }

        return $sql;
    }

    public function addPrimaryKey(string $table, string $name, array|string $columns): string
    {
        if (is_string($columns)) {

The condition is_string($columns) is always false.

            $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
        }

        /** @psalm-var string[] $columns */
        foreach ($columns as $i => $col) {
            $columns[$i] = $this->quoter->quoteColumnName($col);
        }

        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' ADD CONSTRAINT ' . $this->quoter->quoteColumnName($name)
            . ' PRIMARY KEY (' . implode(', ', $columns) . ')';
    }

    public function addUnique(string $table, string $name, array|string $columns): string
    {
        if (is_string($columns)) {

The condition is_string($columns) is always false.

            $columns = preg_split('/\s*,\s*/', $columns, -1, PREG_SPLIT_NO_EMPTY);
        }

        /** @psalm-var string[] $columns */
        foreach ($columns as $i => $col) {
            $columns[$i] = $this->quoter->quoteColumnName($col);
        }

        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' ADD CONSTRAINT ' . $this->quoter->quoteColumnName($name)
            . ' UNIQUE (' . implode(', ', $columns) . ')';
    }

    public function alterColumn(
        string $table,
        string $column,
        ColumnInterface|string $type
    ): string {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' CHANGE '
            . $this->quoter->quoteColumnName($column)
            . ' '
            . $this->quoter->quoteColumnName($column) . ' '
            . $this->queryBuilder->getColumnType($type);
    }

    public function checkIntegrity(string $schema = '', string $table = '', bool $check = true): string
    {
        throw new NotSupportedException(__METHOD__ . ' is not supported by this DBMS.');
    }

    public function createIndex(
        string $table,
        string $name,
        array|string $columns,
        string $indexType = null,
        string $indexMethod = null
    ): string {
        return 'CREATE ' . ($indexType ? ($indexType . ' ') : '') . 'INDEX '
            . $this->quoter->quoteTableName($name)
            . ' ON ' . $this->quoter->quoteTableName($table)
            . ' (' . $this->queryBuilder->buildColumns($columns) . ')';
    }

    public function createTable(string $table, array $columns, string $options = null): string
    {
        $cols = [];

        /** @psalm-var string[] $columns */
        foreach ($columns as $name => $type) {
            if (is_string($name)) {
                $cols[] = "\t"
                    . $this->quoter->quoteColumnName($name)
                    . ' '
                    . $this->queryBuilder->getColumnType($type);
            } else {
                $cols[] = "\t" . $type;
            }
        }

        $sql = 'CREATE TABLE '
            . $this->quoter->quoteTableName($table) . " (\n" . implode(",\n", $cols) . "\n)";

        return $options === null ? $sql : $sql . ' ' . $options;
    }

    public function createView(string $viewName, QueryInterface|string $subQuery): string
    {
        if ($subQuery instanceof QueryInterface) {
            [$rawQuery, $params] = $this->queryBuilder->build($subQuery);

            /** @psalm-var mixed $value */
            foreach ($params as $key => $value) {
                /** @psalm-var mixed */
                $params[$key] = $this->quoter->quoteValue($value);
            }

            $subQuery = strtr($rawQuery, $params);
        }

        return 'CREATE VIEW ' . $this->quoter->quoteTableName($viewName) . ' AS ' . $subQuery;
    }

    public function dropCheck(string $table, string $name): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' DROP CONSTRAINT '
            . $this->quoter->quoteColumnName($name);
    }

    public function dropColumn(string $table, string $column): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' DROP COLUMN '
            . $this->quoter->quoteColumnName($column);
    }

    public function dropCommentFromColumn(string $table, string $column): string
    {
        return 'COMMENT ON COLUMN '
            . $this->quoter->quoteTableName($table)
            . '.'
            . $this->quoter->quoteColumnName($column)
            . ' IS NULL';
    }

    public function dropCommentFromTable(string $table): string
    {
        return 'COMMENT ON TABLE '
             . $this->quoter->quoteTableName($table)
             . ' IS NULL';
    }

    public function dropDefaultValue(string $table, string $name): string
    {
        throw new NotSupportedException(__METHOD__ . ' is not supported by this DBMS.');
    }

    public function dropForeignKey(string $table, string $name): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' DROP CONSTRAINT '
            . $this->quoter->quoteColumnName($name);
    }

    public function dropIndex(string $table, string $name): string
    {
        return 'DROP INDEX '
            . $this->quoter->quoteTableName($name)
            . ' ON '
            . $this->quoter->quoteTableName($table);
    }

    public function dropPrimaryKey(string $table, string $name): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' DROP CONSTRAINT '
            . $this->quoter->quoteColumnName($name);
    }

    public function dropTable(string $table): string
    {
        return 'DROP TABLE ' . $this->quoter->quoteTableName($table);
    }

    public function dropUnique(string $table, string $name): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' DROP CONSTRAINT '
            . $this->quoter->quoteColumnName($name);
    }

    public function dropView(string $viewName): string
    {
        return 'DROP VIEW ' . $this->quoter->quoteTableName($viewName);
    }

    public function renameColumn(string $table, string $oldName, string $newName): string
    {
        return 'ALTER TABLE '
            . $this->quoter->quoteTableName($table)
            . ' RENAME COLUMN ' . $this->quoter->quoteColumnName($oldName)
            . ' TO ' . $this->quoter->quoteColumnName($newName);
    }

    public function renameTable(string $oldName, string $newName): string
    {
        return 'RENAME TABLE '
            . $this->quoter->quoteTableName($oldName)
            . ' TO ' . $this->quoter->quoteTableName($newName);
    }

    public function truncateTable(string $table): string
    {
        return 'TRUNCATE TABLE ' . $this->quoter->quoteTableName($table);
    }

    public function refreshMaterializedView(string $viewName, bool $concurrently = false, ?bool $withData = null): string
    {
        $sql = 'REFRESH MATERIALIZED VIEW ';

        if ($concurrently) {
            $sql .= 'CONCURRENTLY ';
        }

        $sql .= $this->quoter->quoteTableName($viewName);

        if (is_bool($withData)) {
            $sql .= ' WITH ' . ($withData ? 'DATA' : 'NO DATA');
        }

        return $sql;
    }
}