Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 43.3Mb
PDF (A4) - 43.4Mb
Man Pages (TGZ) - 297.3Kb
Man Pages (Zip) - 402.5Kb
Info (Gzip) - 4.3Mb
Info (Zip) - 4.3Mb
Excerpts from this Manual

MySQL 8.0 Reference Manual  / ...  / MySQL Programs  / Installation-Related Programs  /  mysql_upgrade — Check and Upgrade MySQL Tables

6.4.5 mysql_upgrade — Check and Upgrade MySQL Tables

Note

As of MySQL 8.0.16, the MySQL server performs the upgrade tasks previously handled bymysql_upgrade (for details, seeSection 3.4, “What the MySQL Upgrade Process Upgrades”). Consequently,mysql_upgrade is unneeded and is deprecated as of that version; expect it to be removed in a future version of MySQL. Becausemysql_upgrade no longer performs upgrade tasks, it exits with status 0 unconditionally.

Each time you upgrade MySQL, you should executemysql_upgrade, which looks for incompatibilities with the upgraded MySQL server:

  • It upgrades the system tables in themysql schema so that you can take advantage of new privileges or capabilities that might have been added.

  • It upgrades the Performance Schema,INFORMATION_SCHEMA, andsys schema.

  • It examines user schemas.

Ifmysql_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, seeSection 3.14, “Rebuilding or Repairing Tables or Indexes” for manual table repair strategies.

mysql_upgrade communicates directly with the MySQL server, sending it the SQL statements required to perform an upgrade.

Caution

You should always back up your current MySQL installationbefore performing an upgrade. SeeSection 9.2, “Database Backup Methods”.

Some upgrade incompatibilities may require special handlingbefore upgrading your MySQL installation and runningmysql_upgrade. SeeChapter 3,Upgrading MySQL, for instructions on determining whether any such incompatibilities apply to your installation and how to handle them.

Usemysql_upgrade like this:

  1. Ensure that the server is running.

  2. Invokemysql_upgrade to upgrade the system tables in themysql schema and check and repair tables in other schemas:

    mysql_upgrade [options]
  3. Stop the server and restart it so that any system table changes take effect.

If you have multiple MySQL server instances to upgrade, invokemysql_upgrade with connection parameters appropriate for connecting to each of the desired servers. 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 [other_options]mysql_upgrade --protocol=tcp -P 3307 [other_options]mysql_upgrade --protocol=tcp -P 3308 [other_options]

For local host connections on Unix, the--protocol=tcp option forces a connection using TCP/IP rather than the Unix socket file.

By default,mysql_upgrade runs as the MySQLroot user. If theroot password is expired when you runmysql_upgrade, it displays a message that your password is expired and thatmysql_upgrade failed as a result. To correct this, reset theroot password to unexpire it and runmysql_upgrade again. First, connect to the server asroot:

$> mysql -u root -pEnter password: ****  <- enter root password here

Reset the password usingALTER USER:

mysql> ALTER USER USER() IDENTIFIED BY 'root-password';

Then exitmysql and runmysql_upgrade again:

$> mysql_upgrade [options]
Note

If you run the server with thedisabled_storage_engines system variable set to disable certain storage engines (for example,MyISAM),mysql_upgrade might fail with an error like this:

mysql_upgrade: [ERROR] 3161: Storage engine MyISAM is disabled(Table creation is disallowed).

To handle this, restart the server withdisabled_storage_engines disabled. Then you should be able to runmysql_upgrade successfully. After that, restart the server withdisabled_storage_engines set to its original value.

Unless invoked with the--upgrade-system-tables option,mysql_upgrade processes all tables in all user schemas as necessary. Table checking 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. Table checking uses theFOR UPGRADE option of theCHECK TABLE statement. For details about what this option entails, seeSection 15.7.3.2, “CHECK TABLE Statement”.

mysql_upgrade marks all checked and repaired tables with the current MySQL version number. This ensures that the next time you runmysql_upgrade with the same version of the server, it can be determined whether there is any need to check or repair a given table again.

mysql_upgrade saves the MySQL version number in a file namedmysql_upgrade_info 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--force option.

Note

Themysql_upgrade_info file is deprecated; expect it to be removed in a future version of MySQL.

mysql_upgrade checksmysql.user system table rows and, for any row with an emptyplugin column, sets that column to'mysql_native_password' if the credentials use a hash format compatible with that plugin. Rows with a pre-4.1 password hash must be upgraded manually.

mysql_upgrade does not upgrade the contents of the time zone tables or help tables. For upgrade instructions, seeSection 7.1.15, “MySQL Server Time Zone Support”, andSection 7.1.17, “Server-Side Help Support”.

