mysql_upgrade
Contents
mysql_upgrade is a tool that checks and updates your tables to the latest version.
Usage
mysql_upgrade [--force] [--user=# --password --host=hostname --port=# --socket=# --protocol=tcp|socket|pipe|memory --verbose] OTHER_OPTIONS]
You should run mysql_upgrade after upgrading from one major MySQL/MariaDB release to another, such as from MySQL 5.0 to MariaDB 10.1 or MariaDB 10.0 to MariaDB 10.1. You also have to use mysql_upgrade after a direct "horizontal" migration from MySQL 5.5.40 to MariaDB 5.5.40. It's also safe to run mysql_upgrade for minor upgrades, as if there are no incompatibles between versions it does nothing.
On Windows Server 2008 or newer, mysql_upgrade needs to be run with administrator privileges.
It is recommended to make a backup of all the databases before running mysql_upgrade.
In most cases, mysql_upgrade should just take a few seconds. The main work of mysql_upgrade are:
- Update the system tables in the mysql database to the latest version (Normally just add new fields to a few tables)
- Check all tables that they are up to date (runs
CHECK TABLE table_name FOR UPGRADE). For tables that are not up to date, runsALTER TABLE table_name FORCEon the table to update it. A table is not up to date if:- Table uses an index for which there has been a collation change (rare)
- A format change in the storage engine requires an update (very rare)
mysql_upgrade is mainly a framework to call mysqlcheck. mysql_upgrade works by doing the following operations:
# Find out path to datadir echo "show show variables like 'datadir'" | mysql mysqlcheck --no-defaults --check-upgrade --auto-repair --databases mysql mysql_fix_privilege_tables mysqlcheck --no-defaults --all-databases --fix-db-names --fix-table-names --write-binlog mysqlcheck --no-defaults --check-upgrade --all-databases --auto-repair --write-binlog
The connect options given to mysql_upgrade are passed along to mysqlcheck and mysql.
The mysql_fix_privilege_tables script is not actually called; it's included as part of mysql_upgrade.
If you have a problem with mysql_upgrade, try run it in very verbose mode:
mysql_upgrade --verbose --verbose other-options
Command line options
The following groups are read from the my.cnf files: [mysql_upgrade] and [client].
The following options to handle option files may be given as the first argument:
| Option | Description |
|---|---|
--print-defaults | Print the program argument list and exit. |
--no-defaults | Don't read default options from any option file. |
--defaults-file=filename | Only read default options from the given file filename. |
--defaults-extra-file=filename | Read the file filename after the global files are read. |
The main arguments are:
| Option | Description |
|---|---|
-?, --help | Display this help message and exit. |
--basedir=path | Old option accepted for backward compatibility but ignored. |
--character-sets-dir=path | Old option accepted for backward compatibility but ignored. |
--compress=name | Old option accepted for backward compatibility but ignored. |
--datadir=name | Old option accepted for backward compatibility but ignored. |
-# [name], --debug[=name] | For debug builds, output debug log. |
--debug-check | Check memory and open file usage at exit. |
-T, --debug-info | Print some debug info at exit. |
--default-character-set=name | Old option accepted for backward compatibility but ignored. |
-f, --force | Force execution of mysqlcheck even if mysql_upgrade has already been executed for the current version of MariaDB. |
-h, --host=name | Connect to MariaDB on the given host. |
-p, --password[=name] | Password to use when connecting to server. If password is not given, it's solicited on the command line (which should be considered insecure). You can use an option file to avoid giving the password on the command line. |
-P, --port=name | Port number to use for connection or 0 for default to, in order of preference, my.cnf, the MYSQL_TCP_PORT environment variable, /etc/services, built-in default (3306). |
--protocol=name | The protocol to use for connection (tcp, socket, pipe, memory). |
--silent | Print less information. |
-S, --socket=name | For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. |
--ssl | Enable TLS for connection (automatically enabled with other flags). |
--ssl-ca=name | CA file in PEM format (check OpenSSL docs, implies --ssl). |
--ssl-capath=name | CA directory (check OpenSSL docs, implies --ssl). |
--ssl-cert=name | X509 cert in PEM format (implies --ssl). |
--ssl-cipher=name | SSL cipher to use (implies --ssl). |
--ssl-key=name | X509 key in PEM format (implies --ssl). |
--ssl-crl=name | Certificate revocation list (implies --ssl). |
--ssl-crlpath=name | Certificate revocation list path (implies --ssl). |
--ssl-verify-server-cert | Verify server's "Common Name" in its cert against hostname used when connecting. This option is disabled by default. |
-t, --tmpdir=name | Directory for temporary files. |
-s, --upgrade-system-tables | Only upgrade the system tables in the mysql database. Tables in other databases are not checked or touched. |
-u, --user=name | User for login if not current user. |
-v, --verbose | Display more output about the process, using it twice will print connection arguments; using it 3 times will print out all CHECK, RENAME and ALTER TABLE commands used during the check phase; using it 4 times (added in MariaDB 10.0.14) will also write out all mysqlcheck commands used. |
-V, --version | Output version information and exit. |
-k, --version-check | Run this program only if its 'server version' matches the version of the server to which it's connecting check. Note: the 'server version' of the program is the version of the MariaDB server with which it was built/distributed. (Defaults to on; use --skip-version-check to disable.) |
--write-binlog | All commands including those run by mysqlcheck are written to the binary log. Enabled by default. Use --skip-write-binlog when commands should not be sent to replication slaves. |
Differences between mysql_upgrade in MariaDB and MySQL
This is as of MariaDB 5.1.50:
- MariaDB will convert long table names properly.
- MariaDB will convert InnoDB tables (no need to do a dump/restore or
ALTER TABLE). - MariaDB will convert old archive tables to the new 5.1 format.
- "mysql_upgrade --verbose" will run "mysqlcheck --verbose" so that you get more information of what is happening. Running with 3 times --verbose will in MariaDB 10.0 print out all CHECK, RENAME and ALTER TABLE commands executed.
- The mysql.event table is upgraded live; no need to restart the server to use events if the event table has changed (MariaDB 10.0.22 and MariaDB 10.1.9).
- More descriptive output.
Speeding up mysql_upgrade
- If you are sure that all your tables are up to date with the current version, then you can run mysql_upgrade ---upgrade-system-tables, which will only fix your system tables in the mysql database to be compatible with the latest version.
The main reason to run mysql_upgrade on all your tables is to allow it to check that:
- There has not been any change in table formats between versions.
- This has not happened since MariaDB 5.1.
- If some of the tables are using an index for which we have changed sort order.
- This has not happened since MariaDB 5.5.
If you are 100% sure this applies to you, you can just run mysql_upgrade with the ---upgrade-system-tables option.
Symptoms of not having run mysql_upgrade when it was needed
- Errors in the error log that some system tables doesn't have all needed columns.
- Updates or searches on may not find the record.
- CHECKSUM TABLE may report the wrong checksum for MyISAM or Aria tables.
To fix issues like this, run mysql_upgrade, mysqlcheck, CHECK TABLE and if needed REPAIR TABLE on the wrong table.
Other usages
- mysql_upgrade will re-create any missing tables in the mysql database. It will not touch any data in existing tables.
