Chapter 5. MySQL Server Administration

Options that affect security: See Section 5.4.3, “Security-Related mysqld Options”.

SSL-related options: See Section 5.6.7.3, “SSL Command Options”.

Binary log control options: See Section 14.8.4, “Binary Log Options and Variables”.

Replication-related options: See Section 14.8, “Replication and Binary Logging Options and Variables”.

Options specific to particular storage engines: See Section 13.1.1, “MyISAM Startup Options”, Section 13.5.3, “BDB Startup Options”, Section 13.2.4, “InnoDB Startup Options and System Variables”, and Section 15.4.2, “mysqld Command Options for MySQL Cluster”.

--help, -?

Display a short help message and exit. Before MySQL 4.1.1, --help displays the full help message. As of 4.1.1, it displays an abbreviated message only. Use both the --verbose and --help options to see the full message.

--allow-suspicious-udfs

This option controls whether user-defined functions that have only an xxx symbol 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. This option was added in MySQL 4.0.24, and 4.1.10a. See Section 18.2.2.6, “User-Defined Function Security Precautions”.

--ansi

Use standard (ANSI) SQL syntax instead of MySQL syntax. For more precise control over the server SQL mode, use the --sql-mode option instead. See Section 1.7.3, “Running MySQL in ANSI Mode”, and Section 5.1.7, “Server SQL Modes”.

--basedir=path, -b path

The path to the MySQL installation directory. All paths are usually resolved relative to this directory.

--big-tables

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

--bind-address=IP

The 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.0 is specified, the server listens on all interfaces.

--bootstrap

This option is used by the mysql_install_db script to create the MySQL privilege tables without having to start a full MySQL server.

--character-sets-dir=path

The directory where character sets are installed. See Section 9.2, “The Character Set Used for Data and Sorting”.

--character-set-client-handshake

Don't 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 4.1 and higher behave like MySQL 4.0. This option was added in MySQL 4.1.15.

--character-set-server=charset_name, -C charset_name

Use charset_name as the default server character set. See Section 9.2, “The Character Set Used for Data and Sorting”. If you use this option to specify a nondefault character set, you should also use --collation-server to specify the collation. This option is available as of MySQL 4.1.3.

--chroot=path, -r path

Put the mysqld server in a closed environment during startup by using the chroot() system call. This is a recommended security measure as of MySQL 4.0. (MySQL 3.23 is not able to provide a chroot() jail that is 100% closed.) Note that use of this option somewhat limits LOAD DATA INFILE and SELECT ... INTO OUTFILE.

--collation-server=collation_name

Use collation_name as the default server collation. This option is available as of MySQL 4.1.3. See Section 9.2, “The Character Set Used for Data and Sorting”.

--console

(Windows only.) Write error log messages to stderr and stdout even if --log-error is specified. mysqld does not close the console window if this option is used.

--core-file

Write a core file if mysqld dies. The name and location of the core file is system dependent. On Linux, a core file named core.pid is written to the current working directory of the process, which for mysqld is the data directory. pid represents the process ID of the server process. On Mac OS X, a core file named core.pid is written to the /cores directory. 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-size option 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 --user option. 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, -h path

The path to the data directory.

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

If MySQL is configured with --with-debug, you can use this option to get a trace file of what mysqld is doing. A typical debug_options string is 'd:t:o,file_name'. The default is 'd:t:i:o,mysqld.trace'. See MySQL Internals: Porting.

--default-character-set=charset_name, -C charset_name

Use charset_name as the default character set. This option is deprecated in favor of --character-set-server as of MySQL 4.1.3. See Section 9.2, “The Character Set Used for Data and Sorting”.

--default-collation=collation_name

Use collation_name as the default collation. This option is deprecated in favor of --collation-server as of MySQL 4.1.3. See Section 9.2, “The Character Set Used for Data and Sorting”.

--default-storage-engine=type

This option is a synonym for --default-table-type. It is available as of MySQL 4.1.2.

--default-table-type=type

Set the default table type (storage engine) for tables. See Chapter 13, Storage Engines.

--default-time-zone=timezone