Unless invoked with the--skip-sys-schema option,mysql_upgrade installs thesys schema if it is not installed, and upgrades it to the current version otherwise. An error occurs if asys schema exists but has noversion view, on the assumption that its absence indicates a user-created schema:

A sys schema exists with no sys.version view. Ifyou have a user created sys schema, this must be renamed for theupgrade to succeed.

To upgrade in this case, remove or rename the existingsys schema first.

mysql_upgrade supports the following options, which can be specified on the command line or in the[mysql_upgrade] and[client] groups of an option file. For information about option files used by MySQL programs, seeSection 6.2.2.2, “Using Option Files”.

Table 6.11 mysql_upgrade Options

Option NameDescriptionIntroducedDeprecated
--bind-addressUse specified network interface to connect to MySQL Server
--character-sets-dirDirectory where character sets are installed
--compressCompress all information sent between client and server8.0.18
--compression-algorithmsPermitted compression algorithms for connections to server8.0.18
--debugWrite debugging log
--debug-checkPrint debugging information when program exits
--debug-infoPrint debugging information, memory, and CPU statistics when program exits
--default-authAuthentication plugin to use
--default-character-setSpecify default character set
--defaults-extra-fileRead named option file in addition to usual option files
--defaults-fileRead only named option file
--defaults-group-suffixOption group suffix value
--forceForce execution even if mysql_upgrade has already been executed for current MySQL version
--get-server-public-keyRequest RSA public key from server
--helpDisplay help message and exit
--hostHost on which MySQL server is located
--login-pathRead login path options from .mylogin.cnf
--max-allowed-packetMaximum packet length to send to or receive from server
--net-buffer-lengthBuffer size for TCP/IP and socket communication
--no-defaultsRead no option files
--passwordPassword to use when connecting to server
--pipeConnect to server using named pipe (Windows only)
--plugin-dirDirectory where plugins are installed
--portTCP/IP port number for connection
--print-defaultsPrint default options
--protocolTransport protocol to use
--server-public-key-pathPath name to file containing RSA public key
--shared-memory-base-nameShared-memory name for shared-memory connections (Windows only)
--skip-sys-schemaDo not install or upgrade sys schema
--socketUnix socket file or Windows named pipe to use
--ssl-caFile that contains list of trusted SSL Certificate Authorities
--ssl-capathDirectory that contains trusted SSL Certificate Authority certificate files
--ssl-certFile that contains X.509 certificate
--ssl-cipherPermissible ciphers for connection encryption
--ssl-crlFile that contains certificate revocation lists
--ssl-crlpathDirectory that contains certificate revocation-list files
--ssl-fips-modeWhether to enable FIPS mode on client side8.0.34
--ssl-keyFile that contains X.509 key
--ssl-modeDesired security state of connection to server
--ssl-session-dataFile that contains SSL session data8.0.29
--ssl-session-data-continue-on-failed-reuseWhether to establish connections if session reuse fails8.0.29
--tls-ciphersuitesPermissible TLSv1.3 ciphersuites for encrypted connections8.0.16
--tls-versionPermissible TLS protocols for encrypted connections
--upgrade-system-tablesUpdate only system tables, not user schemas
--userMySQL user name to use when connecting to server
--verboseVerbose mode
--version-checkCheck for proper server version
--write-binlogWrite all statements to binary log
--zstd-compression-levelCompression level for connections to server that use zstd compression8.0.18

  • --help

    Command-Line Format--help

    Display a short help message and exit.

  • --bind-address=ip_address

    Command-Line Format--bind-address=ip_address

    On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server.

  • --character-sets-dir=dir_name

    Command-Line Format--character-sets-dir=dir_name
    TypeDirectory name

    The directory where character sets are installed. SeeSection 12.15, “Character Set Configuration”.

  • --compress,-C

    Command-Line Format--compress[={OFF|ON}]
    Deprecated8.0.18
    TypeBoolean
    Default ValueOFF

    Compress all information sent between the client and the server if possible. SeeSection 6.2.8, “Connection Compression Control”.

    As of MySQL 8.0.18, this option is deprecated. Expect it to be removed in a future version of MySQL. SeeConfiguring Legacy Connection Compression.

  • --compression-algorithms=value

    Command-Line Format--compression-algorithms=value
    Introduced8.0.18
    TypeSet
    Default Valueuncompressed
    Valid Values

    zlib

    zstd

    uncompressed

    The permitted compression algorithms for connections to the server. The available algorithms are the same as for theprotocol_compression_algorithms system variable. The default value isuncompressed.

    For more information, seeSection 6.2.8, “Connection Compression Control”.

    This option was added in MySQL 8.0.18.

  • --debug[=debug_options],-# [debug_options]

    Command-Line Format--debug[=#]
    TypeString
    Default Valued:t:O,/tmp/mysql_upgrade.trace

    Write a debugging log. A typicaldebug_options string isd:t:o,file_name. The default isd:t:O,/tmp/mysql_upgrade.trace.

  • --debug-check

    Command-Line Format--debug-check
    TypeBoolean

    Print some debugging information when the program exits.

  • --debug-info,-T

    Command-Line Format--debug-info
    TypeBoolean
    Default ValueFALSE

    Print debugging information and memory and CPU usage statistics when the program exits.

  • --default-auth=plugin

    Command-Line Format--default-auth=plugin
    TypeString

    A hint about which client-side authentication plugin to use. SeeSection 8.2.17, “Pluggable Authentication”.

  • --default-character-set=charset_name

    Command-Line Format--default-character-set=name
    TypeString

    Usecharset_name as the default character set. SeeSection 12.15, “Character Set Configuration”.

  • --defaults-extra-file=file_name

    Command-Line Format--defaults-extra-file=file_name
    TypeFile name

    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. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

    For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

  • --defaults-file=file_name

    Command-Line Format--defaults-file=file_name
    TypeFile name

    Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. Iffile_name is not an absolute path name, it is interpreted relative to the current directory.

    For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

  • --defaults-group-suffix=str

    Command-Line Format--defaults-group-suffix=str
    TypeString

    Read not only the usual option groups, but also groups with the usual names and a suffix ofstr. For example,mysql_upgrade normally reads the[client] and[mysql_upgrade] groups. If this option is given as--defaults-group-suffix=_other,mysql_upgrade also reads the[client_other] and[mysql_upgrade_other] groups.

    For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

  • --force

    Command-Line Format--force
    TypeBoolean

    Ignore themysql_upgrade_info file and force execution even ifmysql_upgrade has already been executed for the current version of MySQL.

  • --get-server-public-key

    Command-Line Format--get-server-public-key
    TypeBoolean

    Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with thecaching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

    If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

    For information about thecaching_sha2_password plugin, seeSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.

  • --host=host_name,-hhost_name

    Command-Line Format--host=name
    TypeString

    Connect to the MySQL server on the given host.

  • --login-path=name

    Command-Line Format--login-path=name
    TypeString

    Read options from the named login path in the.mylogin.cnf login path file. Alogin path is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use themysql_config_editor utility. SeeSection 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

    For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

  • --max-allowed-packet=value

    Command-Line Format--max-allowed-packet=value
    TypeInteger
    Default Value25165824
    Minimum Value4096
    Maximum Value2147483648

    The maximum size of the buffer for client/server communication. The default value is 24MB. The minimum and maximum values are 4KB and 2GB.

  • --net-buffer-length=value

    Command-Line Format--net-buffer-length=value
    TypeInteger
    Default Value1047552
    Minimum Value4096
    Maximum Value16777216

    The initial size of the buffer for client/server communication. The default value is 1MB − 1KB. The minimum and maximum values are 4KB and 16MB.

  • --no-defaults

    Command-Line Format--no-defaults

    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 exception is that the.mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when--no-defaults is used. To create.mylogin.cnf, use themysql_config_editor utility. SeeSection 6.6.7, “mysql_config_editor — MySQL Configuration Utility”.

    For additional information about this and other option-file options, seeSection 6.2.2.3, “Command-Line Options that Affect Option-File Handling”.

  • --password[=password],-p[password]

    Command-Line Format--password[=name]
    TypeString

    The password of the MySQL account used for connecting to the server. The password value is optional. If not given,mysql_upgrade prompts for one. If given, there must beno space between--password= or-p and the password following it. If no password option is specified, the default is to send no password.

    Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. SeeSection 8.1.2.1, “End-User Guidelines for Password Security”.

    To explicitly specify that there is no password and thatmysql_upgrade should not prompt for one, use the--skip-password option.

  • --pipe,-W

    Command-Line Format--pipe
    TypeString

    On Windows, connect to the server using a named pipe. This option applies only if the server was started with thenamed_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_group system variable.

  • --plugin-dir=dir_name

    Command-Line Format--plugin-dir=dir_name
    TypeDirectory name

    The directory in which to look for plugins. Specify this option if the--default-auth option is used to specify an authentication plugin butmysql_upgrade does not find it. SeeSection 8.2.17, “Pluggable Authentication”.

  • --port=port_num,-Pport_num

    Command-Line Format--port=#
    TypeNumeric

    For TCP/IP connections, the port number to use.

  • --print-defaults

    Command-Line Format--print-defaults

    Print the program name and all options that it gets from option files.

  • --protocol={TCP|SOCKET|PIPE|MEMORY}

    Command-Line Format--protocol=name
    TypeString

    The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, seeSection 6.2.7, “Connection Transport Protocols”.

  • --server-public-key-path=file_name

    Command-Line Format--server-public-key-path=file_name
    TypeFile name

    The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with thesha256_password orcaching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection.

    If--server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over--get-server-public-key.

    Forsha256_password, this option applies only if MySQL was built using OpenSSL.

    For information about thesha256_password andcaching_sha2_password plugins, seeSection 8.4.1.3, “SHA-256 Pluggable Authentication”, andSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.

  • --shared-memory-base-name=name

    Command-Line Format--shared-memory-base-name=name
    Platform SpecificWindows

    On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value isMYSQL. The shared-memory name is case-sensitive.

    This option applies only if the server was started with theshared_memory system variable enabled to support shared-memory connections.

  • --skip-sys-schema

    Command-Line Format--skip-sys-schema
    TypeBoolean
    Default ValueFALSE

    By default,mysql_upgrade installs thesys schema if it is not installed, and upgrades it to the current version otherwise. The--skip-sys-schema option suppresses this behavior.

  • --socket=path,-Spath

    Command-Line Format--socket={file_name|pipe_name}
    TypeString

    For connections tolocalhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.

    On Windows, this option applies only if the server was started with thenamed_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by thenamed_pipe_full_access_group system variable.

  • --ssl*

    Options that begin with--ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. SeeCommand Options for Encrypted Connections.

  • --ssl-fips-mode={OFF|ON|STRICT}

    Command-Line Format--ssl-fips-mode={OFF|ON|STRICT}
    Deprecated8.0.34
    TypeEnumeration
    Default ValueOFF
    Valid Values

    OFF

    ON

    STRICT

    Controls whether to enable FIPS mode on the client side. The--ssl-fips-mode option differs from other--ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. SeeSection 8.8, “FIPS Support”.

    These--ssl-fips-mode values are permitted:

    • OFF: Disable FIPS mode.

    • ON: Enable FIPS mode.

    • STRICT: Enablestrict FIPS mode.

    Note

    If the OpenSSL FIPS Object Module is not available, the only permitted value for--ssl-fips-mode isOFF. In this case, setting--ssl-fips-mode toON orSTRICT causes the client to produce a warning at startup and to operate in non-FIPS mode.

    As of MySQL 8.0.34, this option is deprecated. Expect it to be removed in a future version of MySQL.

  • --tls-ciphersuites=ciphersuite_list

    Command-Line Format--tls-ciphersuites=ciphersuite_list
    Introduced8.0.16
    TypeString

    The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, seeSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

    This option was added in MySQL 8.0.16.

  • --tls-version=protocol_list

    Command-Line Format--tls-version=protocol_list
    TypeString
    Default Value (≥ 8.0.16)

    TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 (OpenSSL 1.1.1 or higher)

    TLSv1,TLSv1.1,TLSv1.2 (otherwise)

    Default Value (≤ 8.0.15)TLSv1,TLSv1.1,TLSv1.2

    The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, seeSection 8.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

  • --upgrade-system-tables,-s

    Command-Line Format--upgrade-system-tables
    TypeBoolean

    Upgrade only the system tables in themysql schema, do not upgrade user schemas.

  • --user=user_name,-uuser_name

    Command-Line Format--user=name
    TypeString

    The user name of the MySQL account to use for connecting to the server. The default user name isroot.

  • --verbose

    Command-Line Format--verbose
    TypeBoolean

    Verbose mode. Print more information about what the program does.

  • --version-check,-k

    Command-Line Format--version-check
    TypeBoolean

    Check the version of the server to whichmysql_upgrade is connecting to verify that it is the same as the version for whichmysql_upgrade was built. If not,mysql_upgrade exits. This option is enabled by default; to disable the check, use--skip-version-check.

  • --write-binlog

    Command-Line Format--write-binlog
    TypeBoolean
    Default ValueOFF

    By default, binary logging bymysql_upgrade is disabled. Invoke the program with--write-binlog if you want its actions to be written to the binary log.

    When the server is running with global transaction identifiers (GTIDs) enabled (gtid_mode=ON), do not enable binary logging bymysql_upgrade.

  • --zstd-compression-level=level

    Command-Line Format--zstd-compression-level=#
    Introduced8.0.18
    TypeInteger

    The compression level to use for connections to the server that use thezstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The defaultzstd compression level is 3. The compression level setting has no effect on connections that do not usezstd compression.

    For more information, seeSection 6.2.8, “Connection Compression Control”.

    This option was added in MySQL 8.0.18.