mysql_upgrade examines all tables in all databases for incompatibilities with the current version of MySQL Server. mysql_upgrade also upgrades the system tables so that you can take advantage of new privileges or capabilities that might have been added.
If mysql_upgrade finds that a table has a possible incompatibility, it performs a table check and, if problems are found, attempts a table repair. If the table cannot be repaired, see Section 2.13.4, “Rebuilding or Repairing Tables or Indexes” for manual table repair strategies.
If you install MySQL from RPM packages on Linux, you must install the server and client RPMs. mysql_upgrade is included in the server RPM but requires the client RPM because the latter includes mysqlcheck. (See Section 2.5.1, “Installing MySQL on Linux Using RPM Packages”.)
On Windows Server 2008, Vista, and newer, you must run mysql_upgrade with administrator privileges. You can do this by running a Command Prompt as Administrator and running the command. Failure to do so may result in the upgrade failing to execute correctly.
You should always back up your current MySQL installation before performing an upgrade. See Section 7.2, “Database Backup Methods”.
Some upgrade incompatibilities may require special handling before you upgrade your MySQL installation and run mysql_upgrade. See Section 2.13.1, “Upgrading MySQL”, for instructions on determining whether any such incompatibilities apply to your installation and how to handle them.
To use mysql_upgrade, make sure that the server is running. Then invoke it like this:
After running mysql_upgrade, stop the server and restart it so that any changes made to the system tables take effect.
If you have multiple MySQL server instances running, invoke mysql_upgrade with connection parameters appropriate for connecting to the desired server. For example, with servers running on the local host on parts 3306 through 3308, upgrade each of them by connecting to the appropriate port:
mysql_upgrade --protocol=tcp -P 3306 [shell>
mysql_upgrade --protocol=tcp -P 3307 [shell>
mysql_upgrade --protocol=tcp -P 3308 [
For local host connections on Unix, the
--protocol=tcp option forces a connection using
TCP/IP rather than the Unix socket file.
mysql_upgrade executes the following commands to check and repair tables and to upgrade the system tables:
mysqlcheck --no-defaults --all-databases --fix-db-names --fix-table-names mysqlcheck --no-defaults --check-upgrade --all-databases --auto-repair mysql <
Notes about the preceding commands:
Because mysql_upgrade invokes
mysqlcheck with the
it processes all tables in all databases, which might take a
long time to complete. Each table is locked and therefore
unavailable to other sessions while it is being processed.
Check and repair operations can be time-consuming,
particularly for large tables.
fix_priv_tables represents a
script generated internally by
mysql_upgrade that contains SQL
statements to upgrade the tables in the
Prior to MySQL 5.1.31, mysql_upgrade does
not run the second mysqlcheck command,
which is necessary to re-encode database or table names that
contain nonalphanumeric characters. (They still appear after
the upgrade with the
described in Section 9.2.3, “Mapping of Identifiers to File Names”.) If you
have such database or table names, execute the second
mysqlcheck command manually after
All checked and repaired tables are marked with the current MySQL version number. This ensures that next time you run mysql_upgrade with the same version of the server, it can tell whether there is any need to check or repair the table again.
mysql_upgrade also saves the MySQL version
number in a file named
in the data directory. This is used to quickly check whether all
tables have been checked for this release so that table-checking
can be skipped. To ignore this file and perform the check
regardless, use the
In MySQL 5.1.7, mysql_upgrade was added as a shell script and worked only for Unix systems. As of MySQL 5.1.10, mysql_upgrade is an executable binary and is available on all systems.
mysql_upgrade supports the following options,
which can be specified on the command line or in the
[client] groups of an option file.
Unrecognized options are passed to
mysqlcheck. For information about option
files, see Section 4.2.6, “Using Option Files”.
Display a short help message and exit.
The path to the MySQL installation directory. This option is accepted for backward compatibility but ignored.
The directory where character sets are installed. See Section 10.5, “Character Set Configuration”. This option was added in MySQL 5.1.13.
Compress all information sent between the client and the server if both support compression. This option was added in MySQL 5.1.13.
The path to the data directory. This option is accepted for backward compatibility but ignored.
Write a debugging log. A typical
debug_options string is
The default is
Print some debugging information when the program exits. This option was added in MySQL 5.1.21.
Print some debugging information when the program exits.
charset_name as the default
character set. See Section 10.5, “Character Set Configuration”.
This option was added in MySQL 5.1.13.
Read this option file after the global option file but (on
Unix) before the user option file. If the file does not
exist or is otherwise inaccessible, an error occurs.
file_name is the full path name
to the file.
Use only the given option file. If the file does not exist
or is otherwise inaccessible, an error occurs.
file_name is the full path name
to the file.
Read not only the usual option groups, but also groups with
the usual names and a suffix of
str. For example,
mysql_upgrade normally reads the
[mysql_upgrade] groups. If the
option is given, mysql_upgrade also reads
mysql_upgrade_info file and
force execution even if mysql_upgrade has
already been executed for the current version of MySQL.
Connect to the MySQL server on the given host. This option was added in MySQL 5.1.13.
Do not read any option files. If program startup fails due
to reading unknown options from an option file,
--no-defaults can be
used to prevent them from being read.
The password to use when connecting to the server. If you
use the short option form (
cannot have a space between the option
and the password. If you omit the
password value following the
-p option on the command line,
mysql_upgrade prompts for one.
Specifying a password on the command line should be considered insecure. See Section 220.127.116.11, “End-User Guidelines for Password Security”. You can use an option file to avoid giving the password on the command line.
On Windows, connect to the server using a named pipe. This option applies only if the server supports named-pipe connections. This option was added in MySQL 5.1.13.
The TCP/IP port number to use for the connection.
Print the program name and all options that it gets from option files.
The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want. For details on the permissible values, see Section 4.2.2, “Connecting to the MySQL Server”.
On Windows, the shared-memory name to use, for connections
made using shared memory to a local server. The default
MYSQL. The shared-memory name is
The server must be started with the
--shared-memory option to
enable shared-memory connections. This option was added in
For connections to
localhost, the Unix
socket file to use, or, on Windows, the name of the named
pipe to use.
Options that begin with
--ssl specify whether to
connect to the server using SSL and indicate where to find
SSL keys and certificates. See
Section 18.104.22.168, “SSL Command Options”. These options were added in
The path name of the directory to use for creating temporary files. This option was added in MySQL 5.1.25.
The MySQL user name to use when connecting to the server.
The default user name is
Verbose mode. Print more information about what the program does.
Cause binary logging to be enabled while
mysql_upgrade runs. This is the default
behavior; to disable binary logging during the upgrade, use
the inverse of this option (that is, start the program with
This option was introduced in MySQL 5.1.40.