Database Collation Fix

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.

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. For more information on DesktopServer and local development tools, please visit our web site at: https://serverpress.com/get-desktopserver/.

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 supported collation algorithm. 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 http://serverpress.com/contact/. Users should know however, that we check the WordPress.org support forums once a week on Wednesdays from 6pm to 8pm PST (UTC -8).

ServerPress, LLC is 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.

We welcome feedback and Pull Requests for this plugin via our public GitHub repository located at: https://github.com/ServerPress/databasecollationfix

Installation

Installation instructions: To install, do the following:

  1. From the dashboard of your site, navigate to Plugins –> Add New.
  2. Select the “Upload Plugin” button.
  3. Click on the “Choose File” button to upload your file.
  4. When the Open dialog appears select the databasecollationfix.zip file from your desktop.
  5. Follow the on-screen instructions and wait until the upload is complete.
  6. When finished, activate the plugin via the prompt. A confirmation message will be displayed.

or, you can upload the files directly to your server.

  1. Upload all of the files in databasecollationfix.zip to your /wp-content/plugins/databasecollationfix directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.

Reviews

This plugin is pure asprin for a MAJOR headache!

I do a lot of migration of WordPress between dev, staging and the live sites. For various reasons, the live webhost uses an older version of MySQL and cannot deal with the utf8mb4_unicode_520_ci collation type. This breaks all of my migration scripts if any new plugins, etc. use that type.

This has been the simplest fix. THANK you!

Perfect quick fix solution

I develop on local WP sites and tend to forget that the MySQL server version is newer than one of the production versions I’m forced to use. This plugin solves the issue and is the best solution I’ve seen – no need to mess around with a text editor, etc.

Thank you, Dave Jesch, for creating it.

Read all 4 reviews

Contributors & Developers

“Database Collation Fix” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

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