1MARIADB-UPGRADE(1) MariaDB Database System MARIADB-UPGRADE(1)
2
6 mariadb-upgrade - check tables for MariaDB upgrade (mysql_upgrade is
7 now a symlink to mariadb-upgrade)
8
10 mysql_upgrade [options]
11
13 mysql_upgrade examines all tables in all databases for
14 incompatibilities with the current version of the MariaDB Server.
15 mysql_upgrade also upgrades the system tables so that you can take
16 advantage of new privileges or capabilities that might have been added.
17 mysql_upgrade should be executed each time you upgrade MariaDB.
19 If a table is found to have a possible incompatibility, mysql_upgrade
21 performs a table check. If any problems are found, a table repair is
22 attempted.
23 Note
25 On Windows Server 2008 and Windows Vista, you must run
26 mysql_upgrade with administrator privileges. You can do this by
27 running a Command Prompt as Administrator and running the command.
28 Failure to do so may result in the upgrade failing to execute
29 correctly.
30 Caution
32 You should always back up your current MariaDB installation before
33 performing an upgrade.
34 To use mysql_upgrade, make sure that the server is running, and then
36 invoke it like this:
37 shell> mysql_upgrade [options]
39 After running mysql_upgrade, stop the server and restart it so that any
41 changes made to the system tables take effect.
42 mysql_upgrade executes the following commands to check and repair
44 tables and to upgrade the system tables:
45 mysqlcheck --all-databases --check-upgrade --auto-repair
47 mysql < fix_priv_tables
48 mysqlcheck --all-databases --check-upgrade --fix-db-names --fix-table-names
49 Notes about the preceding commands:
51 • Because mysql_upgrade invokes mysqlcheck with the --all-databases
53 option, it processes all tables in all databases, which might take
54 a long time to complete. Each table is locked and therefore
55 unavailable to other sessions while it is being processed. Check
56 and repair operations can be time-consuming, particularly for large
57 tables.
58 • For details about what checks the --check-upgrade option entails,
60 see the description of the FOR UPGRADE option of the CHECK TABLE
61 statement.
62 • fix_priv_tables represents a script generated internally by
64 mysql_upgrade that contains SQL statements to upgrade the tables in
65 the mysql database.
66 All checked and repaired tables are marked with the current MariaDB
68 version number. This ensures that next time you run mysql_upgrade with
69 the same version of the server, it can tell whether there is any need
70 to check or repair the table again.
71 mysql_upgrade also saves the MariaDB version number in a file named
73 mysql_upgrade_info in the data directory. This is used to quickly check
74 whether all tables have been checked for this release so that
75 table-checking can be skipped. To ignore this file and perform the
76 check regardless, use the --force option.
77 For this reason, mysql_upgrade needs to be run as a user with write
79 access to the data directory.
80 If you install MariaDB from RPM packages on Linux, you must install the
82 server and client RPMs. mysql_upgrade is included in the server RPM
83 but requires the client RPM because the latter includes mysqlcheck.
84 mysql_upgrade supports the following options, which can be specified on
86 the command line or in the [mysql_upgrade] and [client] option file
87 groups. Other options are passed to mysqlcheck. For example, it might
88 be necessary to specify the --password[=password] option.
89 mysql_upgrade also supports the options for processing option files.
90 • --help, -?
92 Display a short help message and exit.
94 • --basedir=path
96 Old option accepted for backward compatibility but ignored.
98 • --character-sets-dir=path
100 Old option accepted for backward compatibility but ignored.
102 • --check-if-upgrade-is-needed
104 Exit with a status code indicating if an upgrade is needed. Returns
106 0 if upgrade needed or current version couldn't be determined, 1
107 when no action required.
108 • --datadir=path
110 Old option accepted for backward compatibility but ignored.
112 • --debug=path, -# path
114 For debug builds, output debug log.
116 • --debug-check
118 Print some debugging information when the program exits.
120 • --debug-info, -T
122 Print debugging information and memory and CPU usage statistics
124 when the program exits.
125 • --default-character-set=name
127 Old option accepted for backward compatibility but ignored.
129 • --force
131 Ignore the mysql_upgrade_info file and force execution of
133 mysqlcheck even if mysql_upgrade has already been executed for the
134 current version of MariaDB.
135 • --host
137 Connect to MariaDB on the given host.
139 • --password[=password], -p[password]
141 The password to use when connecting to the server. If you use the
143 short option form (-p), you cannot have a space between the option
144 and the password. If you omit the password value following the
145 --password or -p option on the command line, mysql_upgrade prompts
146 for one.
147 Specifying a password on the command line should be considered
149 insecure. You can use an option file to avoid giving the password
150 on the command line.
151 • --port=port_num, -P port_num
153 The TCP/IP port number to use for the connection.
155 • --protocol={TCP|SOCKET|PIPE|MEMORY}
157 The connection protocol to use for connecting to the server. It is
159 useful when the other connection parameters normally would cause a
160 protocol to be used other than the one you want.
161 • --silent
163 Print less information.
165 • --socket=path, -S path
167 For connections to localhost, the Unix socket file to use, or, on
169 Windows, the name of the named pipe to use.
170 • --ssl
172 Enable SSL for connection (automatically enabled with other flags).
174 Disable with --skip-ssl.
175 • --ssl-ca=name
177 CA file in PEM format (check OpenSSL docs, implies --ssl).
179 • --ssl-capath=name
181 CA directory (check OpenSSL docs, implies --ssl).
183 • --ssl-cert=name
185 X509 cert in PEM format (check OpenSSL docs, implies --ssl).
187 • --ssl-cipher=name
189 SSL cipher to use (check OpenSSL docs, implies --ssl).
191 • --ssl-key=name
193 X509 key in PEM format (check OpenSSL docs, implies --ssl).
195 • --ssl-crl=name
197 Certificate revocation list (check OpenSSL docs, implies --ssl).
199 • --ssl-crlpath=name
201 Certificate revocation list path (check OpenSSL docs, implies
203 --ssl).
204 • --ssl-verify-server-cert
206 Verify server's "Common Name" in its cert against hostname used
208 when connecting. This option is disabled by default.
209 • --tmpdir=path, -t path
211 The path name of the directory to use for creating temporary files.
213 • --upgrade-system-tables, -s
215 Only upgrade the system tables in the mysql database. Tables in
217 other databases are not checked or touched.
218 • --user=user_name, -u user_name
220 The MariaDB user name to use when connecting to the server and not
222 using the current login.
223 • --verbose
225 Display more output about the process. Using it twice will print
227 connection arguments; using it 3 times will print out all CHECK,
228 RENAME and ALTER TABLE commands used during the check phase; using
229 it 4 times (added in MariaDB 10.0.14) will also write out all
230 mysqlcheck commands used.
231 • --version, -V
233 Output version information and exit.
235 • --version-check, -k
237 Run this program only if its 'server version' matches the version
239 of the server to which it's connecting. Note: the 'server version'
240 of the program is the version of the MariaDB server with which it
241 was built/distributed. Defaults to on; use --skip-version-check to
242 disable.
243 • --write-binlog
245 Cause binary logging to be enabled while mysql_upgrade runs.
247
249 Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.,
250 2010-2019 MariaDB Foundation
251 This documentation is free software; you can redistribute it and/or
253 modify it only under the terms of the GNU General Public License as
254 published by the Free Software Foundation; version 2 of the License.
255 This documentation is distributed in the hope that it will be useful,
257 but WITHOUT ANY WARRANTY; without even the implied warranty of
258 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
259 General Public License for more details.
260 You should have received a copy of the GNU General Public License along
262 with the program; if not, write to the Free Software Foundation, Inc.,
263 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA or see
264 http://www.gnu.org/licenses/.
265
268 For more information, please refer to the MariaDB Knowledge Base,
269 available online at https://mariadb.com/kb/
270
272 MariaDB Foundation (http://www.mariadb.org/).
273MariaDB 10.5 20 July 2020 MARIADB-UPGRADE(1)