Remove hardcoded default collation for MySQL tables (#1011)

* Remove hardcoded default collation for MySQL tables

Let MySQL/MariaDB use the database default collation instead of
forcing utf8mb4_unicode_ci on every table. This avoids collation
mismatches on servers with different defaults (e.g. MariaDB 11.8
uses utf8mb4_uca1400_ai_ci).

Users who need a specific collation can still set it explicitly
in their migrations.

Fixes #1010

* Add Migrations.default_collation config option

Allow configuring a global default collation for MySQL tables via
Configure::read('Migrations.default_collation'). When null (default),
tables inherit the database server collation. Per-table collation
options still take precedence.

Author: dereuromark

config/app.example.php

@@ -9,5 +9,6 @@
         'unsigned_primary_keys' => null, // Default false
         'unsigned_ints' => null, // Default false, make sure this is aligned with the above config
         'column_null_default' => null, // Default false
+        'default_collation' => null, // Default null (uses database collation). Set to e.g. 'utf8mb4_unicode_ci' to override.
     ],
 ];

docs/en/writing-migrations.rst

@@ -546,10 +546,9 @@ In addition, the MySQL adapter supports following options:
 Option     Platform         Description
 ========== ================ ===========
 comment    MySQL, Postgres  set a text comment on the table
-collation  MySQL, SqlServer the default collation for a table if different than the database.
+collation  MySQL, SqlServer set the table collation *(defaults to database collation)*
 row_format MySQL            set the table row format
 engine     MySQL            define table engine *(defaults to ``InnoDB``)*
-collation  MySQL            define table collation *(defaults to ``utf8mb4_unicode_ci``)*
 signed     MySQL            whether the primary key is ``signed``  *(defaults to ``false``)*
 limit      MySQL            set the maximum length for the primary key
 ========== ================ ===========

src/Db/Adapter/MysqlAdapter.php

@@ -251,9 +251,13 @@ public function createTable(TableMetadata $table, array $columns = [], array $in
         // This method is based on the MySQL docs here: https://dev.mysql.com/doc/refman/5.1/en/create-index.html
         $defaultOptions = [
             'engine' => 'InnoDB',
-            'collation' => 'utf8mb4_unicode_ci',
         ];
 
+        $collation = Configure::read('Migrations.default_collation');
+        if ($collation) {
+            $defaultOptions['collation'] = $collation;
+        }
+
         $options = array_merge(
             $defaultOptions,
             array_intersect_key($this->getOptions(), $defaultOptions),