Skip to content

Update according changes in db package #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Tigrov merged 2 commits into from
Aug 4, 2025
Merged

Update according changes in db package #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8240b0c
Update according changes in `db` package
Tigrov Nov 25, 2024
1e8c263
Add line to CHANGELOG.md [skip ci]
Tigrov Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
- Chg #362: Replace column and table name quote character from ` to " (@Tigrov)
- Enh #368: Provide `yiisoft/db-implementation` virtual package (@vjik)
- Enh #371, #374: Adapt to conditions refactoring in `yiisoft/db` package (@vjik)
- Enh #377: Remove `TableSchema` class and refactor `Schema` class (@Tigrov)

## 1.2.0 March 21, 2024

Expand Down
212 changes: 56 additions & 156 deletions src/Schema.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@

namespace Yiisoft\Db\Sqlite;

use Throwable;
use Yiisoft\Db\Constant\ColumnType;
use Yiisoft\Db\Constant\ReferentialAction;
use Yiisoft\Db\Constraint\Check;
use Yiisoft\Db\Constraint\ForeignKey;
use Yiisoft\Db\Constraint\Index;
use Yiisoft\Db\Driver\Pdo\AbstractPdoSchema;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Helper\DbArrayHelper;
use Yiisoft\Db\Schema\Column\ColumnInterface;
use Yiisoft\Db\Schema\SchemaInterface;
use Yiisoft\Db\Schema\TableSchema;
use Yiisoft\Db\Schema\TableSchemaInterface;

