1MARIADB-CHECK(1) MariaDB Database System MARIADB-CHECK(1)
2
6 mariadb-check - a table maintenance program (mysqlcheck is now a
7 symlink to mariadb-check)
8
10 mysqlcheck [options] [db_name [tbl_name ...]]
11
13 The mysqlcheck client performs table maintenance: It checks, repairs,
14 optimizes, or analyzes tables.
15 Each table is locked and therefore unavailable to other sessions while
17 it is being processed, although for check operations, the table is
18 locked with a READ lock only. Table maintenance operations can be
19 time-consuming, particularly for large tables. If you use the
20 --databases or --all-databases option to process all tables in one or
21 more databases, an invocation of mysqlcheck might take a long time.
22 (This is also true for mysql_upgrade because that program invokes
23 mysqlcheck to check all tables and repair them if necessary.)
24 mysqlcheck is similar in function to myisamchk, but works differently.
26 The main operational difference is that mysqlcheck must be used when
27 the mysqld server is running, whereas myisamchk should be used when it
28 is not. The benefit of using mysqlcheck is that you do not have to stop
29 the server to perform table maintenance.
30 mysqlcheck uses the SQL statements CHECK TABLE, REPAIR TABLE, ANALYZE
32 TABLE, and OPTIMIZE TABLE in a convenient way for the user. It
33 determines which statements to use for the operation you want to
34 perform, and then sends the statements to the server to be executed.
35 The MyISAM storage engine supports all four maintenance operations, so
37 mysqlcheck can be used to perform any of them on MyISAM tables. Other
38 storage engines do not necessarily support all operations. In such
39 cases, an error message is displayed. For example, if test.t is a
40 MEMORY table, an attempt to check it produces this result:
41 shell> mysqlcheck test t
43 test.t
44 note : The storage engine for the table doesn´t support check
45 If mysqlcheck is unable to repair a table, see the MariaDB Knowledge
47 Base for manual table repair strategies. This will be the case, for
48 example, for InnoDB tables, which can be checked with CHECK TABLE, but
49 not repaired with REPAIR TABLE.
50 The use of mysqlcheck with partitioned tables is not supported.
52 Caution
54 It is best to make a backup of a table before performing a table
55 repair operation; under some circumstances the operation might
56 cause data loss. Possible causes include but are not limited to
57 file system errors.
58 There are three general ways to invoke mysqlcheck:
60 shell> mysqlcheck [options] db_name [tbl_name ...]
62 shell> mysqlcheck [options] --databases db_name ...
63 shell> mysqlcheck [options] --all-databases
64 If you do not name any tables following db_name or if you use the
66 --databases or --all-databases option, entire databases are checked.
67 mysqlcheck has a special feature compared to other client programs. The
69 default behavior of checking tables (--check) can be changed by
70 renaming the binary. If you want to have a tool that repairs tables by
71 default, you should just make a copy of mysqlcheck named mysqlrepair,
72 or make a symbolic link to mysqlcheck named mysqlrepair. If you invoke
73 mysqlrepair, it repairs tables.
74 The following names can be used to change mysqlcheck default behavior.
76 ┌──────────────┬───────────────────────┐
78 │mysqlrepair │ The default option is │
79 │ │ --repair │
80 ├──────────────┼───────────────────────┤
81 │mysqlanalyze │ The default option is │
82 │ │ --analyze │
83 ├──────────────┼───────────────────────┤
84 │mysqloptimize │ The default option is │
85 │ │ --optimize │
86 └──────────────┴───────────────────────┘
87 mysqlcheck supports the following options, which can be specified on
89 the command line or in the [mysqlcheck] and [client] option file
90 groups. The -c, -r, -a and -o options are exclusive to each other.
91 • --help, -?
93 Display a help message and exit.
95 • --all-databases, -A
97 Check all tables in all databases. This is the same as using the
99 --databases option and naming all the databases on the command
100 line.
101 • --all-in-1, -1
103 Instead of issuing a statement for each table, execute a single
105 statement for each database that names all the tables from that
106 database to be processed.
107 • --analyze, -a
109 Analyze the tables.
111 • --auto-repair
113 If a checked table is corrupted, automatically fix it. Any
115 necessary repairs are done after all tables have been checked.
116 • --character-sets-dir=path
118 The directory where character sets are installed.
120 • --check, -c
122 Check the tables for errors. This is the default operation.
124 • --check-only-changed, -C
126 Check only tables that have changed since the last check or that
128 have not been closed properly.
129 • --check-upgrade, -g
131 Invoke CHECK TABLE with the FOR UPGRADE option to check tables for
133 incompatibilities with the current version of the server. This
134 option automatically enables the --fix-db-names and
135 --fix-table-names options.
136 • --compress
138 Compress all information sent between the client and the server if
140 both support compression.
141 • --databases, -B
143 Process all tables in the named databases. Normally, mysqlcheck
145 treats the first name argument on the command line as a database
146 name and following names as table names. With this option, it
147 treats all name arguments as database names.
148 • --debug[=debug_options], -# [debug_options]
150 Write a debugging log. A typical debug_options string is
152 ´d:t:o,file_name´. The default is ´d:t:o´.
153 • --debug-check
155 Print some debugging information when the program exits.
157 • --debug-info
159 Print debugging information and memory and CPU usage statistics
161 when the program exits.
162 • --default-auth=name
164 Default authentication client-side plugin to use.
166 • --default-character-set=charset_name
168 Use charset_name as the default character set.
170 • --defaults-extra-file=filename
172 Set filename as the file to read default options from after the
174 global defaults files has been read. Must be given as first
175 option.
176 • --defaults-file=filename
178 Set filename as the file to read default options from, override
180 global defaults files. Must be given as first option.
181 • --extended, -e
183 If you are using this option to check tables, it ensures that they
185 are 100% consistent but takes a long time.
186 If you are using this option to repair tables, it will force using
188 the old, slow, repair with keycache method, instead of the much
189 faster repair by sorting.
190 • --fast, -F
192 Check only tables that have not been closed properly.
194 • --fix-db-names
196 Convert database names to the format used since MySQL 5.1. Only
198 database names that contain special characters are affected.
199 • --fix-table-names
201 Convert table names (including views) to the format used since
203 MySQL 5.1. Only table names that contain special characters are
204 affected.
205 • --flush,
207 Flush each table after check. This is useful if you don't want to
209 have the checked tables take up space in the caches after the
210 check.
211 • --force, -f
213 Continue even if an SQL error occurs.
215 • --host=host_name, -h host_name
217 Connect to the MariaDB server on the given host.
219 • --medium-check, -m
221 Do a check that is faster than an --extended operation. This finds
223 only 99.99% of all errors, which should be good enough in most
224 cases.
225 • --no-defaults
227 Do not read default options from any option file. This must be
229 given as the first argument.
230 • --optimize, -o
232 Optimize the tables.
234 • --password[=password], -p[password]
236 The password to use when connecting to the server. If you use the
238 short option form (-p), you cannot have a space between the option
239 and the password. If you omit the password value following the
240 --password or -p option on the command line, mysqlcheck prompts for
241 one.
242 Specifying a password on the command line should be considered
244 insecure. You can use an option file to avoid giving the password
245 on the command line.
246 • --persistent, -Z
248 Used with ANALYZE TABLE to append the option PERSISENT FOR ALL.
250 • --pipe, -W
252 On Windows, connect to the server via a named pipe. This option
254 applies only if the server supports named-pipe connections.
255 • --plugin-dir=name
257 Directory for client-side plugins.
259 • --port=port_num, -P port_num
261 The TCP/IP port number to use for the connection.
263 • --print-defaults
265 Print the program argument list and exit. This must be given as
267 the first argument.
268 • --process-tables
270 Perform the requested operation on tables. Defaults to on; use
272 --skip-process-tables to disable.
273 • --process-views=val
275 Perform the requested operation (only CHECK VIEW or REPAIR VIEW).
277 Possible values are NO, YES (correct the checksum, if necessary,
278 add the mariadb-version field), UPGRADE_FROM_MYSQL (same as YES and
279 toggle the algorithm MERGE<->TEMPTABLE.
280 • --protocol={TCP|SOCKET|PIPE|MEMORY}
282 The connection protocol to use for connecting to the server. It is
284 useful when the other connection parameters normally would cause a
285 protocol to be used other than the one you want.
286 • --quick, -q
288 If you are using this option to check tables, it prevents the check
290 from scanning the rows to check for incorrect links. This is the
291 fastest check method.
292 If you are using this option to repair tables, it tries to repair
294 only the index tree. This is the fastest repair method.
295 • --repair, -r
297 Perform a repair that can fix almost anything except unique keys
299 that are not unique.
300 • --silent, -s
302 Silent mode. Print only error messages.
304 • --skip-database=db_name -s
306 Don't process the database (case-sensitive) specified as argument.
308 • --socket=path, -S path
310 For connections to localhost, the Unix socket file to use, or, on
312 Windows, the name of the named pipe to use.
313 • --ssl
315 Enable SSL for connection (automatically enabled with other flags).
317 Disable with --skip-ssl.
318 • --ssl-ca=name
320 CA file in PEM format (check OpenSSL docs, implies --ssl).
322 • --ssl-capath=name
324 CA directory (check OpenSSL docs, implies --ssl).
326 • --ssl-cert=name
328 X509 cert in PEM format (check OpenSSL docs, implies --ssl).
330 • --ssl-cipher=name
332 SSL cipher to use (check OpenSSL docs, implies --ssl).
334 • --ssl-key=name
336 X509 key in PEM format (check OpenSSL docs, implies --ssl).
338 • --ssl-crl=name
340 Certificate revocation list (check OpenSSL docs, implies --ssl).
342 • --ssl-crlpath=name
344 Certificate revocation list path (check OpenSSL docs, implies
346 --ssl).
347 • --ssl-verify-server-cert
349 Verify server's "Common Name" in its cert against hostname used
351 when connecting. This option is disabled by default.
352 • --tables
354 Override the --databases or -B option. All name arguments following
356 the option are regarded as table names.
357 • --use-frm
359 For repair operations on MyISAM tables, get the table structure
361 from the .frm file so that the table can be repaired even if the
362 .MYI header is corrupted.
363 • --user=user_name, -u user_name
365 The MariaDB user name to use when connecting to the server.
367 • --verbose, -v
369 Verbose mode. Print information about the various stages of program
371 operation. Using one --verbose option will give you more
372 information about what mysqlcheck is doing.
373 Using two --verbose options will also give you connection
375 information.
376 Using it 3 times will print out all CHECK, RENAME and ALTER TABLE
378 during the check phase.
379 • --version, -V
381 Display version information and exit.
383 • --write-binlog
385 This option is enabled by default, so that ANALYZE TABLE, OPTIMIZE
387 TABLE, and REPAIR TABLE statements generated by mysqlcheck are
388 written to the binary log. Use --skip-write-binlog to cause
389 NO_WRITE_TO_BINLOG to be added to the statements so that they are
390 not logged. Use the --skip-write-binlog when these statements
391 should not be sent to replication slaves or run when using the
392 binary logs for recovery from backup.
393
395 Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.,
396 2010-2019 MariaDB Foundation
397 This documentation is free software; you can redistribute it and/or
399 modify it only under the terms of the GNU General Public License as
400 published by the Free Software Foundation; version 2 of the License.
401 This documentation is distributed in the hope that it will be useful,
403 but WITHOUT ANY WARRANTY; without even the implied warranty of
404 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
405 General Public License for more details.
406 You should have received a copy of the GNU General Public License along
408 with the program; if not, write to the Free Software Foundation, Inc.,
409 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA or see
410 http://www.gnu.org/licenses/.
411
414 For more information, please refer to the MariaDB Knowledge Base,
415 available online at https://mariadb.com/kb/
416
418 MariaDB Foundation (http://www.mariadb.org/).
419MariaDB 10.5 27 June 2019 MARIADB-CHECK(1)