Skip to content

Remove null collate option from generated migrations #975

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
markstory merged 1 commit into from
Dec 3, 2025
Merged

Remove null collate option from generated migrations #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions src/View/Helper/MigrationHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
use Cake\Core\Configure;
use Cake\Database\Connection;
use Cake\Database\Driver\Mysql;
use Cake\Database\Driver\Sqlserver;
use Cake\Database\Schema\CollectionInterface;
use Cake\Database\Schema\TableSchemaInterface;
use Cake\Utility\Hash;
Expand Down Expand Up @@ -401,18 +400,19 @@ public function getColumnOption(array $options): array
if (empty($columnOptions['autoIncrement'])) {
unset($columnOptions['autoIncrement']);
}
if (empty($columnOptions['collate'])) {
unset($columnOptions['collate']);
}

// currently only MySQL supports the signed option
$driver = $connection->getDriver();
$isMysql = $driver instanceof Mysql;
$isSqlserver = $driver instanceof Sqlserver;

if (!$isMysql) {
unset($columnOptions['signed']);
}

if (($isMysql || $isSqlserver) && !empty($columnOptions['collate'])) {
// due to Phinx using different naming for the collation
if (!empty($columnOptions['collate'])) {
// Phinx uses 'collation' not 'collate'
$columnOptions['collation'] = $columnOptions['collate'];
unset($columnOptions['collate']);
}
Expand Down
48 changes: 48 additions & 0 deletions tests/TestCase/View/Helper/MigrationHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,4 +397,52 @@ public function testStringifyList()
],
]));
}

/**
* Test that getColumnOption removes null collate for all databases
*
* @see https://github.com/cakephp/migrations/issues/974
*/
public function testGetColumnOptionRemovesNullCollate(): void
{
$options = [
'length' => 255,
'null' => true,
'default' => null,
'collate' => null,
];

$result = $this->helper->getColumnOption($options);

// collate => null should NOT be in the output for any database
// because it causes "collate is not a valid column option" error
$this->assertArrayNotHasKey('collate', $result, 'collate => null should be removed');
$this->assertArrayNotHasKey('collation', $result, 'collation should not be set when collate is null');
}

/**
* Test that getColumnOption converts collate to collation for all databases
*
* Phinx uses 'collation' not 'collate', so this must be converted for any database
* that supports per-column collation (MySQL, SQL Server, PostgreSQL, SQLite).
*
* @see https://github.com/cakephp/migrations/issues/974
*/
public function testGetColumnOptionConvertsCollateToCollation(): void
{
$options = [
'length' => 255,
'null' => true,
'default' => null,
'collate' => 'en_US.UTF-8',
];

$result = $this->helper->getColumnOption($options);

// collate should be converted to collation for Phinx compatibility
// This is a bug: currently only MySQL/SQLServer convert this
$this->assertArrayNotHasKey('collate', $result, 'collate should be converted to collation');
$this->assertArrayHasKey('collation', $result, 'collation should be set from collate value');
$this->assertSame('en_US.UTF-8', $result['collation']);
}
}