Documentation Home
MySQL 9.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.0Mb
PDF (A4) - 40.1Mb
Man Pages (TGZ) - 259.0Kb
Man Pages (Zip) - 366.2Kb
Info (Gzip) - 4.0Mb
Info (Zip) - 4.0Mb


MySQL 9.0 Reference Manual  / ...  / MySQL Programs  / Server and Server-Startup Programs  /  mysqld_safe — MySQL Server Startup Script

6.3.2 mysqld_safe — MySQL Server Startup Script

mysqld_safe is the recommended way to start amysqld server on Unix.mysqld_safe adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log. A description of error logging is given later in this section.

Note

For some Linux platforms, MySQL installation from RPM or Debian packages includes systemd support for managing MySQL server startup and shutdown. On these platforms,mysqld_safe is not installed because it is unnecessary. For more information, seeSection 2.5.9, “Managing MySQL Server with systemd”.

One implication of the non-use ofmysqld_safe on platforms that use systemd for server management is that use of[mysqld_safe] or[safe_mysqld] sections in option files is not supported and might lead to unexpected behavior.

mysqld_safe tries to start an executable namedmysqld. To override the default behavior and specify explicitly the name of the server you want to run, specify a--mysqld or--mysqld-version option tomysqld_safe. You can also use--ledir to indicate the directory wheremysqld_safe should look for the server.

Many of the options tomysqld_safe are the same as the options tomysqld. SeeSection 7.1.7, “Server Command Options”.

Options unknown tomysqld_safe are passed tomysqld if they are specified on the command line, but ignored if they are specified in the[mysqld_safe] group of an option file. SeeSection 6.2.2.2, “Using Option Files”.

mysqld_safe reads all options from the[mysqld],[server], and[mysqld_safe] sections in option files. For example, if you specify a[mysqld] section like this,mysqld_safe finds and uses the--log-error option:

[mysqld]log-error=error.log

For backward compatibility,mysqld_safe also reads[safe_mysqld] sections, but to be current you should rename such sections to[mysqld_safe].

mysqld_safe accepts options on the command line and in option files, as described in the following table. For information about option files used by MySQL programs, seeSection 6.2.2.2, “Using Option Files”.

Table 6.7 mysqld_safe Options

