4.5.3 mysqlcheck — A Table Maintenance Program

The mysqlcheck client performs table maintenance: It checks, repairs, optimizes, or analyzes tables.

Each table is locked and therefore unavailable to other sessions while it is being processed, although for check operations, the table is locked with a READ lock only (see Section 13.3.5, “LOCK TABLES and UNLOCK TABLES Syntax”, for more information about READ and WRITE locks). Table maintenance operations can be time-consuming, particularly for large tables. If you use the --databases or --all-databases option to process all tables in one or more databases, an invocation of mysqlcheck might take a long time. (This is also true for mysql_upgrade because that program invokes mysqlcheck to check all tables and repair them if necessary.)

mysqlcheck is similar in function to myisamchk, but works differently. The main operational difference is that mysqlcheck must be used when the mysqld server is running, whereas myisamchk should be used when it is not. The benefit of using mysqlcheck is that you do not have to stop the server to perform table maintenance.

mysqlcheck uses the SQL statements CHECK TABLE, REPAIR TABLE, ANALYZE TABLE, and OPTIMIZE TABLE in a convenient way for the user. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed. For details about which storage engines each statement works with, see the descriptions for those statements in Section 13.7.2, “Table Maintenance Statements”.

The MyISAM storage engine supports all four maintenance operations, so mysqlcheck can be used to perform any of them on MyISAM tables. Other storage engines do not necessarily support all operations. In such cases, an error message is displayed. For example, if test.t is a MEMORY table, an attempt to check it produces this result:

shell> mysqlcheck test t
test.t
note     : The storage engine for the table doesn't support check

If mysqlcheck is unable to repair a table, see Section 2.11.4, “Rebuilding or Repairing Tables or Indexes” for manual table repair strategies. This will be the case, for example, for InnoDB tables, which can be checked with CHECK TABLE, but not repaired with REPAIR TABLE.

Caution

It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss. Possible causes include but are not limited to file system errors.

There are three general ways to invoke mysqlcheck:

shell> mysqlcheck [options] db_name [tbl_name ...]
shell> mysqlcheck [options] --databases db_name ...
shell> mysqlcheck [options] --all-databases

If you do not name any tables following db_name or if you use the --databases or --all-databases option, entire databases are checked.

mysqlcheck has a special feature compared to other client programs. The default behavior of checking tables (--check) can be changed by renaming the binary. If you want to have a tool that repairs tables by default, you should just make a copy of mysqlcheck named mysqlrepair, or make a symbolic link to mysqlcheck named mysqlrepair. If you invoke mysqlrepair, it repairs tables.

The names shown in the following table can be used to change mysqlcheck default behavior.

CommandMeaning
mysqlrepairThe default option is --repair
mysqlanalyzeThe default option is --analyze
mysqloptimizeThe default option is --optimize

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

Table 4.7 mysqlcheck Options

FormatDescriptionIntroduced
--all-databasesCheck all tables in all databases 
--all-in-1Execute a single statement for each database that names all the tables from that database 
--analyzeAnalyze the tables 
--auto-repairIf a checked table is corrupted, automatically fix it 
--bind-address=ip_addressUse specified network interface to connect to MySQL Server 
--character-sets-dir=pathDirectory where character sets are installed 
--checkCheck the tables for errors 
--check-only-changedCheck only tables that have changed since the last check 
--check-upgradeInvoke CHECK TABLE with the FOR UPGRADE option 
--compressCompress all information sent between client and server 
--databasesProcess all tables in the named databases 
--debug[=debug_options]Write a debugging log 
--debug-checkPrint debugging information when program exits 
--debug-infoPrint debugging information, memory, and CPU statistics when program exits 
--default-auth=pluginAuthentication plugin to use5.6.2
--default-character-set=charset_nameSpecify default character set 
--defaults-extra-file=file_nameRead option file in addition to usual option files 
--defaults-file=file_nameRead only named option file 
--defaults-group-suffix=strOption group suffix value 
--extendedCheck and repair tables 
--fastCheck only tables that have not been closed properly 
--fix-db-namesConvert database names to 5.1 format 
--fix-table-namesConvert table names to 5.1 format 
--forceContinue even if an SQL error occurs 
--helpDisplay help message and exit 
--host=host_nameConnect to MySQL server on given host 
--login-path=nameRead login path options from .mylogin.cnf5.6.6
--medium-checkDo a check that is faster than an --extended operation 
--no-defaultsRead no option files 
--optimizeOptimize the tables 
--password[=password]Password to use when connecting to server 
--pipeOn Windows, connect to server using named pipe 
--plugin-dir=pathDirectory where plugins are installed5.6.2
--port=port_numTCP/IP port number to use for connection 
--print-defaultsPrint defaults 
--protocol=typeConnection protocol to use 
--quickThe fastest method of checking 
--repairPerform a repair that can fix almost anything except unique keys that are not unique 
--secure-authDo not send passwords to the server in old (pre-4.1.1) format5.6.17
--shared-memory-base-name=nameThe name of shared memory to use for shared-memory connections 
--silentSilent mode 
--skip-database=db_nameOmit this database from performed operations5.6.11
--socket=pathFor connections to localhost, the Unix socket file to use 
--sslEnable SSL for connection 
--ssl-ca=file_namePath of file that contains list of trusted SSL CAs 
--ssl-capath=dir_namePath of directory that contains trusted SSL CA certificates in PEM format 
--ssl-cert=file_namePath of file that contains X509 certificate in PEM format 
--ssl-cipher=cipher_listList of permitted ciphers to use for SSL encryption 
--ssl-crl=file_namePath of file that contains certificate revocation lists5.6.3
--ssl-crlpath=dir_namePath of directory that contains certificate revocation list files5.6.3
--ssl-key=file_namePath of file that contains X509 key in PEM format 
--ssl-verify-server-certVerify server Common Name value in its certificate against host name used when connecting to server 
--tablesOverrides the --databases or -B option 
--use-frmFor repair operations on MyISAM tables 
--user=user_name,MySQL user name to use when connecting to server 
--verboseVerbose mode 
--versionDisplay version information and exit 
--write-binlogLog ANALYZE, OPTIMIZE, REPAIR statements to binary log. --skip-write-binlog adds NO_WRITE_TO_BINLOG to these statements.