Description
Since version 4.2, WordPress has been detecting the MySQL version and if it’s version 5.5.3 or greater, automatically selecting the ‘utf8mb4_unicode_520_ci’ Collation Algorithm. This works well until you need to migrate your database to an older version of MySQL that does not support the utf8mb4 algorithms. Then, you run into the error message: “#1273 – Unknown collation: ‘utf8mb4_unicode_520_ci’” when importing your database.
With the WordPress 5.7 update and WooCommerce 5.1, some users are reporting an error: “SQLSTATE[HY000]: General error: 1267 Illegal mix of collations (utf8mb4_unicode_520_ci,IMPLICIT) and (utf8mb4_unicode_ci,IMPLICIT)”. The Database Collation Fix tool also fixes this issue by changing the collation of all columns in your database to use the same algorithm, removing the “mix” of collations.
Usage Scenarios:
While the plugin will work in any WordPress install: local, staging or live, it is specially designed to work with DesktopServer. Its process will be triggered and change the collation types on all database tables during any DesktopServer Create Site, Copy Site, Move Site, Import and Export operations. This allows you to import and export sites in the most compatible ways during deployments. If you would like to use this with DesktopServer as a Design Time plugin, you can install this in your /xampplite/ds-plugins/ directory and it can then be automatically activated and used with all of your local development web sites.
Alternatively, you can install this as a regular WordPress plugin on any site. Once activated, all of your database tables will be updated to use the more portable Collation Algorithm. If you are migrating your web site, you can install and activate the plugin then perform your database export. Once you have migrated your site, you can deactivate and remove the plugin as it would be no longer needed. If you will be exporting and/or migrating your site repeatedly, such as when using it on a test or staging install, you can leave the plugin active indefinitely and it will continue to monitor and update your database tables automatically, allowing you to perform migrations at any time. This is ideal in situations where you are installing or testing plugins that may create their own database tables, as these tables may be created with the newer Collation Algorithms that are not as portable.
How it Works:
The Database Collation Fix tool converts database tables using ‘utf8mb4_unicode_520_ci’ or ‘utf8_unicode_520_ci’ Collation Algorithms to a more portable ‘utf8mb4_unicode_ci’ collation on a once daily basis. It also modifies any column-specific collation statements, not just the default table collation. This means that you can install this plugin and it will continue to monitor all of your database tables and convert them to the more portable Collation Algorithm automatically.
This tool will convert your database tables and columns to use the ‘utf8mb4_unicode_ci’ Collation Algorithm. This can be modified to any other Collation Algorithm you wish by updating your wp-config.php file and adding or changing the following setting:
define('DB_COLLATE', 'utf8_general_ci');
You can use ‘utf8_general_ci’ or ‘utf8’ or any other Collation Algorithm supported by your database. See https://dev.mysql.com/doc/refman/5.7/en/charset-mysql.html for a full description of MySQL’s Character Set and Collation Algorithm selections.
Support:
Support Details: We are happy to provide support and help troubleshoot issues. Visit our Contact page at https://davejesch.com/contact/ or submit a support request on the WordPress plugin page.
We are not responsible for any loss of data that may occur as a result of using this tool. We strongly recommend performing a site and database backup before testing and using this tool. However, should you experience such an issue, we want to know about it right away.
Installation
Installation instructions: To install, do the following:
- From the dashboard of your site, navigate to Plugins –> Add New.
- Select the “Upload Plugin” button.
- Click on the “Choose File” button to upload your file.
- When the Open dialog appears select the databasecollationfix.zip file from your desktop.
- Follow the on-screen instructions and wait until the upload is complete.
- When finished, activate the plugin via the prompt. A confirmation message will be displayed.
or, you can upload the files directly to your server.
- Upload all of the files in
databasecollationfix.zipto your/wp-content/plugins/databasecollationfixdirectory. - Activate the plugin through the ‘Plugins’ menu in WordPress.
FAQ
-
Is this safe?
-
Yes. The Database Collation Fix tool does not change any data. It only changes the Collation Algorithm that specified for your database columns and indexes.
-
Do I need to backup my data before using this?
-
Yes. Always backup your site before making database changes. The Database Collation Fix tool is unlikely to cause any problems but there is still a small chance that something else (like the version of MySQL/MariaDB that you’re using) can have a compatibility issue.
-
Once my tables are fixed, do I still need to use this tool?
-
No. The Database Collation Fix tool changes the database. It only needs to do this once. However, future versions of WordPress or one or more of your plugins can also make database changes. These future changes may require updates to keep your Collation Algorithms updated. If you leave the Database Collation Fix tool active, it will scan your database once per day and look for any tables that need to be adjusted, fixing them automatically.
Reviews
Contributors & Developers
“Database Collation Fix” is open source software. The following people have contributed to this plugin.
Contributors
“Database Collation Fix” has been translated into 1 locale. Thank you to the translators for their contributions.
Translate “Database Collation Fix” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.2.10 – Jan 16, 2024
Fix bug: default clause on column not preserved. Thanks drylek.
1.2.9 – May 6, 2023
Update text domain to match plugin slug.
1.2.8 – Apr 24, 2023
Fix CSRF vulnerability.
1.2.7 – Apr 1, 2021
Add request method check; update readme.txt contents.
1.2.6 – Aug 2, 2018
Add handling for FULLTEXT indexes.
1.2.5 – May 11, 2018
Add handling for ‘enum’ column type when looking for things to update.
1.2.4 – Jul 26, 2017
Add feature to allow user to select Collation Algorithm for on demand updates.
1.2.2 – Jul 12 2017
Fix error display by not scheduling cron during WP install.
1.2 – Feb 24, 2017
Initial release to WordPress repository.
1.1 – Dec 13, 2016
- check for non-empty DB_COLLATION specification.
1.0 – Oct 14, 2016
- Initial Release