Documentation Home
MySQL 5.7 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 35.1Mb
PDF (A4) - 35.2Mb
Man Pages (TGZ) - 256.4Kb
Man Pages (Zip) - 361.2Kb
Info (Gzip) - 3.4Mb
Info (Zip) - 3.4Mb
Excerpts from this Manual

MySQL 5.7 Reference Manual  / ...  / MySQL Programs  / Client Programs  /  mysqlcheck — A Table Maintenance Program

4.5.3 mysqlcheck — A Table Maintenance Program

Themysqlcheck 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 aREAD lock only (seeSection 13.3.5, “LOCK TABLES and UNLOCK TABLES Statements”, for more information aboutREAD andWRITE 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 ofmysqlcheck might take a long time. (This is also true for the MySQL upgrade procedure if it determines that table checking is needed because it processes tables the same way.)

mysqlcheck must be used when themysqld server is running, which means that you do not have to stop the server to perform table maintenance.

mysqlcheck uses the SQL statementsCHECK TABLE,REPAIR TABLE,ANALYZE TABLE, andOPTIMIZE 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 inSection 13.7.2, “Table Maintenance Statements”.

All storage engines do not necessarily support all four maintenance operations. In such cases, an error message is displayed. For example, iftest.t is anMEMORY table, an attempt to check it produces this result:

$> mysqlcheck test ttest.tnote     : The storage engine for the table doesn't support check

Ifmysqlcheck is unable to repair a table, seeSection 2.10.12, “Rebuilding or Repairing Tables or Indexes” for manual table repair strategies. This is the case, for example, forInnoDB tables, which can be checked withCHECK TABLE, but not repaired withREPAIR 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 invokemysqlcheck:

mysqlcheck [options]db_name [tbl_name ...]mysqlcheck [options] --databasesdb_name ...mysqlcheck [options] --all-databases

If you do not name any tables followingdb_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 ofmysqlcheck namedmysqlrepair, or make a symbolic link tomysqlcheck namedmysqlrepair. If you invokemysqlrepair, it repairs tables.

The names shown in the following table can be used to changemysqlcheck 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, seeSection 4.2.2.2, “Using Option Files”.

Table 4.15 mysqlcheck Options

Option NameDescriptionIntroducedDeprecated
--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-addressUse specified network interface to connect to MySQL Server
--character-sets-dirDirectory 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
--databasesInterpret all arguments as database names
--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
--enable-cleartext-pluginEnable cleartext authentication plugin5.7.10
--extendedCheck and repair tables
--fastCheck only tables that have not been closed properly
--fix-db-namesConvert database names to 5.1 formatYes
--fix-table-namesConvert table names to 5.1 formatYes
--forceContinue even if an SQL error occurs
--get-server-public-keyRequest RSA public key from server5.7.23
--helpDisplay help message and exit
--hostHost on which MySQL server is located
--login-pathRead login path options from .mylogin.cnf
--medium-checkDo a check that is faster than an --extended operation
--no-defaultsRead no option files
--optimizeOptimize the tables
--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
--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 server in old (pre-4.1) formatYes
--server-public-key-pathPath name to file containing RSA public key5.7.23
--shared-memory-base-nameShared-memory name for shared-memory connections (Windows only)
--silentSilent mode
--skip-databaseOmit this database from performed operations
--socketUnix socket file or Windows named pipe to use
--sslEnable connection encryption
--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-keyFile that contains X.509 key
--ssl-modeDesired security state of connection to server5.7.11
--ssl-verify-server-certVerify host name against server certificate Common Name identity
--tablesOverrides the --databases or -B option
--tls-versionPermissible TLS protocols for encrypted connections5.7.10
--use-frmFor repair operations on MyISAM tables
--userMySQL 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

  • --help,-?

    Command-Line Format--help

    Display a help message and exit.

  • --all-databases,-A

    Command-Line Format--all-databases

    Check all tables in all databases. This is the same as using the--databases option and naming all the databases on the command line, except that theINFORMATION_SCHEMA andperformance_schema databases are not checked. They can be checked by explicitly naming them with the--databases option.

  • --all-in-1,-1

    Command-Line Format--all-in-1

    Instead of issuing a statement for each table, execute a single statement for each database that names all the tables from that database to be processed.

  • --analyze,-a

    Command-Line Format--analyze

    Analyze the tables.

  • --auto-repair

    Command-Line Format--auto-repair

    If a checked table is corrupted, automatically fix it. Any necessary repairs are done after all tables have been checked.

  • --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 10.15, “Character Set Configuration”.

  • --check,-c

    Command-Line Format--check

    Check the tables for errors. This is the default operation.

  • --check-only-changed,-C

    Command-Line Format--check-only-changed

    Check only tables that have changed since the last check or that have not been closed properly.

  • --check-upgrade,-g

    Command-Line Format--check-upgrade

    InvokeCHECK TABLE with theFOR UPGRADE option to check tables for incompatibilities with the current version of the server. This option automatically enables the--fix-db-names and--fix-table-names options.

  • --compress

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

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

  • --databases,-B

    Command-Line Format--databases

    Process all tables in the named databases. Normally,mysqlcheck treats the first name argument on the command line as a database name and any following names as table names. With this option, it treats all name arguments as database names.

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

    Command-Line Format--debug[=debug_options]
    TypeString
    Default Valued:t:o

    Write a debugging log. A typicaldebug_options string isd:t:o,file_name. The default isd:t:o.

    This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

  • --debug-check

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

    Print some debugging information when the program exits.

    This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

  • --debug-info

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

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

    This option is available only if MySQL was built usingWITH_DEBUG. MySQL release binaries provided by Oracle arenot built using this option.

  • --default-character-set=charset_name

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

    Usecharset_name as the default character set. SeeSection 10.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 4.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.

    Exception: Even with--defaults-file, client programs read.mylogin.cnf.

    For additional information about this and other option-file options, seeSection 4.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,mysqlcheck normally reads the[client] and[mysqlcheck] groups. If this option is given as--defaults-group-suffix=_other,mysqlcheck also reads the[client_other] and[mysqlcheck_other] groups.

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

  • --extended,-e

    Command-Line Format--extended

    If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time.

    If you are using this option to repair tables, it runs an extended repair that may not only take a long time to execute, but may produce a lot of garbage rows also!

  • --default-auth=plugin

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

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

  • --enable-cleartext-plugin

    Command-Line Format--enable-cleartext-plugin
    Introduced5.7.10
    TypeBoolean
    Default ValueFALSE

    Enable themysql_clear_password cleartext authentication plugin. (SeeSection 6.4.1.6, “Client-Side Cleartext Pluggable Authentication”.)

    This option was added in MySQL 5.7.10.

  • --fast,-F

    Command-Line Format--fast

    Check only tables that have not been closed properly.

  • --fix-db-names

    Command-Line Format--fix-db-names
    DeprecatedYes

    Convert database names to 5.1 format. Only database names that contain special characters are affected.

    This option is deprecated in MySQL 5.7.6; expect it to be removed in a future version of MySQL. If it is necessary to convert MySQL 5.0 database or table names, a workaround is to upgrade a MySQL 5.0 installation to MySQL 5.1 before upgrading to a more recent release.

  • --fix-table-names

    Command-Line Format--fix-table-names
    DeprecatedYes

    Convert table names to 5.1 format. Only table names that contain special characters are affected. This option also applies to views.

    This option is deprecated in MySQL 5.7.6; expect it to be removed in a future version of MySQL. If it is necessary to convert MySQL 5.0 database or table names, a workaround is to upgrade a MySQL 5.0 installation to MySQL 5.1 before upgrading to a more recent release.

  • --force,-f

    Command-Line Format--force

    Continue even if an SQL error occurs.

  • --get-server-public-key

    Command-Line Format--get-server-public-key
    Introduced5.7.23
    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 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.

    The--get-server-public-key option was added in MySQL 5.7.23.

  • --host=host_name,-hhost_name

    Command-Line Format--host=host_name
    TypeString
    Default Valuelocalhost

    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 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.

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

  • --medium-check,-m

    Command-Line Format--medium-check

    Do a check that is faster than an--extended operation. This finds only 99.99% of all errors, which should be good enough in most cases.

  • --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 4.6.6, “mysql_config_editor — MySQL Configuration Utility”.

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

  • --optimize,-o

    Command-Line Format--optimize

    Optimize the tables.

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

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

    The password of the MySQL account used for connecting to the server. The password value is optional. If not given,mysqlcheck 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 6.1.2.1, “End-User Guidelines for Password Security”.

    To explicitly specify that there is no password and thatmysqlcheck 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 butmysqlcheck does not find it. SeeSection 6.2.13, “Pluggable Authentication”.

  • --port=port_num,-Pport_num

    Command-Line Format--port=port_num
    TypeNumeric
    Default Value3306

    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.

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

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

    Command-Line Format--protocol=type
    TypeString
    Default Value[see text]
    Valid Values

    TCP

    SOCKET

    PIPE

    MEMORY

    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 4.2.5, “Connection Transport Protocols”.

  • --quick,-q

    Command-Line Format--quick

    If you are using this option to check tables, it prevents the check from scanning the rows to check for incorrect links. This is the fastest check method.

    If you are using this option to repair tables, it tries to repair only the index tree. This is the fastest repair method.

  • --repair,-r

    Command-Line Format--repair

    Perform a repair that can fix almost anything except unique keys that are not unique.

  • --secure-auth

    Command-Line Format--secure-auth
    DeprecatedYes

    Do not send passwords to the server in old (pre-4.1) format. This prevents connections except for servers that use the newer password format.

    As of MySQL 5.7.5, this option is deprecated; expect it to be removed in a future MySQL release. It is always enabled and attempting to disable it (--skip-secure-auth,--secure-auth=0) produces an error. Before MySQL 5.7.5, this option is enabled by default but can be disabled.

    Note

    Passwords that use the pre-4.1 hashing method are less secure than passwords that use the native password hashing method and should be avoided. Pre-4.1 passwords are deprecated and support for them was removed in MySQL 5.7.5. For account upgrade instructions, seeSection 6.4.1.3, “Migrating Away from Pre-4.1 Password Hashing and the mysql_old_password Plugin”.

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

    Command-Line Format--server-public-key-path=file_name
    Introduced5.7.23
    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 6.4.1.5, “SHA-256 Pluggable Authentication”, andSection 6.4.1.4, “Caching SHA-2 Pluggable Authentication”.

    The--server-public-key-path option was added in MySQL 5.7.23.

  • --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.

  • --silent,-s

    Command-Line Format--silent

    Silent mode. Print only error messages.

  • --skip-database=db_name

    Command-Line Format--skip-database=db_name

    Do not include the named database (case-sensitive) in the operations performed bymysqlcheck.

  • --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.

  • --tables

    Command-Line Format--tables

    Override the--databases or-B option. All name arguments following the option are regarded as table names.

  • --tls-version=protocol_list

    Command-Line Format--tls-version=protocol_list
    Introduced5.7.10
    TypeString
    Default Value (≥ 5.7.28)TLSv1,TLSv1.1,TLSv1.2
    Default Value (≤ 5.7.27)

    TLSv1,TLSv1.1,TLSv1.2 (OpenSSL)

    TLSv1,TLSv1.1 (yaSSL)

    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 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”.

    This option was added in MySQL 5.7.10.

  • --use-frm

    Command-Line Format--use-frm

    For repair operations onMyISAM tables, get the table structure from the.frm file so that the table can be repaired even if the.MYI header is corrupted.

  • --user=user_name,-uuser_name

    Command-Line Format--user=user_name,
    TypeString

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

  • --verbose,-v

    Command-Line Format--verbose

    Verbose mode. Print information about the various stages of program operation.

  • --version,-V

    Command-Line Format--version

    Display version information and exit.

  • --write-binlog

    Command-Line Format--write-binlog

    This option is enabled by default, so thatANALYZE TABLE,OPTIMIZE TABLE, andREPAIR TABLE statements generated bymysqlcheck are written to the binary log. Use--skip-write-binlog to causeNO_WRITE_TO_BINLOG to be added to the statements so that they are not logged. Use the--skip-write-binlog when these statements should not be sent to replicas or run when using the binary logs for recovery from backup.