When you start the mysqld server, you can specify program options using any of the methods described in Section 4.2.3, “Specifying Program Options”. The most common methods are to provide options in an option file or on the command line. However, in most cases it is desirable to make sure that the server uses the same options each time it runs. The best way to ensure this is to list them in an option file. See Section 4.2.3.3, “Using Option Files”.
mysqld reads options from the
[mysqld] and [server]
groups. mysqld_safe reads options from the
[mysqld], [server],
[mysqld_safe], and
[safe_mysqld] groups.
mysql.server reads options from the
[mysqld] and [mysql.server]
groups.
An embedded MySQL server usually reads options from the
[server], [embedded], and
[
groups, where xxxxx_SERVER]xxxxx is the name of the
application into which the server is embedded.
mysqld accepts many command options. For a brief summary, execute mysqld --help. To see the full list, use mysqld --verbose --help.
The following list shows some of the most common server options. Additional options are described in other sections:
Options that affect security: See Section 5.3.4, “Security-Related mysqld Options”.
SSL-related options: See Section 5.5.8.3, “SSL Command Options”.
Binary log control options: See Section 5.2.4, “The Binary Log”.
Replication-related options: See Section 17.1.3, “Replication and Binary Logging Options and Variables”.
Options for loading plugins such as pluggable storage engines: See Section 5.1.3, “Server Options for Loading Plugins”.
Options specific to particular storage engines: See Section 13.5.1, “
MyISAMStartup Options”, and Section 13.6.4, “InnoDBStartup Options and System Variables”.
You can also set the values of server system variables by using variable names as options, as described at the end of this section.
Some options control the size of buffers or caches. For a given buffer, the server might need to allocate internal data structures. These structures typically are allocated from the total memory allocated to the buffer, and the amount of space required might be platform dependent. This means that when you assign a value to an option that controls a buffer size, the amount of space actually available might differ from the value assigned. In some cases, the amount might be less than the value assigned. It is also possible that the server will adjust a value upward. For example, if you assign a value of 0 to an option for which the minimal value is 1024, the server will set the value to 1024.
Values for buffer sizes, lengths, and stack sizes are given in bytes unless otherwise specified.
Some options take file name values. Unless otherwise specified,
the default file location is the data directory if the value is a
relative path name. To specify the location explicitly, use an
absolute path name. Suppose that the data directory is
/var/mysql/data. If a file-valued option is
given as a relative path name, it will be located under
/var/mysql/data. If the value is an absolute
path name, its location is as given by the path name.
--help,-?Command-Line Format -?--helpOption-File Format helpDisplay a short help message and exit. Use both the
--verboseand--helpoptions to see the full message.Command-Line Format --allow-suspicious-udfsOption-File Format allow-suspicious-udfsPermitted Values Type booleanDefault FALSEThis option controls whether user-defined functions that have only an
xxxsymbol for the main function can be loaded. By default, the option is off and only UDFs that have at least one auxiliary symbol can be loaded; this prevents attempts at loading functions from shared object files other than those containing legitimate UDFs. See Section 23.3.2.6, “User-Defined Function Security Precautions”.Command-Line Format --ansi-aOption-File Format ansiUse standard (ANSI) SQL syntax instead of MySQL syntax. For more precise control over the server SQL mode, use the
--sql-modeoption instead. See Section 1.8.3, “Running MySQL in ANSI Mode”, and Section 5.1.7, “Server SQL Modes”.Command-Line Format --basedir=path-bOption-File Format basedirOption Sets Variable Yes, basedirVariable Name basedirVariable Scope Global Dynamic Variable No Permitted Values Type file nameThe path to the MySQL installation directory. All paths are usually resolved relative to this directory.
Command-Line Format --big-tablesOption-File Format big-tablesOption Sets Variable Yes, big_tablesVariable Name big-tablesVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type booleanEnable large result sets by saving all temporary sets in files. This option prevents most “table full” errors, but also slows down queries for which in-memory tables would suffice. Since MySQL 3.23.2, the server is able to handle large result sets automatically by using memory for small temporary tables and switching to disk tables where necessary.
Command-Line Format --bind-address=nameOption-File Format bind-address=nameVariable Name bind-addressVariable Scope Global Dynamic Variable No Permitted Values Type stringDefault 0.0.0.0Range 0.0.0.0-255.255.255.255The IP address to bind to. Only one address can be selected. If this option is specified multiple times, the last address given is used.
If no address or
0.0.0.0is specified, the server listens on all interfaces.--binlog-format={ROW|STATEMENT|MIXED}Command-Line Format --binlog-format=formatOption-File Format binlog-format=formatOption Sets Variable Yes, binlog_formatVariable Name binlog_formatVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type enumerationDefault STATEMENTValid Values ROW,STATEMENT,MIXEDSpecify whether to use row-based, statement-based, or mixed replication. Statement-based is the default in MySQL 5.5. See Section 17.1.2, “Replication Formats”.
Previous to MySQL 5.5, setting the binary logging format without enabling binary logging prevented the MySQL server from starting. In MySQL 5.5, the server starts in such cases, the
binlog_formatglobal system variable is set, and a warning is logged instead of an error. (Bug#42928)Command-Line Format --bootstrapOption-File Format bootstrapThis option is used by the mysql_install_db script to create the MySQL privilege tables without having to start a full MySQL server.
This option is unavailable if MySQL was configured with the
DISABLE_GRANT_OPTIONScompiler flag. See Section 2.11.4, “MySQL Source-Configuration Options”.Command-Line Format --character-sets-dir=pathOption-File Format character-sets-dir=pathOption Sets Variable Yes, character_sets_dirVariable Name character-sets-dirVariable Scope Global Dynamic Variable No Permitted Values Type directory nameThe directory where character sets are installed. See Section 9.5, “Character Set Configuration”.
--character-set-client-handshakeCommand-Line Format --character-set-client-handshakeOption-File Format character-set-client-handshakePermitted Values Type booleanDefault TRUEDo not ignore character set information sent by the client. To ignore client information and use the default server character set, use
--skip-character-set-client-handshake; this makes MySQL behave like MySQL 4.0.--character-set-filesystem=charset_nameCommand-Line Format --character-set-filesystem=nameOption-File Format character-set-filesystemOption Sets Variable Yes, character_set_filesystemVariable Name character_set_filesystemVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type stringThe file system character set. This option sets the
character_set_filesystemsystem variable.--character-set-server=,charset_name-Ccharset_nameCommand-Line Format --character-set-serverOption-File Format character-set-serverOption Sets Variable Yes, character_set_serverVariable Name character_set_serverVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type stringUse
charset_nameas the default server character set. See Section 9.5, “Character Set Configuration”. If you use this option to specify a nondefault character set, you should also use--collation-serverto specify the collation.--chroot=,path-rpathCommand-Line Format --chroot=name-r nameOption-File Format chrootPermitted Values Type file namePut the mysqld server in a closed environment during startup by using the
chroot()system call. This is a recommended security measure. Note that use of this option somewhat limitsLOAD DATA INFILEandSELECT ... INTO OUTFILE.--collation-server=collation_nameCommand-Line Format --collation-serverOption-File Format collation-serverOption Sets Variable Yes, collation_serverVariable Name collation_serverVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type stringUse
collation_nameas the default server collation. See Section 9.5, “Character Set Configuration”.Command-Line Format --consoleOption-File Format consolePlatform Specific windows (Windows only.) Write error log messages to
stderrandstdouteven if--log-erroris specified. mysqld does not close the console window if this option is used.Command-Line Format --core-fileOption-File Format core-filePermitted Values Type booleanDefault FALSEWrite a core file if mysqld dies. The name and location of the core file is system dependent. On Linux, a core file named
core.is written to the current working directory of the process, which for mysqld is the data directory.pidpidrepresents the process ID of the server process. On Mac OS X, a core file namedcore.is written to thepid/coresdirectory. On Solaris, use the coreadm command to specify where to write the core file and how to name it.For some systems, to get a core file you must also specify the
--core-file-sizeoption to mysqld_safe. See Section 4.3.2, “mysqld_safe — MySQL Server Startup Script”. On some systems, such as Solaris, you do not get a core file if you are also using the--useroption. There might be additional restrictions or limitations. For example, it might be necessary to execute ulimit -c unlimited before starting the server. Consult your system documentation.--datadir=,path-hpathCommand-Line Format --datadir=path-hOption-File Format datadirOption Sets Variable Yes, datadirVariable Name datadirVariable Scope Global Dynamic Variable No Permitted Values Type file nameThe path to the data directory.
--debug[=,debug_options]-# [debug_options]Command-Line Format --debug[=debug_options]Option-File Format debugVariable Name debugVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type stringDefault 'd:t:o,/tmp/mysqld.trace'If MySQL is configured with
-DWITH_DEBUG=1, you can use this option to get a trace file of what mysqld is doing. A typicaldebug_optionsstring is'd:t:o,. The default isfile_name''d:t:i:o,mysqld.trace'. See MySQL Internals: Porting.Using
-DWITH_DEBUG=1to configure MySQL with debugging support enables you to use the--debug="d,parser_debug"option when you start the server. This causes the Bison parser that is used to process SQL statements to dump a parser trace to the server's standard error output. Typically, this output is written to the error log.This option may be given multiple times. Values that begin with
+or-are added to or subtracted from the previous value. For example,--debug=T--debug=+Psets the value toP:T.Command-Line Format --debug-sync-timeout[=#]Option-File Format debug-sync-timeoutPermitted Values Type numericControls whether the Debug Sync facility for testing and debugging is enabled. Use of Debug Sync requires that MySQL be configured with the
-DENABLE_DEBUG_SYNC=1option (see Section 2.11.4, “MySQL Source-Configuration Options”). If Debug Sync is not compiled in, this option is not available. The option value is a timeout in seconds. The default value is 0, which disables Debug Sync. To enable it, specify a value greater than 0; this value also becomes the default timeout for individual synchronization points. If the option is given without a value, the timeout is set to 300 seconds.For a description of the Debug Sync facility and how to use synchronization points, see MySQL Internals: Test Synchronization.
--default-character-set=charset_nameCommand-Line Format --default-character-set=name-C nameOption-File Format default-character-set=nameDeprecated 5.0 Permitted Values Type stringUse
charset_nameas the default character set. This option is deprecated in favor of--character-set-server. See Section 9.5, “Character Set Configuration”.--default-character-setwas removed in MySQL 5.5.3.--default-collation=collation_nameCommand-Line Format --default-collation=nameOption-File Format default-collation=nameDeprecated 4.1.3 Permitted Values Type stringUse
collation_nameas the default collation. This option is deprecated in favor of--collation-server. See Section 9.5, “Character Set Configuration”.--default-collationwas removed in MySQL 5.5.3.Command-Line Format --default-storage-engine=nameOption-File Format default-storage-engineOption Sets Variable Yes, default_storage_engineVariable Name default-storage-engineVariable Scope Global, Session Dynamic Variable Yes Permitted Values (<= 5.5.4) Type enumerationDefault MyISAMPermitted Values (>= 5.5.5) Type enumerationDefault InnoDBSet the default storage engine (table type) for tables. See Chapter 13, Storage Engines.
Command-Line Format --default-time-zone=nameOption-File Format default-time-zonePermitted Values Type stringSet the default server time zone. This option sets the global
time_zonesystem variable. If this option is not given, the default time zone is the same as the system time zone (given by the value of thesystem_time_zonesystem variable.--delay-key-write[={OFF|ON|ALL}]Command-Line Format --delay-key-write[=name]Option-File Format delay-key-writeOption Sets Variable Yes, delay_key_writeVariable Name delay-key-writeVariable Scope Global Dynamic Variable Yes Permitted Values Type enumerationDefault ONValid Values ON,OFF,ALLSpecify how to use delayed key writes. Delayed key writing causes key buffers not to be flushed between writes for
MyISAMtables.OFFdisables delayed key writes.ONenables delayed key writes for those tables that were created with theDELAY_KEY_WRITEoption.ALLdelays key writes for allMyISAMtables. See Section 7.11.2, “Tuning Server Parameters”, and Section 13.5.1, “MyISAMStartup Options”.NoteIf you set this variable to
ALL, you should not useMyISAMtables from within another program (such as another MySQL server or myisamchk) when the tables are in use. Doing so leads to index corruption.Command-Line Format --des-key-file=file_nameOption-File Format des-key-file=file_nameRead the default DES keys from this file. These keys are used by the
DES_ENCRYPT()andDES_DECRYPT()functions.Command-Line Format --enable-named-pipeOption-File Format enable-named-pipeOption Sets Variable Yes, named_pipePlatform Specific windows Enable support for named pipes. This option applies only on Windows.
Version Removed 5.5.7 Command-Line Format --enable-pstackOption-File Format enable-pstackDeprecated 5.1.54 Permitted Values Type booleanDefault FALSEThis option is nonfunctional before MySQL 5.5.7 and removed in 5.5.7.
--engine-condition-pushdown={ON|OFF}Version Deprecated 5.5.3 Command-Line Format --engine-condition-pushdownOption-File Format engine-condition-pushdownOption Sets Variable Yes, engine_condition_pushdownVariable Name engine_condition_pushdownVariable Scope Global, Session Dynamic Variable Yes Deprecated 5.5.3, by optimizer_switchPermitted Values Type booleanDefault ONSets the
engine_condition_pushdownsystem variable. For more information, see Section 7.13.3, “Engine Condition Pushdown Optimization”.Command-Line Format --event-scheduler[=value]Option-File Format event-schedulerOption Sets Variable Yes, event_schedulerVariable Name event_schedulerVariable Scope Global Dynamic Variable Yes Permitted Values Type enumerationDefault OFFValid Values ON,OFF,DISABLEDEnable or disable, and start or stop, the event scheduler.
For detailed information, see The
--event-schedulerOption.--exit-info[=,flags]-T [flags]Command-Line Format --exit-info[=flags]-T [flags]Option-File Format exit-infoPermitted Values Type numericThis is a bit mask of different flags that you can use for debugging the mysqld server. Do not use this option unless you know exactly what it does!
Command-Line Format --external-lockingOption-File Format external-lockingOption Sets Variable Yes, skip_external_lockingDisabled by skip-external-lockingPermitted Values Type booleanDefault FALSEEnable external locking (system locking), which is disabled by default as of MySQL 4.0. Note that if you use this option on a system on which
lockddoes not fully work (such as Linux), it is easy for mysqld to deadlock.For more information about external locking, including conditions under which it can and cannot be used, see Section 7.10.5, “External Locking”.
Command-Line Format --flushOption-File Format flushVariable Name flushVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanDefault OFFFlush (synchronize) all changes to disk after each SQL statement. Normally, MySQL does a write of all changes to disk only after each SQL statement and lets the operating system handle the synchronizing to disk. See Section C.5.4.2, “What to Do If MySQL Keeps Crashing”.
Command-Line Format --gdbOption-File Format gdbPermitted Values Type booleanDefault FALSEInstall an interrupt handler for
SIGINT(needed to stop mysqld with^Cto set breakpoints) and disable stack tracing and core file handling. See MySQL Internals: Porting.Command-Line Format --general-logOption-File Format general-logOption Sets Variable Yes, general_logVariable Name general_logVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanDefault OFFSpecify the initial general query log state. With no argument or an argument of 1, the
--general-logoption enables the log. If omitted or given with an argument of 0, the option disables the log.Command-Line Format --init-file=file_nameOption-File Format init-file=file_nameOption Sets Variable Yes, init_fileVariable Name init_fileVariable Scope Global Dynamic Variable No Permitted Values Type file nameRead SQL statements from this file at startup. Each statement must be on a single line and should not include comments.
This option is unavailable if MySQL was configured with the
DISABLE_GRANT_OPTIONScompiler flag. See Section 2.11.4, “MySQL Source-Configuration Options”.--innodb-xxxThe
InnoDBoptions are listed in Section 13.6.4, “InnoDBStartup Options and System Variables”.--language=lang_name, -Llang_nameVersion Deprecated 5.5.0 Command-Line Format --language=name-LOption-File Format languageOption Sets Variable Yes, languageVariable Name languageVariable Scope Global Dynamic Variable No Deprecated 5.5.0, by lc-messages-dirPermitted Values Type directory nameDefault /usr/local/mysql/share/mysql/english/The language to use for error messages.
lang_namecan be given as the language name or as the full path name to the directory where the language files are installed. See Section 9.2, “Setting the Error Message Language”.As of MySQL 5.5,
--lc-messages-dirand--lc-messagesshould be used rather than--language, which is deprecated and handled as an alias for--lc-messages-dir.Command-Line Format --large-pagesOption-File Format large-pagesOption Sets Variable Yes, large_pagesVariable Name large_pagesVariable Scope Global Dynamic Variable No Platform Specific linux Permitted Values Type (linux) booleanDefault FALSESome hardware/operating system architectures support memory pages greater than the default (usually 4KB). The actual implementation of this support depends on the underlying hardware and operating system. Applications that perform a lot of memory accesses may obtain performance improvements by using large pages due to reduced Translation Lookaside Buffer (TLB) misses.
MySQL 5.5 supports the Linux implementation of large page support (which is called HugeTLB in Linux). See Section 7.11.4.2, “Enabling Large Page Support”. For Solaris support of large pages, see the description of the
--super-large-pagesoption.--large-pagesis disabled by default.Command-Line Format --lc-messages=nameOption-File Format lc-messagesOption Sets Variable Yes, lc_messagesVariable Name lc-messagesVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type stringThe locale to use for error messages. The server converts the argument to a language name and combines it with the value of the
--lc-messages-dirto produce the location for the error message file. See Section 9.2, “Setting the Error Message Language”.Command-Line Format --lc-messages-dir=pathOption-File Format lc-messages-dirOption Sets Variable Yes, lc_messages_dirVariable Name lc-messages-dirVariable Scope Global Dynamic Variable No Permitted Values Type directory nameThe directory where error messages are located. The value is used together with the value of
--lc-messagesto produce the location for the error message file. See Section 9.2, “Setting the Error Message Language”.--log[=,file_name]-l [file_name]Command-Line Format --log[=name]-lOption-File Format logOption Sets Variable Yes, logVariable Name logVariable Scope Global Dynamic Variable Yes Deprecated 5.1.29, by general-logPermitted Values Type stringDefault OFFThis option enables logging to the general query log, which contains entries that record client connections and SQL statements received from clients. The log output destination can be selected with the
--log-outputoption. If you omit the file name, MySQL usesas the file name. See Section 5.2.1, “Selecting General Query and Slow Query Log Output Destinations”, and Section 5.2.3, “The General Query Log”.host_name.logThe
--logoption is deprecated and will be removed (along with thelogsystem variable) in MySQL 7.0. Instead, use the--general_logoption to enable the general query log and the--general_log_file=option to set the general query log file name.file_nameCommand-Line Format --log-error[=name]Option-File Format log-errorOption Sets Variable Yes, log_errorVariable Name log_errorVariable Scope Global Dynamic Variable No Permitted Values Type file nameLog errors and startup messages to this file. See Section 5.2.2, “The Error Log”. If you omit the file name, MySQL uses
. If the file name has no extension, the server adds an extension ofhost_name.err.err.Command-Line Format --log-isam[=name]Option-File Format log-isamPermitted Values Type file nameLog all
MyISAMchanges to this file (used only when debuggingMyISAM).Command-Line Format --log-long-format-0Option-File Format log-long-formatDeprecated 4.1 Log extra information to the binary log and slow query log, if they have been activated. For example, the user name and timestamp are logged for all queries. This option is deprecated, as it now represents the default logging behavior. (See the description for
--log-short-format.) The--log-queries-not-using-indexesoption is available for the purpose of logging queries that do not use indexes to the slow query log.--log-long-formatwas removed in MySQL 5.5.3.Command-Line Format --log-output[=name]Option-File Format log-outputOption Sets Variable Yes, log_outputVariable Name log_outputVariable Scope Global Dynamic Variable Yes Permitted Values Type setDefault FILEValid Values TABLE,FILE,NONEThis option determines the destination for general query log and slow query log output. The option value can be given as one or more of the words
TABLE,FILE, orNONE. If the option is given without a value, the default isFILE.TABLEselect logging to thegeneral_logandslow_logtables in themysqldatabase as a destination.FILEselects logging to log files as a destination.NONEdisables logging. IfNONEis present in the option value, it takes precedence over any other words that are present.TABLEandFILEcan both be given to select to both log output destinations.This option selects log output destinations, but does not enable log output. To do that, use the
--general_logand--slow_query_logoptions. ForFILElogging, the--general_log_fileand-slow_query_log_fileoptions determine the log file location. For more information, see Section 5.2.1, “Selecting General Query and Slow Query Log Output Destinations”.--log-queries-not-using-indexesCommand-Line Format --log-queries-not-using-indexesOption-File Format log-queries-not-using-indexesOption Sets Variable Yes, log_queries_not_using_indexesVariable Name log_queries_not_using_indexesVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanIf you are using this option with the slow query log enabled, queries that are expected to retrieve all rows are logged. See Section 5.2.5, “The Slow Query Log”. This option does not necessarily mean that no index is used. For example, a query that uses a full index scan uses an index but would be logged because the index would not limit the number of rows.
Command-Line Format --log-short-formatOption-File Format log-short-formatPermitted Values Type booleanDefault FALSEOriginally intended to log less information to the binary log and slow query log, if they have been activated. However, this option is not operational.
Command-Line Format --log-slow-admin-statementsOption-File Format log-slow-admin-statementsPermitted Values Type booleanDefault FALSELog slow administrative statements such as
OPTIMIZE TABLE,ANALYZE TABLE, andALTER TABLEto the slow query log.--log-slow-queries[=file_name]Command-Line Format --log-slow-queries[=name]Option-File Format log-slow-queriesOption Sets Variable Yes, log_slow_queriesVariable Name log_slow_queriesVariable Scope Global Dynamic Variable Yes Deprecated 5.1.29, by slow-query-logPermitted Values Type booleanThis option enables logging to the slow query log, which contains entries for all queries that have taken more than
long_query_timeseconds to execute. See the descriptions of the--log-long-formatand--log-short-formatoptions for details. The log output destination can be selected with the--log-outputoption. If you omit the file name, MySQL usesas the file name. See Section 5.2.1, “Selecting General Query and Slow Query Log Output Destinations”, and Section 5.2.5, “The Slow Query Log”.host_name-slow.logThe
--log-slow-queriesoption is deprecated and will be removed (along with thelog_slow_queriessystem variable) in MySQL 7.0. Instead, use the--slow_query_logoption to enable the slow query log and the--slow_query_log_file=option to set the slow query log file name.file_nameCommand-Line Format --log-tc=nameOption-File Format log-tcPermitted Values Type file nameDefault tc.logThe name of the memory-mapped transaction coordinator log file (for XA transactions that affect multiple storage engines when the binary log is disabled). The default name is
tc.log. The file is created under the data directory if not given as a full path name. Currently, this option is unused.Command-Line Format --log-tc-size=#Option-File Format log-tc-sizePermitted Values Platform Bit Size 32Type numericDefault 24576Max Value 4294967295Permitted Values Platform Bit Size 64Type numericDefault 24576Max Value 18446744073709547520The size in bytes of the memory-mapped transaction coordinator log. The default size is 24KB.
--log-warnings[=,level]-W [level]Command-Line Format --log-warnings[=#]-W [#]Option-File Format log-warningsOption Sets Variable Yes, log_warningsVariable Name log_warningsVariable Scope Global, Session Dynamic Variable Yes Disabled by skip-log-warningsPermitted Values Platform Bit Size 64Type numericDefault 1Range 0-18446744073709547520Print out warnings such as
Aborted connection...to the error log. Enabling this option is recommended, for example, if you use replication (you get more information about what is happening, such as messages about network failures and reconnections). This option is enabled (1) by default, and the defaultlevelvalue if omitted is 1. To disable this option, use--log-warnings=0. If the value is greater than 1, aborted connections are written to the error log, and access-denied errors for new connection attempts are written. See Section C.5.2.11, “Communication Errors and Aborted Connections”.If a slave server was started with
--log-warningsenabled, the slave prints messages to the error log to provide information about its status, such as the binary log and relay log coordinates where it starts its job, when it is switching to another relay log, when it reconnects after a disconnect, and so forth. The server logs messages about statements that are unsafe for statement-based logging only if--log-warningsis enabled.Command-Line Format --low-priority-updatesOption-File Format low-priority-updatesOption Sets Variable Yes, low_priority_updatesVariable Name low_priority_updatesVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type booleanDefault FALSEGive table-modifying operations (
INSERT,REPLACE,DELETE,UPDATE) lower priority than selects. This can also be done using{INSERT | REPLACE | DELETE | UPDATE} LOW_PRIORITY ...to lower the priority of only one query, or bySET LOW_PRIORITY_UPDATES=1to change the priority in one thread. This affects only storage engines that use only table-level locking (MyISAM,MEMORY,MERGE). See Section 7.10.2, “Table Locking Issues”.--min-examined-row-limit=numberCommand-Line Format --min-examined-row-limit=#Option-File Format min-examined-row-limitVariable Name min_examined_row_limitVariable Scope Global, Session Dynamic Variable Yes Permitted Values Platform Bit Size 32Type numericDefault 0Range 0-4294967295Permitted Values Platform Bit Size 64Type numericDefault 0Range 0-18446744073709547520When this option is set, queries which examine fewer than
numberrows are not written to the slow query log. The default is 0.Command-Line Format --memlockOption-File Format memlockVariable Name locked_in_memoryVariable Scope Global Dynamic Variable No Permitted Values Type booleanDefault FALSELock the mysqld process in memory. This option might help if you have a problem where the operating system is causing mysqld to swap to disk.
--memlockworks on systems that support themlockall()system call; this includes Solaris as well as most Linux distributions that use a 2.4 or newer kernel. On Linux systems, you can tell whether or notmlockall()(and thus this option) is supported by checking to see whether or not it is defined in the systemmman.hfile, like this:shell>
grep mlockall /usr/include/sys/mman.hIf
mlockall()is supported, you should see in the output of the previous command something like the following:extern int mlockall (int __flags) __THROW;
ImportantUsing this option requires that you run the server as
root, which, for reasons of security, is normally not a good idea. See Section 5.3.6, “How to Run MySQL as a Normal User”.You must not try to use this option on a system that does not support the
mlockall()system call; if you do so, mysqld will very likely crash as soon as you try to start it.Command-Line Format --myisam-block-size=#Option-File Format myisam-block-sizePermitted Values Type numericDefault 1024Range 1024-16384The block size to be used for
MyISAMindex pages.--myisam-recover[=option[,option]...]]This option is renamed as of MySQL 5.5.3 to
--myisam-recover-options. See the description of that option for more information.--myisam-recover-options[=option[,option]...]]Version Introduced 5.5.3 Command-Line Format --myisam-recover-options[=name]Option-File Format myisam-recover-optionsOption Sets Variable Yes, myisam_recover_optionsPermitted Values Type enumerationDefault OFFValid Values OFF,DEFAULT,BACKUP,FORCE,QUICKSet the
MyISAMstorage engine recovery mode. The option value is any combination of the values ofDEFAULT,OFF,BACKUP,FORCE, orQUICK. If you specify multiple values, separate them by commas. Specifying the option with no argument is the same as specifyingDEFAULT, and specifying with an explicit value of""disables recovery (same as not giving the option). If recovery is enabled, each time mysqld opens aMyISAMtable, it checks whether the table is marked as crashed or was not closed properly. (The last option works only if you are running with external locking disabled.) If this is the case, mysqld runs a check on the table. If the table was corrupted, mysqld attempts to repair it.The following options affect how the repair works.
Option Description DEFAULTRecovery without backup, forcing, or quick checking. OFFRecovery without backup, forcing, or quick checking. BACKUPIf the data file was changed during recovery, save a backup of the file astbl_name.MYD.tbl_name-datetime.BAKFORCERun recovery even if we would lose more than one row from the .MYDfile.QUICKDo not check the rows in the table if there are not any delete blocks. Before the server automatically repairs a table, it writes a note about the repair to the error log. If you want to be able to recover from most problems without user intervention, you should use the options
BACKUP,FORCE. This forces a repair of a table even if some rows would be deleted, but it keeps the old data file as a backup so that you can later examine what happened.This option was named
--myisam-recover, before MySQL 5.5.3. The old option name still works because it is recognized as an unambiguous prefix of the new name,--myisam-recover-options. (Option prefix recognition occurs as described in Section 4.2.3, “Specifying Program Options”.)The option value
OFFis available as of MySQL 5.5.3.Command-Line Format --old-alter-tableOption-File Format old-alter-tableOption Sets Variable Yes, old_alter_tableVariable Name old-alter-tableVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type booleanDefault OFFWhen this option is given, the server does not use the optimized method of processing an
ALTER TABLEoperation. It reverts to using a temporary table, copying over the data, and then renaming the temporary table to the original, as used by MySQL 5.0 and earlier. For more information on the operation ofALTER TABLE, see Section 12.1.6, “ALTER TABLESyntax”.Command-Line Format --old_passwordsOption-File Format old-passwordsOption Sets Variable Yes, old_passwordsVariable Name old_passwordsVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type booleanDefault FALSEForce the server to generate short (pre-4.1) password hashes for new passwords. This is useful for compatibility when the server must support older client programs. See Section 5.3.2.3, “Password Hashing in MySQL”.
Command-Line Format --old-style-user-limitsOption-File Format old-style-user-limitsPermitted Values Type booleanDefault FALSEEnable old-style user limits. (Before MySQL 5.0.3, account resource limits were counted separately for each host from which a user connected rather than per account row in the
usertable.) See Section 5.5.4, “Setting Account Resource Limits”.Command-Line Format --one-threadOption-File Format one-threadOnly use one thread (for debugging under Linux). This option is available only if the server is built with debugging enabled. See MySQL Internals: Porting.
This option is deprecated; use
--thread_handling=no-threadsinstead.Command-Line Format --open-files-limit=#Option-File Format open-files-limitOption Sets Variable Yes, open_files_limitVariable Name open_files_limitVariable Scope Global Dynamic Variable No Permitted Values Type numericDefault 0Range 0-65535Changes the number of file descriptors available to mysqld. You should try increasing the value of this option if mysqld gives you the error
Too many open files. mysqld uses the option value to reserve descriptors withsetrlimit(). If the requested number of file descriptors cannot be allocated, mysqld writes a warning to the error log.mysqld may attempt to allocate more than the requested number of descriptors (if they are available), using the values of
max_connectionsandtable_open_cacheto estimate whether more descriptors will be needed.Command-Line Format --partitionOption-File Format partitionOption Sets Variable Yes, have_partitioningVariable Name partitionVariable Scope Global Dynamic Variable No Disabled by skip-partitionPermitted Values Type booleanDefault ONEnables or disables user-defined partitioning support in the MySQL Server.
Command-Line Format --pid-file=file_nameOption-File Format pid-file=file_nameOption Sets Variable Yes, pid_fileVariable Name pid_fileVariable Scope Global Dynamic Variable No Permitted Values Type file nameThe path name of the process ID file. The server creates the file in the data directory unless an absolute path name is given to specify a different directory. This file is used by other programs such as mysqld_safe to determine the server's process ID.
Specifies an option that pertains to a server plugin. For example, many storage engines can be built as plugins, and for such engines, options for them can be specified with a
--pluginprefix. Thus, the--innodb_file_per_tableoption forInnoDBcan be specified as--plugin-innodb_file_per_table.For boolean options that can be enabled or disabled, the
--skipprefix and other alternative formats are supported as well (see Section 4.2.3.2, “Program Option Modifiers”). For example,--skip-plugin-innodb_file_per_tabledisablesinnodb_file_per_table.The rationale for the
--pluginprefix is that it enables plugin options to be specified unambigously if there is a name conflict with a built-in server option. For example, were a plugin writer to name a plugin “sql” and implement a “mode” option, the option name might be--sql-mode, which would conflict with the built-in option of the same name. In such cases, references to the conflicting name are resolved in favor of the built-in option. To avoid the ambiguity, users can specify the plugin option as--plugin-sql-mode. Use of the--pluginprefix for plugin options is recommended to avoid any question of ambiguity.Command-Line Format --plugin-load=plugin_listOption-File Format plugin-loadPermitted Values Type stringThis option tells the server to load the named plugins at startup. The option value is a semicolon-separated list of
pairs. Eachname=plugin_librarynameis the name of the plugin, andplugin_libraryis the name of the shared library that contains the plugin code. Each library file must be located in the directory named by theplugin_dirsystem variable. For example, if plugins namedmyplug1andmyplug2have library filesmyplug1.soandmyplug2.so, use this option to load them at startup:shell>
mysqld --plugin-load=myplug1=myplug1.so;myplug2=myplug2.soAll plugins to load must be named in the same
--plugin-loadoption. If multiple--plugin-loadoptions are given, only the last one is used.Each named plugin is loaded for a single invocation of mysqld only. After a restart, the plugin is not loaded unless
--plugin-loadis used again. This is in contrast toINSTALL PLUGIN, which adds an entry to themysql.pluginstable to cause the plugin to be loaded for every normal server startup.Under normal startup, the server determines which plugins to load by reading the
mysql.pluginssystem table. If the server is started with the--skip-grant-tablesoption, it does not consult themysql.pluginstable and thus does not load plugins installed with theINSTALL PLUGINstatement.--plugin-loadenables plugins to be loaded even when--skip-grant-tablesis given.--plugin-loadalso enables plugins to be loaded at startup under configurations when plugins cannot be loaded at runtime.For additional information about plugin loading, see Section 12.4.3.1, “Installing and Uninstalling Plugins”.
--port=,port_num-Pport_numCommand-Line Format --port=#-POption-File Format portOption Sets Variable Yes, portVariable Name portVariable Scope Global Dynamic Variable No Permitted Values Type numericDefault 3306The port number to use when listening for TCP/IP connections. The port number must be 1024 or higher unless the server is started by the
rootsystem user.Command-Line Format --port-open-timeout=#Option-File Format port-open-timeoutPermitted Values Type numericDefault 0On some systems, when the server is stopped, the TCP/IP port might not become available immediately. If the server is restarted quickly afterward, its attempt to reopen the port can fail. This option indicates how many seconds the server should wait for the TCP/IP port to become free if it cannot be opened. The default is not to wait.
Command-Line Format --safe-modeOption-File Format safe-modeDeprecated 5.0 Skip some optimization stages.
Command-Line Format --safe-show-database(until 4.1.1) Option-File Format safe-show-databaseVariable Name safe_show_databaseVariable Scope Global Dynamic Variable Yes Deprecated 4.0.2 Permitted Values Type booleanThis option is deprecated and does not do anything because there is a
SHOW DATABASESprivilege that can be used to control access to database names on a per-account basis. See Section 5.4.1, “Privileges Provided by MySQL”.--safe-show-databasewas removed in MySQL 5.5.3.Command-Line Format --safe-user-createOption-File Format safe-user-createPermitted Values Type booleanDefault FALSEIf this option is enabled, a user cannot create new MySQL users by using the
GRANTstatement unless the user has theINSERTprivilege for themysql.usertable or any column in the table. If you want a user to have the ability to create new users that have those privileges that the user has the right to grant, you should grant the user the following privilege:GRANT INSERT(user) ON mysql.user TO '
user_name'@'host_name';This ensures that the user cannot change any privilege columns directly, but has to use the
GRANTstatement to give privileges to other users.Command-Line Format --secure-authOption-File Format secure-authOption Sets Variable Yes, secure_authVariable Name secure_authVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanDefault FALSEDisallow authentication by clients that attempt to use accounts that have old (pre-4.1) passwords.
Command-Line Format --secure-file-priv=pathOption-File Format secure-file-priv=pathOption Sets Variable Yes, secure_file_privVariable Name secure-file-privVariable Scope Global Dynamic Variable No Permitted Values Type stringThis option limits the effect of the
LOAD_FILE()function and theLOAD DATAandSELECT ... INTO OUTFILEstatements to work only with files in the specified directory.Enable shared-memory connections by local clients. This option is available only on Windows.
--shared-memory-base-name=nameThe name of shared memory to use for shared-memory connections. This option is available only on Windows. The default name is
MYSQL. The name is case sensitive.Turn off the ability to select and insert at the same time on
MyISAMtables. (This is to be used only if you think you have found a bug in this feature.) See Section 7.10.3, “Concurrent Inserts”.Do not use external locking (system locking). For more information about external locking, including conditions under which it can and cannot be used, see Section 7.10.5, “External Locking”.
External locking has been disabled by default since MySQL 4.0.
Command-Line Format --skip-event-scheduler--disable-event-schedulerOption-File Format skip-event-schedulerTurns the Event Scheduler
OFF. This is not the same as disabling the Event Scheduler, which requires setting--event-scheduler=DISABLED; see The--event-schedulerOption, for more information.This option causes the server to start without using the privilege system at all, which gives anyone with access to the server unrestricted access to all databases. You can cause a running server to start using the grant tables again by executing mysqladmin flush-privileges or mysqladmin reload command from a system shell, or by issuing a MySQL
FLUSH PRIVILEGESstatement after connecting to the server. This option also suppresses loading of plugins that were installed with theINSTALL PLUGINstatement, user-defined functions (UDFs), and scheduled events. To cause plugins to be loaded anyway, use the--plugin-loadoption.--skip-grant-tablesis unavailable if MySQL was configured with theDISABLE_GRANT_OPTIONScompiler flag. See Section 2.11.4, “MySQL Source-Configuration Options”.Do not use the internal host name cache for faster name-to-IP resolution. Instead, query the DNS server every time a client connects. See Section 7.11.5.2, “How MySQL Uses DNS”.
Disable the
InnoDBstorage engine. In this case, the server will not start if the default storage engine is set toInnoDB. Use--default-storage-engineto set the default to some other engine if necessary.Do not resolve host names when checking client connections. Use only IP addresses. If you use this option, all
Hostcolumn values in the grant tables must be IP addresses orlocalhost. See Section 7.11.5.2, “How MySQL Uses DNS”.Do not listen for TCP/IP connections at all. All interaction with mysqld must be made using named pipes or shared memory (on Windows) or Unix socket files (on Unix). This option is highly recommended for systems where only local clients are permitted. See Section 7.11.5.2, “How MySQL Uses DNS”.
Command-Line Format --skip-partition--disable-partitionOption-File Format skip-partitionDisables user-defined partitioning. Existing partitioned tables cannot be accessed when the server has been started with this option.
Options that begin with
--sslspecify whether to permit clients to connect using SSL and indicate where to find SSL keys and certificates. See Section 5.5.8.3, “SSL Command Options”.Command-Line Format --standaloneOption-File Format standalonePlatform Specific windows Available on Windows only; instructs the MySQL server not to run as a service.
Standard use of large pages in MySQL attempts to use the largest size supported, up to 4MB. Under Solaris, a “super large pages” feature enables uses of pages up to 256MB. This feature is available for recent SPARC platforms. It can be enabled or disabled by using the
--super-large-pagesor--skip-super-large-pagesoption.--symbolic-links,--skip-symbolic-linksCommand-Line Format --symbolic-linksOption-File Format symbolic-linksEnable or disable symbolic link support. This option has different effects on Windows and Unix:
On Windows, enabling symbolic links enables you to establish a symbolic link to a database directory by creating a
file that contains the path to the real directory. See Section 7.11.3.1.3, “Using Symbolic Links for Databases on Windows”.db_name.symOn Unix, enabling symbolic links means that you can link a
MyISAMindex file or data file to another directory with theINDEX DIRECTORYorDATA DIRECTORYoptions of theCREATE TABLEstatement. If you delete or rename the table, the files that its symbolic links point to also are deleted or renamed. See Section 7.11.3.1.2, “Using Symbolic Links for Tables on Unix”.
Version Removed 5.5.6 Command-Line Format --skip-safemallocOption-File Format skip-safemallocPreviously, if MySQL was configured with full debugging support, all MySQL programs check for memory overruns during each memory allocation and memory freeing operation. This checking is very slow, so for the server you can avoid it when you do not need it by using the
--skip-safemallocoption.safemalloc, along with this option, was removed in MySQL 5.5.6.Command-Line Format --skip-show-databaseOption-File Format skip-show-databaseOption Sets Variable Yes, skip_show_databaseVariable Name skip_show_databaseVariable Scope Global Dynamic Variable No With this option, the
SHOW DATABASESstatement is permitted only to users who have theSHOW DATABASESprivilege, and the statement displays all database names. Without this option,SHOW DATABASESis permitted to all users, but displays each database name only if the user has theSHOW DATABASESprivilege or some privilege for the database. Note that any global privilege is considered a privilege for the database.Command-Line Format --skip-stack-traceOption-File Format skip-stack-traceDo not write stack traces. This option is useful when you are running mysqld under a debugger. On some systems, you also must use this option to get a core file. See MySQL Internals: Porting.
Command-Line Format --skip-thread-priorityOption-File Format skip-thread-priorityDeprecated 5.1.29 Disable using thread priorities for faster response time. This option is deprecated.
Command-Line Format --slow-query-logOption-File Format slow-query-logOption Sets Variable Yes, slow_query_logVariable Name slow_query_logVariable Scope Global Dynamic Variable Yes Permitted Values Type booleanDefault OFFSpecify the initial slow query log state. With no argument or an argument of 1, the
--slow-query-logoption enables the log. If omitted or given with an argument of 0, the option disables the log.Command-Line Format --socket=nameOption-File Format socketOption Sets Variable Yes, socketVariable Name socketVariable Scope Global Dynamic Variable No Permitted Values Type file nameDefault /tmp/mysql.sockOn Unix, this option specifies the Unix socket file to use when listening for local connections. The default value is
/tmp/mysql.sock. If this option is given, the server creates the file in the data directory unless an absolute path name is given to specify a different directory. On Windows, the option specifies the pipe name to use when listening for local connections that use a named pipe. The default value isMySQL(not case sensitive).--sql-mode=value[,value[,value...]]Command-Line Format --sql-mode=nameOption-File Format sql-modeOption Sets Variable Yes, sql_modeVariable Name sql_modeVariable Scope Global, Session Dynamic Variable Yes Permitted Values Type setDefault ''Valid Values ALLOW_INVALID_DATES,ANSI_QUOTES,ERROR_FOR_DIVISION_BY_ZERO,HIGH_NOT_PRECEDENCE,IGNORE_SPACE,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_BACKSLASH_ESCAPES,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION,NO_FIELD_OPTIONS,NO_KEY_OPTIONS,NO_TABLE_OPTIONS,NO_UNSIGNED_SUBTRACTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,ONLY_FULL_GROUP_BY,PAD_CHAR_TO_FULL_LENGTH,PIPES_AS_CONCAT,REAL_AS_FLOAT,STRICT_ALL_TABLES,STRICT_TRANS_TABLESSet the SQL mode. See Section 5.1.7, “Server SQL Modes”.
Command-Line Format --sysdate-is-nowOption-File Format sysdate-is-nowPermitted Values Type booleanDefault FALSESYSDATE()by default returns the time at which it executes, not the time at which the statement in which it occurs begins executing. This differs from the behavior ofNOW(). This option causesSYSDATE()to be an alias forNOW(). For information about the implications for binary logging and replication, see the description forSYSDATE()in Section 11.7, “Date and Time Functions” and forSET TIMESTAMPin Section 5.1.4, “Server System Variables”.--tc-heuristic-recover={COMMIT|ROLLBACK}Command-Line Format --tc-heuristic-recover=nameOption-File Format tc-heuristic-recoverPermitted Values Type enumerationValid Values COMMIT,RECOVERThe type of decision to use in the heuristic recovery process. Currently, this option is unused.
Command-Line Format --temp-poolOption-File Format temp-poolPermitted Values Type booleanDefault TRUEThis option causes most temporary files created by the server to use a small set of names, rather than a unique name for each new file. This works around a problem in the Linux kernel dealing with creating many new files with different names. With the old behavior, Linux seems to “leak” memory, because it is being allocated to the directory entry cache rather than to the disk cache. This option is ignored except on Linux.
Command-Line Format --transaction-isolation=nameOption-File Format transaction-isolationPermitted Values Type enumerationValid Values READ-UNCOMMITTED,READ-COMMITTED,REPEATABLE-READ,SERIALIZABLESets the default transaction isolation level. The
levelvalue can beREAD-UNCOMMITTED,READ-COMMITTED,REPEATABLE-READ, orSERIALIZABLE. See Section 12.3.6, “SET TRANSACTIONSyntax”.--tmpdir=,path-tpathCommand-Line Format --tmpdir=path-tOption-File Format tmpdirOption Sets Variable Yes, tmpdirVariable Name tmpdirVariable Scope Global Dynamic Variable No Permitted Values Type file nameThe path of the directory to use for creating temporary files. It might be useful if your default
/tmpdirectory resides on a partition that is too small to hold temporary tables. This option accepts several paths that are used in round-robin fashion. Paths should be separated by colon characters (“:”) on Unix and semicolon characters (“;”) on Windows. If the MySQL server is acting as a replication slave, you should not set--tmpdirto point to a directory on a memory-based file system or to a directory that is cleared when the server host restarts. For more information about the storage location of temporary files, see Section C.5.4.4, “Where MySQL Stores Temporary Files”. A replication slave needs some of its temporary files to survive a machine restart so that it can replicate temporary tables orLOAD DATA INFILEoperations. If files in the temporary file directory are lost when the server restarts, replication fails.--user={,user_name|user_id}-u {user_name|user_id}Command-Line Format --user=name-u nameOption-File Format userPermitted Values Type stringRun the mysqld server as the user having the name
user_nameor the numeric user IDuser_id. (“User” in this context refers to a system login account, not a MySQL user listed in the grant tables.)This option is mandatory when starting mysqld as
root. The server changes its user ID during its startup sequence, causing it to run as that particular user rather than asroot. See Section 5.3.1, “General Security Guidelines”.To avoid a possible security hole where a user adds a
--user=rootoption to amy.cnffile (thus causing the server to run asroot), mysqld uses only the first--useroption specified and produces a warning if there are multiple--useroptions. Options in/etc/my.cnfand$MYSQL_HOME/my.cnfare processed before command-line options, so it is recommended that you put a--useroption in/etc/my.cnfand specify a value other thanroot. The option in/etc/my.cnfis found before any other--useroptions, which ensures that the server runs as a user other thanroot, and that a warning results if any other--useroption is found.Use this option with the
--helpoption for detailed help.--version,-VDisplay version information and exit.
You can assign a value to a server system variable by using an
option of the form
--.
For example, var_name=value--key_buffer_size=32M
sets the key_buffer_size variable
to a value of 32MB.
Note that when you assign a value to a variable, MySQL might automatically correct the value to stay within a given range, or adjust the value to the closest permissible value if only certain values are permitted.
If you want to restrict the maximum value to which a variable can
be set at runtime with
SET, you can
define this by using the
--maximum-
command-line option.
var_name=value
You can change the values of most system variables for a running
server with the
SET
statement. See Section 12.4.4, “SET Syntax”.
Section 5.1.4, “Server System Variables”, provides a full description for all variables, and additional information for setting them at server startup and runtime. Section 7.11.2, “Tuning Server Parameters”, includes information on optimizing the server by tuning system variables.