Skip to content

Add ENUM column #448

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
vjik merged 5 commits into from
Nov 30, 2025
Merged

Add ENUM column #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1db19c4
start
vjik Nov 25, 2025
ea1024a
Merge branch 'master' into enum-col
vjik Nov 27, 2025
aee47cd
Merge branch 'master' into enum-col
vjik Nov 27, 2025
17bf247
fix
vjik Nov 28, 2025
c973627
changelog
vjik Nov 29, 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 @@ -55,6 +55,7 @@
- Chg #428: Update expression namespaces according to changes in `yiisoft/db` package (@Tigrov)
- Enh #432, #433: Update `DMLQueryBuilder::update()` method to adapt changes in `yiisoft/db` (@rustamwin, @Tigrov)
- Enh #439: Move "Packets out of order" warning suppression from Yii DB (@vjik)
- New #448: Add enumeration column type support (@vjik)

## 1.2.0 March 21, 2024

Expand Down
27 changes: 27 additions & 0 deletions src/Column/ColumnDefinitionBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Yiisoft\Db\Constant\ColumnType;
use Yiisoft\Db\QueryBuilder\AbstractColumnDefinitionBuilder;
use Yiisoft\Db\Schema\Column\ColumnInterface;
use Yiisoft\Db\Schema\Column\EnumColumn;

use function str_contains;
use function version_compare;
Expand Down Expand Up @@ -63,6 +64,17 @@

public function buildType(ColumnInterface $column): string
{
if ($column instanceof EnumColumn) {
$dbType = $this->getDbType($column);
if (strtolower($dbType) === 'enum') {
$values = array_map(
$this->queryBuilder->getQuoter()->quoteValue(...),
$column->getValues(),
);
return $dbType . '(' . implode(',', $values) . ')';
}
}

$dbType = parent::buildType($column);

if (!$column instanceof StringColumn || empty($column->getCharacterSet())) {
Expand All @@ -72,6 +84,20 @@
return "$dbType CHARACTER SET " . $column->getCharacterSet();
}

protected function buildCheck(ColumnInterface $column): string
{
$check = $column->getCheck();

if ($column instanceof EnumColumn && $column->getDbType() === null && empty($check)) {
$dbType = $this->getDbType($column);
if ($dbType === 'enum') {

Check warning on line 93 in src/Column/ColumnDefinitionBuilder.php

View workflow job for this annotation

GitHub Actions / PHP 8.4-ubuntu-latest 

Escaped Mutant for Mutator "Identical":

@@ @@
         $check = $column->getCheck();
         if ($column instanceof EnumColumn && $column->getDbType() === null && empty($check)) {
             $dbType = $this->getDbType($column);
-            if ($dbType === 'enum') {
+            if ($dbType !== 'enum') {
                 return '';
             }
         }
return '';

Check warning on line 94 in src/Column/ColumnDefinitionBuilder.php

View workflow job for this annotation

GitHub Actions / PHP 8.4-ubuntu-latest 

Escaped Mutant for Mutator "ReturnRemoval":

@@ @@
         if ($column instanceof EnumColumn && $column->getDbType() === null && empty($check)) {
             $dbType = $this->getDbType($column);
             if ($dbType === 'enum') {
-                return '';
+                
             }
         }
         return parent::buildCheck($column);
}
}

return parent::buildCheck($column);
}

protected function buildComment(ColumnInterface $column): string
{
$comment = $column->getComment();
Expand Down Expand Up @@ -107,6 +133,7 @@
ColumnType::ARRAY => 'json',
ColumnType::STRUCTURED => 'json',
ColumnType::JSON => 'json',
ColumnType::ENUM => 'enum',
default => 'varchar',
};

Expand Down
40 changes: 40 additions & 0 deletions tests/Column/ColumnDefinitionBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Db\Mysql\Tests\Column;

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Yiisoft\Db\Mysql\Column\ColumnDefinitionBuilder;
use Yiisoft\Db\Mysql\Tests\Support\TestConnection;
use Yiisoft\Db\Schema\Column\ColumnInterface;
use Yiisoft\Db\Schema\Column\EnumColumn;
use Yiisoft\Db\Schema\Column\IntegerColumn;

final class ColumnDefinitionBuilderTest extends TestCase
{
public static function dataBuild(): iterable
{
yield 'integer' => ['int', new IntegerColumn()];
yield 'enum' => ["enum('a','b','c')", new EnumColumn(values: ['a', 'b', 'c'])];
yield 'enum-upper-case' => ["ENUM('a','b','c')", new EnumColumn(dbType: 'ENUM', values: ['a', 'b', 'c'])];
}

#[DataProvider('dataBuild')]
public function testBuild(string $expected, ColumnInterface $column): void
{
$builder = $this->createColumnDefinitionBuilder();

$result = $builder->build($column);

$this->assertSame($expected, $result);
}

private function createColumnDefinitionBuilder(): ColumnDefinitionBuilder
{
return new ColumnDefinitionBuilder(
TestConnection::getShared()->getQueryBuilder(),
);
}
}
56 changes: 56 additions & 0 deletions tests/Column/EnumColumnTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Db\Mysql\Tests\Column;

use PHPUnit\Framework\Attributes\TestWith;
use Yiisoft\Db\Mysql\Tests\Support\IntegrationTestTrait;
use Yiisoft\Db\Schema\Column\EnumColumn;
use Yiisoft\Db\Tests\Common\CommonEnumColumnTest;

final class EnumColumnTest extends CommonEnumColumnTest
{
use IntegrationTestTrait;

#[TestWith(['INT CHECK (status IN (1, 2, 3))'])]
#[TestWith(["TEXT CHECK (status <> 'abc')"])]
public function testNonEnumCheck(string $columnDefinition): void
{
$this->dropTable('test_enum_table');
$this->executeStatements(
<<<SQL
CREATE TABLE test_enum_table (
id INT,
status $columnDefinition
)
SQL,
);

$db = $this->getSharedConnection();
$column = $db->getTableSchema('test_enum_table')->getColumn('status');

$this->assertNotInstanceOf(EnumColumn::class, $column);

$this->dropTable('test_enum_table');
}

protected function createDatabaseObjectsStatements(): array
{
return [
<<<SQL
CREATE TABLE tbl_enum (
id INT,
status ENUM('active', 'unactive', 'pending')
);
SQL,
];
}

protected function dropDatabaseObjectsStatements(): array
{
return [
'DROP TABLE IF EXISTS tbl_enum',
];
}
}
5 changes: 3 additions & 2 deletions tests/Provider/SchemaProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Yiisoft\Db\Schema\Column\BitColumn;
use Yiisoft\Db\Schema\Column\BooleanColumn;
use Yiisoft\Db\Schema\Column\DoubleColumn;
use Yiisoft\Db\Schema\Column\EnumColumn;
use Yiisoft\Db\Schema\Column\IntegerColumn;
use Yiisoft\Db\Schema\Column\JsonColumn;
use Yiisoft\Db\Tests\Support\Assert;
Expand Down Expand Up @@ -82,11 +83,11 @@ public static function columns(): array
collation: 'utf8mb4_general_ci',
dbType: 'text',
),
'enum_col' => new StringColumn(
'enum_col' => new EnumColumn(
dbType: 'enum',
characterSet: 'utf8mb4',
collation: 'utf8mb4_general_ci',
enumValues: ['a', 'B', 'c,D'],
values: ['a', 'B', 'c,D'],
),
'float_col' => new DoubleColumn(
dbType: 'double',
Expand Down
Loading