Option NameDescription
--basedirPath to MySQL installation directory
--core-file-sizeSize of core file that mysqld should be able to create
--datadirPath to data directory
--defaults-extra-fileRead named option file in addition to usual option files
--defaults-fileRead only named option file
--helpDisplay help message and exit
--ledirPath to directory where server is located
--log-errorWrite error log to named file
--malloc-libAlternative malloc library to use for mysqld
--mysqldName of server program to start (in ledir directory)
--mysqld-safe-log-timestampsTimestamp format for logging
--mysqld-versionSuffix for server program name
--niceUse nice program to set server scheduling priority
--no-defaultsRead no option files
--open-files-limitNumber of files that mysqld should be able to open
--pid-filePath name of server process ID file
--plugin-dirDirectory where plugins are installed
--portPort number on which to listen for TCP/IP connections
--skip-kill-mysqldDo not try to kill stray mysqld processes
--skip-syslogDo not write error messages to syslog; use error log file
--socketSocket file on which to listen for Unix socket connections
--syslogWrite error messages to syslog
--syslog-tagTag suffix for messages written to syslog
--timezoneSet TZ time zone environment variable to named value
--userRun mysqld as user having name user_name or numeric user ID user_id

  • --help

    Command-Line Format--help

    Display a help message and exit.

  • --basedir=dir_name

    Command-Line Format--basedir=dir_name
    TypeDirectory name

    The path to the MySQL installation directory.

  • --core-file-size=size

    Command-Line Format--core-file-size=size
    TypeString

    The size of the core file thatmysqld should be able to create. The option value is passed toulimit -c.

    Note

    Theinnodb_buffer_pool_in_core_file variable can be used to reduce the size of core files on operating systems that support it. For more information, seeSection 17.8.3.7, “Excluding or Including Buffer Pool Pages from Core Files”.

  • --datadir=dir_name

    Command-Line Format--datadir=dir_name
    TypeDirectory name

    The path to the data directory.

  • --defaults-extra-file=file_name

    Command-Line Format--defaults-extra-file=file_name
    TypeFile name

    Read this option file in addition to the usual option files. If the file does not exist or is otherwise inaccessible, the server exits with an error. Iffile_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used.

    For additional information about this and other option-file options, seeSection 6.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, the server exits with an error. Iffile_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used.

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

  • --ledir=dir_name

    Command-Line Format--ledir=dir_name
    TypeDirectory name

    Ifmysqld_safe cannot find the server, use this option to indicate the path name to the directory where the server is located.

    This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value ofMYSQLD_OPTS. SeeSection 2.5.9, “Managing MySQL Server with systemd”.

  • --log-error=file_name

    Command-Line Format--log-error=file_name
    TypeFile name

    Write the error log to the given file. SeeSection 7.4.2, “The Error Log”.

  • --mysqld-safe-log-timestamps

    Command-Line Format--mysqld-safe-log-timestamps=type
    TypeEnumeration
    Default Valueutc
    Valid Values

    system

    hyphen

    legacy

    This option controls the format for timestamps in log output produced bymysqld_safe. The following list describes the permitted values. For any other value,mysqld_safe logs a warning and usesUTC format.

    • UTC,utc

      ISO 8601 UTC format (same as--log_timestamps=UTC for the server). This is the default.

    • SYSTEM,system

      ISO 8601 local time format (same as--log_timestamps=SYSTEM for the server).

    • HYPHEN,hyphen

      YY-MM-DD h:mm:ss format, as inmysqld_safe for MySQL 5.6.

    • LEGACY,legacy

      YYMMDD hh:mm:ss format, as inmysqld_safe prior to MySQL 5.6.

  • --malloc-lib=[lib_name]

    Command-Line Format--malloc-lib=[lib-name]
    TypeString

    The name of the library to use for memory allocation instead of the systemmalloc() library. The option value must be one of the directories/usr/lib,/usr/lib64,/usr/lib/i386-linux-gnu, or/usr/lib/x86_64-linux-gnu.

    The--malloc-lib option works by modifying theLD_PRELOAD environment value to affect dynamic linking to enable the loader to find the memory-allocation library whenmysqld runs:

    • If the option is not given, or is given without a value (--malloc-lib=),LD_PRELOAD is not modified and no attempt is made to usetcmalloc.

    • Prior to MySQL 8.0.21, if the option is given as--malloc-lib=tcmalloc,mysqld_safe looks for atcmalloc library in/usr/lib. Iftmalloc is found, its path name is added to the beginning of theLD_PRELOAD value formysqld. Iftcmalloc is not found,mysqld_safe aborts with an error.

      As of MySQL 8.0.21,tcmalloc is not a permitted value for the--malloc-lib option.

    • If the option is given as--malloc-lib=/path/to/some/library, that full path is added to the beginning of theLD_PRELOAD value. If the full path points to a nonexistent or unreadable file,mysqld_safe aborts with an error.

    • For cases wheremysqld_safe adds a path name toLD_PRELOAD, it adds the path to the beginning of any existing value the variable already has.

    Note

    On systems that manage the server using systemd,mysqld_safe is not available. Instead, specify the allocation library by settingLD_PRELOAD in/etc/sysconfig/mysql.

    Linux users can use thelibtcmalloc_minimal.so library on any platform for which atcmalloc package is installed in/usr/lib by adding these lines to themy.cnf file:

    [mysqld_safe]malloc-lib=tcmalloc

    To use a specifictcmalloc library, specify its full path name. Example:

    [mysqld_safe]malloc-lib=/opt/lib/libtcmalloc_minimal.so
  • --mysqld=prog_name

    Command-Line Format--mysqld=file_name
    TypeFile name

    The name of the server program (in theledir directory) that you want to start. This option is needed if you use the MySQL binary distribution but have the data directory outside of the binary distribution. Ifmysqld_safe cannot find the server, use the--ledir option to indicate the path name to the directory where the server is located.

    This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value ofMYSQLD_OPTS. SeeSection 2.5.9, “Managing MySQL Server with systemd”.

  • --mysqld-version=suffix

    Command-Line Format--mysqld-version=suffix
    TypeString

    This option is similar to the--mysqld option, but you specify only the suffix for the server program name. The base name is assumed to bemysqld. For example, if you use--mysqld-version=debug,mysqld_safe starts themysqld-debug program in theledir directory. If the argument to--mysqld-version is empty,mysqld_safe usesmysqld in theledir directory.

    This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value ofMYSQLD_OPTS. SeeSection 2.5.9, “Managing MySQL Server with systemd”.

  • --nice=priority

    Command-Line Format--nice=priority
    TypeNumeric

    Use thenice program to set the server's scheduling priority to the given value.

  • --no-defaults

    Command-Line Format--no-defaults
    TypeString

    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. This must be the first option on the command line if it is used.

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

  • --open-files-limit=count

    Command-Line Format--open-files-limit=count
    TypeString

    The number of files thatmysqld should be able to open. The option value is passed toulimit -n.

    Note

    You must startmysqld_safe asroot for this to function properly.

  • --pid-file=file_name

    Command-Line Format--pid-file=file_name
    TypeFile name

    The path name thatmysqld should use for its process ID file.

  • --plugin-dir=dir_name

    Command-Line Format--plugin-dir=dir_name
    TypeDirectory name

    The path name of the plugin directory.

  • --port=port_num

    Command-Line Format--port=number
    TypeNumeric

    The port number that the server should use when listening for TCP/IP connections. The port number must be 1024 or higher unless the server is started by theroot operating system user.

  • --skip-kill-mysqld

    Command-Line Format--skip-kill-mysqld

    Do not try to kill straymysqld processes at startup. This option works only on Linux.

  • --socket=path

    Command-Line Format--socket=file_name
    TypeFile name

    The Unix socket file that the server should use when listening for local connections.

  • --syslog,--skip-syslog

    Command-Line Format--syslog
    DeprecatedYes
    Command-Line Format--skip-syslog
    DeprecatedYes

    --syslog causes error messages to be sent tosyslog on systems that support thelogger program.--skip-syslog suppresses the use ofsyslog; messages are written to an error log file.

    Whensyslog is used for error logging, thedaemon.err facility/severity is used for all log messages.

    Using these options to controlmysqld logging is deprecated. To write error log output to the system log, use the instructions atSection 7.4.2.8, “Error Logging to the System Log”. To control the facility, use the serverlog_syslog_facility system variable.

  • --syslog-tag=tag

    Command-Line Format--syslog-tag=tag
    DeprecatedYes

    For logging tosyslog, messages frommysqld_safe andmysqld are written with identifiers ofmysqld_safe andmysqld, respectively. To specify a suffix for the identifiers, use--syslog-tag=tag, which modifies the identifiers to bemysqld_safe-tag andmysqld-tag.

    Using this option to controlmysqld logging is deprecated. Use the serverlog_syslog_tag system variable instead. SeeSection 7.4.2.8, “Error Logging to the System Log”.

  • --timezone=timezone

    Command-Line Format--timezone=timezone
    TypeString

    Set theTZ time zone environment variable to the given option value. Consult your operating system documentation for legal time zone specification formats.

  • --user={user_name|user_id}

    Command-Line Format--user={user_name|user_id}
    TypeString
    TypeNumeric

    Run themysqld server as the user having the nameuser_name or the numeric user IDuser_id. (User in this context refers to a system login account, not a MySQL user listed in the grant tables.)