Set the default server time zone. This option sets the global time_zone system variable. If this option is not given, the default time zone is the same as the system time zone (given by the value of the system_time_zone system variable. This option is available as of MySQL 4.1.3.

--delay-key-write[={OFF|ON|ALL}]

Specify how to use delayed key writes. Delayed key writing causes key buffers not to be flushed between writes for MyISAM tables. OFF disables delayed key writes. ON enables delayed key writes for those tables that were created with the DELAY_KEY_WRITE option. ALL delays key writes for all MyISAM tables. Available as of MySQL 4.0.3. See Section 7.5.3, “Tuning Server Parameters”, and Section 13.1.1, “MyISAM Startup Options”.

--delay-key-write-for-all-tables

Old form of --delay-key-write=ALL for use prior to MySQL 4.0.3. As of 4.0.3, use --delay-key-write instead.

--des-key-file=file_name

Read the default DES keys from this file. These keys are used by the DES_ENCRYPT() and DES_DECRYPT() functions.

--enable-named-pipe

Enable support for named pipes. This option applies only on Windows NT, 2000, XP, and 2003 systems, and can be used only with the mysqld-nt and mysqld-max-nt servers that support named-pipe connections.

--enable-pstack

Print a symbolic stack trace on failure.

--exit-info[=flags], -T [flags]

This 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!

--external-locking

Enable 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 lockd does not fully work (such as Linux), it is easy for mysqld to deadlock. This option was named --enable-locking before MySQL 4.0.3.

For more information about external locking, including conditions under which it can and cannot be used, see Section 7.3.4, “External Locking”.

--flush

Flush (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 A.1.4.2, “What to Do If MySQL Keeps Crashing”.

--gdb

Install an interrupt handler for SIGINT (needed to stop mysqld with ^C to set breakpoints) and disable stack tracing and core file handling. See MySQL Internals: Porting. This option was added in MySQL 4.0.14.

--init-file=file_name

Read SQL statements from this file at startup. Each statement must be on a single line and should not include comments.

--innodb_safe_binlog

If this option is given, then after a crash recovery by InnoDB, mysqld truncates the binary log after the last not-rolled-back transaction in the log. The option also causes InnoDB to print an error if the binary log is smaller or shorter than it should be. See Section 5.3.4, “The Binary Log”.

--innodb-xxx

The InnoDB options are listed in Section 13.2.4, “InnoDB Startup Options and System Variables”.

--language=lang_name, -L lang_name

Return client error messages in the given language. lang_name can be given as the language name or as the full path name to the directory where the language files are installed. See Section 9.3, “Setting the Error Message Language”.

--log[=file_name], -l [file_name]

Log connections and SQL statements received from clients to this file. See Section 5.3.2, “The General Query Log”. If you omit the file name, MySQL uses host_name.log as the file name.

--log-error[=file_name]

Log errors and startup messages to this file. See Section 5.3.1, “The Error Log”. If you omit the file name, MySQL uses host_name.err. If the file name has no extension, the server adds an extension of .err.

--log-isam[=file_name]

Log all ISAM/MyISAM changes to this file (used only when debugging ISAM/MyISAM).

--log-long-format

Log extra information to the update log, binary update log, and slow query log, if they have been activated. For example, the user name and timestamp are logged for queries. Before MySQL 4.1, if you are using --log-slow-queries and --log-long-format, queries that are not using indexes also are logged to the slow query log. --log-long-format is deprecated as of MySQL version 4.1, when --log-short-format was introduced. (Long log format is the default setting since version 4.1.) Also note that starting with MySQL 4.1, the --log-queries-not-using-indexes option is available for the purpose of logging queries that do not use indexes to the slow query log.

--log-queries-not-using-indexes

If you are using this option with the slow query log enabled, queries that are expected to retrieve all rows are logged. See Section 5.3.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. This option is available as of MySQL 4.1.

--log-short-format

Originally intended to log less information to the update log, binary log and slow query log, if they have been activated. This option was introduced in MySQL 4.1, but is not operational.

--log-slow-admin-statements

Log slow administrative statements such as OPTIMIZE TABLE, ANALYZE TABLE, and ALTER TABLE to the slow query log.

This option was added in MySQL 4.1.13. (It is unnecessary in MySQL 4.0 because slow administrative statements are logged by default.)

--log-slow-queries[=file_name]

Log all queries that have taken more than long_query_time seconds to execute to this file. See Section 5.3.5, “The Slow Query Log”. Note that the default for the amount of information logged has changed in MySQL 4.1. See the --log-long-format and --log-short-format options for details.

--log-update[=file_name]

Log updates to fileN where N is a unique number if not given. See Section 5.3.3, “The Update Log”. The update log is now deprecated; you should use the binary log instead (--log-bin). See Section 5.3.4, “The Binary Log”.

--log-warnings[=level], -W [level]

Print 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 by default as of MySQL 4.0.19 and 4.1.2; to disable it, use --log-warnings=0. As of MySQL 4.0.21 and 4.1.3, a level argument can be given. If omitted, the default level is 1. If the value is greater than 1, aborted connections are written to the error log. See Section A.1.2.11, “Communication Errors and Aborted Connections”.

If a slave server was started with --log-warnings enabled, 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.

Before MySQL 4.0.21 and 4.1.3, this is a boolean option, not an integer-valued option. Before 4.0, this option was named --warnings.

--low-priority-updates

Give table-modifying operations (INSERT, REPLACE, DELETE, UPDATE) lower priority than selects. This can also be done via {INSERT | REPLACE | DELETE | UPDATE} LOW_PRIORITY ... to lower the priority of only one query, or by SET LOW_PRIORITY_UPDATES=1 to change the priority in one thread. This affects only storage engines that use only table-level locking (MyISAM, MEMORY, MERGE). See Section 7.3.2, “Table Locking Issues”.

--memlock

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

--memlock works on systems that support the mlockall() 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 not mlockall() (and thus this option) is supported by checking to see whether or not it is defined in the system mman.h file, like this:

shell> grep mlockall /usr/include/sys/mman.h

If mlockall() is supported, you should see in the output of the previous command something like the following:

extern int mlockall (int __flags) __THROW;

--myisam-block-size=N

The block size to be used for MyISAM index pages.

--myisam-recover[=option[,option]...]]

Set the MyISAM storage engine recovery mode. The option value is any combination of the values of DEFAULT, BACKUP, FORCE, or QUICK. If you specify multiple values, separate them by commas. You can also use a value of "" to disable this option. If this option is used, each time mysqld opens a MyISAM table, it checks whether the table is marked as crashed or wasn't 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.

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.

See Section 13.1.1, “MyISAM Startup Options”.

This option is available as of MySQL 3.23.25.

--new

The --new option can be used to make the server behave as 4.1 in certain respects, easing a 4.0 to 4.1 upgrade:

This option can be used to help you see how your applications behave in MySQL 4.1, without actually upgrading to 4.1.

--old-passwords

Force 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.6.6.3, “Password Hashing in MySQL”.

--old-protocol, -o

Use the 3.20 protocol for compatibility with some very old clients. This option was removed in MySQL 4.1.1.

--one-thread

Only use one thread (for debugging under Linux). This option is available only if the server is built with debugging enabled. See MySQL Internals: Porting.

--open-files-limit=count

Changes 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 with setrlimit(). 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_connections and table_cache to estimate whether more descriptors will be needed.

--pid-file=path

The path name of the process ID file. This file is used by other programs such as mysqld_safe to determine the server's process ID.

--port=port_num, -P port_num

The 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 root system user.

--safe-mode

Skip some optimization stages.

--safe-show-database

With this option, the SHOW DATABASES statement displays only the names of those databases for which the user has some kind of privilege. As of MySQL 4.0.2, this option is deprecated and does not do anything (it is enabled by default), because there is a SHOW DATABASES privilege that can be used to control access to database names on a per-account basis. See Section 5.5.1, “Privileges Provided by MySQL”.

--safe-user-create

If this option is enabled, a user cannot create new MySQL users by using the GRANT statement, if the user doesn't have the INSERT privilege for the mysql.user table or any column in the table.

--secure-auth

Disallow authentication by clients that attempt to use accounts that have old (pre-4.1) passwords. This option is available as of MySQL 4.1.1.

--shared-memory

Enable shared-memory connections by local clients. This option is available only on Windows. It was added in MySQL 4.1.0.

--shared-memory-base-name=name

The 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. This option was added in MySQL 4.1.0.

--skip-bdb

Disable the BDB storage engine. This saves memory and might speed up some operations. Do not use this option if you require BDB tables.

--skip-concurrent-insert

Turn off the ability to select and insert at the same time on MyISAM tables. (This is to be used only if you think you have found a bug in this feature.) See Section 7.3.3, “Concurrent Inserts”.

--skip-delay-key-write

Ignore the DELAY_KEY_WRITE option for all tables. As of MySQL 4.0.3, you should use --delay-key-write=OFF instead. See Section 7.5.3, “Tuning Server Parameters”.

--skip-external-locking

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.3.4, “External Locking”.

External locking has been disabled by default since MySQL 4.0.

--skip-grant-tables

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 PRIVILEGES statement after connecting to the server. This option also suppresses loading of user-defined functions (UDFs).

--skip-host-cache

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.5.9, “How MySQL Uses DNS”.

--skip-innodb

Disable the InnoDB storage engine. This saves memory and disk space and might speed up some operations. Do not use this option if you require InnoDB tables.

--skip-isam

Disable the ISAM storage engine. As of MySQL 4.1, ISAM is disabled by default, so this option applies only if the server was configured with support for ISAM. This option was added in MySQL 4.1.1.

--skip-merge

Disable the MERGE storage engine. This option was added in MySQL 4.1.21. It can be used if the following behavior is undesirable: If a user has access to MyISAM table t, that user can create a MERGE table m that accesses t. However, if the user's privileges on t are subsequently revoked, the user can continue to access t by doing so through m.

--skip-name-resolve

Do not resolve host names when checking client connections. Use only IP numbers. If you use this option, all Host column values in the grant tables must be IP numbers or localhost. See Section 7.5.9, “How MySQL Uses DNS”.

--skip-networking

Do not listen for TCP/IP connections at all. All interaction with mysqld must be made via 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 allowed. See Section 7.5.9, “How MySQL Uses DNS”.

--skip-new

Do not use new, possibly wrong routines.

--skip-symlink

This is the old form of --skip-symbolic-links, for use before MySQL 4.0.13.

--ssl*

Options that begin with --ssl specify whether to allow clients to connect via SSL and indicate where to find SSL keys and certificates. See Section 5.6.7.3, “SSL Command Options”.

--standalone

Available on Windows NT-based systems only; instructs the MySQL server not to run as a service.

--symbolic-links, --skip-symbolic-links

Enable or disable symbolic link support. This option has different effects on Windows and Unix:

This option was added in MySQL 4.0.13.

--skip-safemalloc

If MySQL is configured with --with-debug=full, 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-safemalloc option.

--skip-show-database

With this option, the SHOW DATABASES statement is allowed only to users who have the SHOW DATABASES privilege, and the statement displays all database names. Without this option, SHOW DATABASES is allowed to all users, but displays each database name only if the user has the SHOW DATABASES privilege or some privilege for the database. Note that any global privilege is considered a privilege for the database.

--skip-stack-trace

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

--skip-thread-priority

Disable using thread priorities for faster response time.

--socket=path

On Unix, this option specifies the Unix socket file to use when listening for local connections. The default value is /tmp/mysql.sock. On Windows, the option specifies the pipe name to use when listening for local connections that use a named pipe. The default value is MySQL (not case sensitive).

--sql-mode=value[,value[,value...]]

Set the SQL mode. See Section 5.1.7, “Server SQL Modes”. This option was added in 3.23.41.

--temp-pool

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

--transaction-isolation=level

Sets the default transaction isolation level. The level value can be READ-UNCOMMITTED, READ-COMMITTED, REPEATABLE-READ, or SERIALIZABLE. See Section 12.4.6, “SET TRANSACTION Syntax”.

--tmpdir=path, -t path

The path of the directory to use for creating temporary files. It might be useful if your default /tmp directory resides on a partition that is too small to hold temporary tables. Starting from MySQL 4.1.0, 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, NetWare, and OS/2. If the MySQL server is acting as a replication slave, you should not set --tmpdir to 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 A.1.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 or LOAD DATA INFILE operations. 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}

Run the mysqld server as the user having the name user_name or the numeric user ID user_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 as root. See Section 5.4.1, “General Security Guidelines”.

Starting from MySQL 3.23.56 and 4.0.12: To avoid a possible security hole where a user adds a --user=root option to a my.cnf file (thus causing the server to run as root), mysqld uses only the first --user option specified and produces a warning if there are multiple --user options. Options in /etc/my.cnf and $MYSQL_HOME/my.cnf are processed before command-line options, so it is recommended that you put a --user option in /etc/my.cnf and specify a value other than root. The option in /etc/my.cnf is found before any other --user options, which ensures that the server runs as a user other than root, and that a warning results if any other --user option is found.

--verbose, -v

As of MySQL 4.1.1, use this option with the --help option for detailed help.

--version, -V

Display version information and exit.

To see the values that a server will use based on its compiled-in defaults and any option files that it reads, use this command (omit --verbose before MySQL 4.1.1):

mysqld --verbose --help

To see the values that a server will use based on its compiled-in defaults, ignoring the settings in any option files, use this command (omit --verbose before MySQL 4.1.1):

mysqld --no-defaults --verbose --help

To see the current values used by a running server, use the SHOW VARIABLES statement.