PDF (A4) - 43.4Mb
Man Pages (TGZ) - 297.3Kb
Man Pages (Zip) - 402.5Kb
Info (Gzip) - 4.3Mb
Info (Zip) - 4.3Mb
MySQL Globalization
MySQL Information Schema
MySQL Installation Guide
Security in MySQL
Starting and Stopping MySQL
MySQL and Linux/Unix
MySQL and Windows
MySQL and macOS
MySQL and Solaris
Building MySQL from Source
MySQL Restrictions and Limitations
MySQL Partitioning
MySQL Tutorial
MySQL Performance Schema
MySQL Replication
Using the MySQL Yum Repository
MySQL NDB Cluster 8.0
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 the
mysqlschema so that you can take advantage of new privileges or capabilities that might have been added.It upgrades the Performance Schema,
INFORMATION_SCHEMA, andsysschema.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.
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:
Ensure that the server is running.
Invokemysql_upgrade to upgrade the system tables in the
mysqlschema and check and repair tables in other schemas:mysql_upgrade [options]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] 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.
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 Name | Description | Introduced | Deprecated |
|---|---|---|---|
| --bind-address | Use specified network interface to connect to MySQL Server | ||
| --character-sets-dir | Directory where character sets are installed | ||
| --compress | Compress all information sent between client and server | 8.0.18 | |
| --compression-algorithms | Permitted compression algorithms for connections to server | 8.0.18 | |
| --debug | Write debugging log | ||
| --debug-check | Print debugging information when program exits | ||
| --debug-info | Print debugging information, memory, and CPU statistics when program exits | ||
| --default-auth | Authentication plugin to use | ||
| --default-character-set | Specify default character set | ||
| --defaults-extra-file | Read named option file in addition to usual option files | ||
| --defaults-file | Read only named option file | ||
| --defaults-group-suffix | Option group suffix value | ||
| --force | Force execution even if mysql_upgrade has already been executed for current MySQL version | ||
| --get-server-public-key | Request RSA public key from server | ||
| --help | Display help message and exit | ||
| --host | Host on which MySQL server is located | ||
| --login-path | Read login path options from .mylogin.cnf | ||
| --max-allowed-packet | Maximum packet length to send to or receive from server | ||
| --net-buffer-length | Buffer size for TCP/IP and socket communication | ||
| --no-defaults | Read no option files | ||
| --password | Password to use when connecting to server | ||
| --pipe | Connect to server using named pipe (Windows only) | ||
| --plugin-dir | Directory where plugins are installed | ||
| --port | TCP/IP port number for connection | ||
| --print-defaults | Print default options | ||
| --protocol | Transport protocol to use | ||
| --server-public-key-path | Path name to file containing RSA public key | ||
| --shared-memory-base-name | Shared-memory name for shared-memory connections (Windows only) | ||
| --skip-sys-schema | Do not install or upgrade sys schema | ||
| --socket | Unix socket file or Windows named pipe to use | ||
| --ssl-ca | File that contains list of trusted SSL Certificate Authorities | ||
| --ssl-capath | Directory that contains trusted SSL Certificate Authority certificate files | ||
| --ssl-cert | File that contains X.509 certificate | ||
| --ssl-cipher | Permissible ciphers for connection encryption | ||
| --ssl-crl | File that contains certificate revocation lists | ||
| --ssl-crlpath | Directory that contains certificate revocation-list files | ||
| --ssl-fips-mode | Whether to enable FIPS mode on client side | 8.0.34 | |
| --ssl-key | File that contains X.509 key | ||
| --ssl-mode | Desired security state of connection to server | ||
| --ssl-session-data | File that contains SSL session data | 8.0.29 | |
| --ssl-session-data-continue-on-failed-reuse | Whether to establish connections if session reuse fails | 8.0.29 | |
| --tls-ciphersuites | Permissible TLSv1.3 ciphersuites for encrypted connections | 8.0.16 | |
| --tls-version | Permissible TLS protocols for encrypted connections | ||
| --upgrade-system-tables | Update only system tables, not user schemas | ||
| --user | MySQL user name to use when connecting to server | ||
| --verbose | Verbose mode | ||
| --version-check | Check for proper server version | ||
| --write-binlog | Write all statements to binary log | ||
| --zstd-compression-level | Compression level for connections to server that use zstd compression | 8.0.18 |
Command-Line Format --helpDisplay a short help message and exit.
Command-Line Format --bind-address=ip_addressOn a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server.
Command-Line Format --character-sets-dir=dir_nameType Directory name The directory where character sets are installed. SeeSection 12.15, “Character Set Configuration”.
--compress,-CCommand-Line Format --compress[={OFF|ON}]Deprecated 8.0.18 Type Boolean Default Value OFFCompress 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=valueCommand-Line Format --compression-algorithms=valueIntroduced 8.0.18 Type Set Default Value uncompressedValid Values zlibzstduncompressedThe permitted compression algorithms for connections to the server. The available algorithms are the same as for the
protocol_compression_algorithmssystem 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[=#]Type String Default Value d:t:O,/tmp/mysql_upgrade.traceWrite a debugging log. A typical
debug_optionsstring isd:t:o,. The default isfile_named:t:O,/tmp/mysql_upgrade.trace.Command-Line Format --debug-checkType Boolean Print some debugging information when the program exits.
--debug-info,-TCommand-Line Format --debug-infoType Boolean Default Value FALSEPrint debugging information and memory and CPU usage statistics when the program exits.
Command-Line Format --default-auth=pluginType String A hint about which client-side authentication plugin to use. SeeSection 8.2.17, “Pluggable Authentication”.
--default-character-set=charset_nameCommand-Line Format --default-character-set=nameType String Use
charset_nameas the default character set. SeeSection 12.15, “Character Set Configuration”.--defaults-extra-file=file_nameCommand-Line Format --defaults-extra-file=file_nameType File 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. If
file_nameis 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”.
Command-Line Format --defaults-file=file_nameType File name Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If
file_nameis 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”.
Command-Line Format --defaults-group-suffix=strType String 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[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”.
Command-Line Format --forceType Boolean Ignore the
mysql_upgrade_infofile and force execution even ifmysql_upgrade has already been executed for the current version of MySQL.Command-Line Format --get-server-public-keyType Boolean Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the
caching_sha2_passwordauthentication 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=is given and specifies a valid public key file, it takes precedence overfile_name--get-server-public-key.For information about the
caching_sha2_passwordplugin, seeSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.--host=,host_name-hhost_nameCommand-Line Format --host=nameType String Connect to the MySQL server on the given host.
Command-Line Format --login-path=nameType String Read options from the named login path in the
.mylogin.cnflogin path file. A“login 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”.
Command-Line Format --max-allowed-packet=valueType Integer Default Value 25165824Minimum Value 4096Maximum Value 2147483648The maximum size of the buffer for client/server communication. The default value is 24MB. The minimum and maximum values are 4KB and 2GB.
Command-Line Format --net-buffer-length=valueType Integer Default Value 1047552Minimum Value 4096Maximum Value 16777216The initial size of the buffer for client/server communication. The default value is 1MB − 1KB. The minimum and maximum values are 4KB and 16MB.
Command-Line Format --no-defaultsDo not read any option files. If program startup fails due to reading unknown options from an option file,
--no-defaultscan be used to prevent them from being read.The exception is that the
.mylogin.cnffile 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-defaultsis 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]Type String 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-pand 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-passwordoption.--pipe,-WCommand-Line Format --pipeType String On Windows, connect to the server using a named pipe. This option applies only if the server was started with the
named_pipesystem 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_groupsystem variable.Command-Line Format --plugin-dir=dir_nameType Directory name The directory in which to look for plugins. Specify this option if the
--default-authoption is used to specify an authentication plugin butmysql_upgrade does not find it. SeeSection 8.2.17, “Pluggable Authentication”.--port=,port_num-Pport_numCommand-Line Format --port=#Type Numeric For TCP/IP connections, the port number to use.
Command-Line Format --print-defaultsPrint the program name and all options that it gets from option files.
--protocol={TCP|SOCKET|PIPE|MEMORY}Command-Line Format --protocol=nameType String 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_nameCommand-Line Format --server-public-key-path=file_nameType File 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 the
sha256_passwordorcaching_sha2_passwordauthentication 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=is given and specifies a valid public key file, it takes precedence overfile_name--get-server-public-key.For
sha256_password, this option applies only if MySQL was built using OpenSSL.For information about the
sha256_passwordandcaching_sha2_passwordplugins, seeSection 8.4.1.3, “SHA-256 Pluggable Authentication”, andSection 8.4.1.2, “Caching SHA-2 Pluggable Authentication”.--shared-memory-base-name=nameCommand-Line Format --shared-memory-base-name=namePlatform Specific Windows On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is
MYSQL. The shared-memory name is case-sensitive.This option applies only if the server was started with the
shared_memorysystem variable enabled to support shared-memory connections.Command-Line Format --skip-sys-schemaType Boolean Default Value FALSEBy default,mysql_upgrade installs the
sysschema if it is not installed, and upgrades it to the current version otherwise. The--skip-sys-schemaoption suppresses this behavior.--socket=,path-SpathCommand-Line Format --socket={file_name|pipe_name}Type String For connections to
localhost, 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 the
named_pipesystem 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_groupsystem variable.Options that begin with
--sslspecify 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}Deprecated 8.0.34 Type Enumeration Default Value OFFValid Values OFFONSTRICTControls whether to enable FIPS mode on the client side. The
--ssl-fips-modeoption differs from other--ssl-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”.xxxThese
--ssl-fips-modevalues are permitted:OFF: Disable FIPS mode.ON: Enable FIPS mode.STRICT: Enable“strict” FIPS mode.
NoteIf the OpenSSL FIPS Object Module is not available, the only permitted value for
--ssl-fips-modeisOFF. In this case, setting--ssl-fips-modetoONorSTRICTcauses 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_listCommand-Line Format --tls-ciphersuites=ciphersuite_listIntroduced 8.0.16 Type String 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.
Command-Line Format --tls-version=protocol_listType String 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.2The 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”.
Command-Line Format --upgrade-system-tablesType Boolean Upgrade only the system tables in the
mysqlschema, do not upgrade user schemas.--user=,user_name-uuser_nameCommand-Line Format --user=nameType String The user name of the MySQL account to use for connecting to the server. The default user name is
root.Command-Line Format --verboseType Boolean Verbose mode. Print more information about what the program does.
Command-Line Format --version-checkType Boolean 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.Command-Line Format --write-binlogType Boolean Default Value OFFBy default, binary logging bymysql_upgrade is disabled. Invoke the program with
--write-binlogif 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=levelCommand-Line Format --zstd-compression-level=#Introduced 8.0.18 Type Integer The compression level to use for connections to the server that use the
zstdcompression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The defaultzstdcompression level is 3. The compression level setting has no effect on connections that do not usezstdcompression.For more information, seeSection 6.2.8, “Connection Compression Control”.
This option was added in MySQL 8.0.18.
PDF (A4) - 43.4Mb
Man Pages (TGZ) - 297.3Kb
Man Pages (Zip) - 402.5Kb
Info (Gzip) - 4.3Mb
Info (Zip) - 4.3Mb
MySQL Globalization
MySQL Information Schema
MySQL Installation Guide
Security in MySQL
Starting and Stopping MySQL
MySQL and Linux/Unix
MySQL and Windows
MySQL and macOS
MySQL and Solaris
Building MySQL from Source
MySQL Restrictions and Limitations
MySQL Partitioning
MySQL Tutorial
MySQL Performance Schema
MySQL Replication
Using the MySQL Yum Repository
MySQL NDB Cluster 8.0