If you executemysqld_safe with the--defaults-file or--defaults-extra-file option to name an option file, the option must be the first one given on the command line or the option file is not used. For example, this command does not use the named option file:

mysql> mysqld_safe --port=port_num --defaults-file=file_name

Instead, use the following command:

mysql> mysqld_safe --defaults-file=file_name --port=port_num

Themysqld_safe script is written so that it normally can start a server that was installed from either a source or a binary distribution of MySQL, even though these types of distributions typically install the server in slightly different locations. (SeeSection 2.1.5, “Installation Layouts”.)mysqld_safe expects one of the following conditions to be true:

  • The server and databases can be found relative to the working directory (the directory from whichmysqld_safe is invoked). For binary distributions,mysqld_safe looks under its working directory forbin anddata directories. For source distributions, it looks forlibexec andvar directories. This condition should be met if you executemysqld_safe from your MySQL installation directory (for example,/usr/local/mysql for a binary distribution).

  • If the server and databases cannot be found relative to the working directory,mysqld_safe attempts to locate them by absolute path names. Typical locations are/usr/local/libexec and/usr/local/var. The actual locations are determined from the values configured into the distribution at the time it was built. They should be correct if MySQL is installed in the location specified at configuration time.

Becausemysqld_safe tries to find the server and databases relative to its own working directory, you can install a binary distribution of MySQL anywhere, as long as you runmysqld_safe from the MySQL installation directory:

cdmysql_installation_directorybin/mysqld_safe &

Ifmysqld_safe fails, even when invoked from the MySQL installation directory, specify the--ledir and--datadir options to indicate the directories in which the server and databases are located on your system.

mysqld_safe tries to use thesleep anddate system utilities to determine how many times per second it has attempted to start. If these utilities are present and the attempted starts per second is greater than 5,mysqld_safe waits 1 full second before starting again. This is intended to prevent excessive CPU usage in the event of repeated failures. (Bug #11761530, Bug #54035)

When you usemysqld_safe to startmysqld,mysqld_safe arranges for error (and notice) messages from itself and frommysqld to go to the same destination.

There are severalmysqld_safe options for controlling the destination of these messages:

  • --log-error=file_name: Write error messages to the named error file.

  • --syslog: Write error messages tosyslog on systems that support thelogger program.

  • --skip-syslog: Do not write error messages tosyslog. Messages are written to the default error log file (host_name.err in the data directory), or to a named file if the--log-error option is given.

If none of these options is given, the default is--skip-syslog.

Whenmysqld_safe writes a message, notices go to the logging destination (syslog or the error log file) andstdout. Errors go to the logging destination andstderr.

Note

Controllingmysqld logging frommysqld_safe is deprecated. Use the server's nativesyslog support instead. For more information, seeSection 7.4.2.8, “Error Logging to the System Log”.