use function array_change_key_case;
Expand Down Expand Up @@ -68,6 +67,15 @@
*/
final class Schema extends AbstractPdoSchema
{
protected function findConstraints(TableSchemaInterface $table): void
{
$tableName = $this->resolveFullName($table->getName(), $table->getSchemaName());

$table->checks(...$this->getTableMetadata($tableName, SchemaInterface::CHECKS));
$table->foreignKeys(...$this->getTableMetadata($tableName, SchemaInterface::FOREIGN_KEYS));
$table->indexes(...$this->getTableMetadata($tableName, SchemaInterface::INDEXES));
}

protected function findTableNames(string $schema = ''): array
{
/** @var string[] */
Expand All @@ -78,10 +86,7 @@ protected function findTableNames(string $schema = ''): array

protected function loadTableSchema(string $name): TableSchemaInterface|null
{
$table = new TableSchema();

$table->name($name);
$table->fullName($name);
$table = new TableSchema($name);

if ($this->findColumns($table)) {
$this->findConstraints($table);
Expand All @@ -92,12 +97,6 @@ protected function loadTableSchema(string $name): TableSchemaInterface|null
return null;
}

protected function loadTablePrimaryKey(string $tableName): Index|null
{
/** @var Index|null */
return $this->loadTableConstraints($tableName, self::PRIMARY_KEY);
}

protected function loadTableForeignKeys(string $tableName): array
{
$result = [];
Expand Down Expand Up @@ -138,14 +137,45 @@ protected function loadTableForeignKeys(string $tableName): array

protected function loadTableIndexes(string $tableName): array
{
/** @var Index[] */
return $this->loadTableConstraints($tableName, self::INDEXES);
}
$indexList = $this->db
->createCommand('PRAGMA INDEX_LIST(' . $this->db->getQuoter()->quoteValue($tableName) . ')')
->queryAll();

protected function loadTableUniques(string $tableName): array
{
/** @var Index[] */
return $this->loadTableConstraints($tableName, self::UNIQUES);
/** @psalm-var IndexListInfo[] $indexes */
$indexes = array_map(array_change_key_case(...), $indexList);
$result = [];
$hasPrimaryKey = false;

foreach ($indexes as $index) {
$columns = $this->getPragmaIndexInfo($index['name']);

$result[$index['name']] = new Index(
$index['name'],
array_column($columns, 'name'),
(bool) $index['unique'],
$index['origin'] === 'pk',
);

$hasPrimaryKey = $hasPrimaryKey || $index['origin'] === 'pk';
}

if (!$hasPrimaryKey) {
/**
* Extra check for PK in case of `INTEGER PRIMARY KEY` with ROWID.
*
* @link https://www.sqlite.org/lang_createtable.html#primkeyconst
*/
$tableColumns = $this->loadTableColumnsInfo($tableName);

foreach ($tableColumns as $tableColumn) {
if ($tableColumn['pk'] > 0) {
$result[''] = new Index('', [$tableColumn['name']], true, true);
break;
}
}
}

return $result;
}

protected function loadTableChecks(string $tableName): array
Expand Down Expand Up @@ -199,15 +229,11 @@ protected function loadTableDefaultValues(string $tableName): array
*
* @param TableSchemaInterface $table The table metadata.
*
* @throws Exception
* @throws InvalidConfigException
* @throws Throwable
*
* @return bool Whether the table exists in the database.
*/
protected function findColumns(TableSchemaInterface $table): bool
{
$columns = $this->getPragmaTableInfo($table->getName());
$columns = $this->loadTableColumnsInfo($table->getName());
$jsonColumns = $this->getJsonColumns($table);

foreach ($columns as $info) {
Expand All @@ -220,10 +246,6 @@ protected function findColumns(TableSchemaInterface $table): bool

$column = $this->loadColumn($info);
$table->column($info['name'], $column);

if ($column->isPrimaryKey()) {
$table->primaryKey($info['name']);
}
}

$column = count($table->getPrimaryKey()) === 1 ? $table->getColumn($table->getPrimaryKey()[0]) : null;
Expand All @@ -236,49 +258,6 @@ protected function findColumns(TableSchemaInterface $table): bool
return !empty($columns);
}

/**
* Collects the foreign key column details for the given table.
*
* @param TableSchemaInterface $table The table metadata.
*/
protected function findConstraints(TableSchemaInterface $table): void
{
/** @psalm-var ForeignKey[] $foreignKeysList */
$foreignKeysList = $this->getTableForeignKeys($table->getName(), true);

foreach ($foreignKeysList as $foreignKey) {
/** @var array<string> $columnNames */
$columnNames = $foreignKey->columnNames;
$columnNames = array_combine($columnNames, $foreignKey->foreignColumnNames);

$foreignReference = [$foreignKey->foreignTableName, ...$columnNames];

/** @psalm-suppress InvalidCast */
$table->foreignKey($foreignKey->name, $foreignReference);
}
}

public function findUniqueIndexes(TableSchemaInterface $table): array
{
/** @psalm-var IndexListInfo[] $indexList */
$indexList = $this->getPragmaIndexList($table->getName());
$uniqueIndexes = [];

foreach ($indexList as $index) {
$indexName = $index['name'];
$indexInfo = $this->getPragmaIndexInfo($index['name']);

if ($index['unique']) {
$uniqueIndexes[$indexName] = [];
foreach ($indexInfo as $row) {
$uniqueIndexes[$indexName][] = $row['name'];
}
}
}

return $uniqueIndexes;
}

/**
* @throws NotSupportedException
*/
Expand Down Expand Up @@ -353,71 +332,14 @@ private function loadColumn(array $info): ColumnInterface
*/
private function loadTableColumnsInfo(string $tableName): array
{
$tableColumns = $this->getPragmaTableInfo($tableName);
$tableColumns = $this->db->createCommand(
'PRAGMA TABLE_INFO(' . $this->db->getQuoter()->quoteSimpleTableName($tableName) . ')'
)->queryAll();

/** @psalm-var ColumnInfo[] */
return array_map(array_change_key_case(...), $tableColumns);
}

/**
* Loads multiple types of constraints and returns the specified ones.
*
* @param string $tableName The table name.
* @param string $returnType Return type: (primaryKey, indexes, uniques).
*
* @psalm-return Index[]|Index|null
*/
private function loadTableConstraints(string $tableName, string $returnType): array|Index|null
{
$indexList = $this->getPragmaIndexList($tableName);
/** @psalm-var IndexListInfo[] $indexes */
$indexes = array_map(array_change_key_case(...), $indexList);
$result = [
self::PRIMARY_KEY => null,
self::INDEXES => [],
self::UNIQUES => [],
];

foreach ($indexes as $index) {
$columns = $this->getPragmaIndexInfo($index['name']);

if ($index['origin'] === 'pk') {
$result[self::PRIMARY_KEY] = new Index('', array_column($columns, 'name'), true, true);
} elseif ($index['origin'] === 'u') {
$result[self::UNIQUES][] = new Index($index['name'], array_column($columns, 'name'), true);
}

$result[self::INDEXES][] = new Index(
$index['name'],
array_column($columns, 'name'),
(bool) $index['unique'],
$index['origin'] === 'pk',
);
}

if (!isset($result[self::PRIMARY_KEY])) {
/**
* Extra check for PK in case of `INTEGER PRIMARY KEY` with ROWID.
*
* @link https://www.sqlite.org/lang_createtable.html#primkeyconst
*/
$tableColumns = $this->loadTableColumnsInfo($tableName);

foreach ($tableColumns as $tableColumn) {
if ($tableColumn['pk'] > 0) {
$result[self::PRIMARY_KEY] = new Index('', [$tableColumn['name']], true, true);
$result[self::INDEXES][] = $result[self::PRIMARY_KEY];
break;
}
}
}

foreach ($result as $type => $data) {
$this->setTableMetadata($tableName, $type, $data);
}

return $result[$returnType];
}

/**
* @psalm-return list<ForeignKeyInfo>
*/
Expand Down Expand Up @@ -448,28 +370,6 @@ private function getPragmaIndexInfo(string $name): array
return $column;
}

/**
* @psalm-return IndexListInfo[]
*/
private function getPragmaIndexList(string $tableName): array
{
/** @psalm-var IndexListInfo[] */
return $this->db
->createCommand('PRAGMA INDEX_LIST(' . $this->db->getQuoter()->quoteValue($tableName) . ')')
->queryAll();
}

/**
* @psalm-return ColumnInfo[]
*/
private function getPragmaTableInfo(string $tableName): array
{
/** @psalm-var ColumnInfo[] */
return $this->db->createCommand(
'PRAGMA TABLE_INFO(' . $this->db->getQuoter()->quoteSimpleTableName($tableName) . ')'
)->queryAll();
}

protected function findViewNames(string $schema = ''): array
{
/** @var string[] */
Expand All @@ -484,7 +384,7 @@ private function getJsonColumns(TableSchemaInterface $table): array
{
$result = [];
/** @psalm-var Check[] $checks */
$checks = $this->getTableChecks((string) $table->getFullName());
$checks = $this->getTableChecks($table->getFullName());
$regexp = '/\bjson_valid\(\s*["`\[]?(.+?)["`\]]?\s*\)/i';

foreach ($checks as $check) {
Expand Down
21 changes: 0 additions & 21 deletions src/TableSchema.php
View file
Open in desktop

This file was deleted.

13 changes: 8 additions & 5 deletions tests/Provider/SchemaProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use DateTimeImmutable;
use Yiisoft\Db\Constant\ColumnType;
use Yiisoft\Db\Constraint\Check;
use Yiisoft\Db\Expression\Expression;
use Yiisoft\Db\Schema\Column\ArrayColumn;
use Yiisoft\Db\Schema\Column\BinaryColumn;
Expand Down Expand Up @@ -218,18 +219,20 @@ public static function constraints(): array
{
$constraints = parent::constraints();

Assert::setPropertyValue($constraints['1: check'][2][0], 'columnNames', []);
Assert::setPropertyValue($constraints['1: check'][2][0], 'expression', '"C_check" <> \'\'');
Assert::setPropertyValue($constraints['1: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_1_2');
$constraints['1: check'][2][0] = new Check('', [], '"C_check" <> \'\'');
Assert::setPropertyValue($constraints['1: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_1_1');
Assert::setPropertyValue($constraints['1: unique'][2][1], 'name', 'sqlite_autoindex_T_constraints_1_2');
Assert::setPropertyValue($constraints['1: index'][2][0], 'name', 'sqlite_autoindex_T_constraints_1_1');
Assert::setPropertyValue($constraints['1: index'][2][1], 'name', 'sqlite_autoindex_T_constraints_1_2');
Assert::setPropertyValue($constraints['2: primary key'][2], 'name', '');
Assert::setPropertyValue($constraints['2: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_2_2');
Assert::setPropertyValue($constraints['2: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_2_1');
Assert::setPropertyValue($constraints['2: unique'][2][1], 'name', 'sqlite_autoindex_T_constraints_2_2');
Assert::setPropertyValue($constraints['2: index'][2][0], 'name', 'sqlite_autoindex_T_constraints_2_1');
Assert::setPropertyValue($constraints['2: index'][2][2], 'name', 'sqlite_autoindex_T_constraints_2_2');
Assert::setPropertyValue($constraints['3: foreign key'][2][0], 'name', '0');
$constraints['3: index'][2] = [];
Assert::setPropertyValue($constraints['4: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_4_2');
Assert::setPropertyValue($constraints['4: unique'][2][0], 'name', 'sqlite_autoindex_T_constraints_4_1');
Assert::setPropertyValue($constraints['4: unique'][2][1], 'name', 'sqlite_autoindex_T_constraints_4_2');

return $constraints;
}
Expand Down
Loading