mysqladmin

mysqladmin is an administration program for the mysqld daemon. It can be used to:

  • Monitor what the MariaDB clients are doing (processlist)
  • Get usage statistics and variables from the MariaDB server
  • Create/drop databases
  • Flush (reset) logs, statistics and tables
  • Kill running queries.
  • Stop the server (shutdown)
  • Start/stop slaves
  • Check if the server is alive (ping)

Using mysqladmin

The command to use mysqladmin and the general syntax is:

mysqladmin [options] command [command-arg] [command [command-arg]] ...

Options

mysqladmin supports the following options:

OptionDescriptionAdded
--character-sets-dir=nameDirectory where the character set files are located.
-C, --compressCompress all information sent between the client and the server if both support compression.
--connect_timeout=valMaximum time in seconds before connection timeout. The default value is 43200 (12 hours).
-c val, --count=valNumber of iterations to make. This works with -i (--sleep) only.
--debug[=debug_options], -# [debug_options]Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o,/tmp/mysqladmin.trace.
--debug-checkCheck memory and open file usage at exit.
--debug-infoPrint debugging information and memory and CPU usage statistics when the program exits.
--default-auth=pluginDefault authentication client-side plugin to use.
--default-character-set=nameSet the default character set.
-f, --forceDon't ask for confirmation on drop database; with multiple commands, continue even if an error occurs.
-?, --helpDisplay this help and exit.
-h name, --host=nameHostname to connect to.
-l, --localSuppress the SQL command(s) from being written to the binary log by enabling sql_log_bin=0 for the session, or, from MariaDB 10.2.7 and MariaDB 10.1.24, for flush commands only, using FLUSH LOCAL rather than SET sql_log_bin=0, so the privilege requirement is RELOAD rather than SUPER.MariaDB 10.2.5, MariaDB 10.1.22, MariaDB 10.0.30
-b, --no-beepTurn off beep on error.
-p[password], --password[=password]Password to use when connecting to server. If password is not given it's asked from the terminal.
--pipe, -WOn Windows, connect to the server via a named pipe. This option applies only if the server supports named-pipe connections.
-P portnum, --port=portnumPort number to use for connection, or 0 for default to, in order of preference, my.cnf, $MYSQL_TCP_PORT, /etc/services, built-in default (3306).
--protocol=nameThe protocol to use for connection (tcp, socket, pipe, memory).
-r, --relativeShow difference between current and previous values when used with -i. Currently only works with extended-status.
-O value, --set-variable=vaueChange the value of a variable. Please note that this option is deprecated; you can set variables directly with --variable-name=value.
--shutdown_timeout=valMaximum number of seconds to wait for server shutdown. The default value is 3600 (1 hour).
-s, --silentSilently exit if one can't connect to server.
-i delay, --sleep=delay Execute commands repeatedly, sleeping for delay seconds in between. The --count option determines the number of iterations. If --count is not given, mysqladmin executes commands indefinitely until interrupted.
-S name, --socket=nameFor connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.
--sslEnables TLS. TLS is also enabled even without setting this option when certain other TLS options are set. Starting with MariaDB 10.2, the --ssl option will not enable verifying the server certificate by default. In order to verify the server certificate, the user must specify the --ssl-verify-server-cert option.
--ssl-ca=nameDefines a path to a PEM file that should contain one or more X509 certificates for trusted Certificate Authorities (CAs) to use for TLS. This option requires that you use the absolute path, not a relative path. See Secure Connections Overview: Certificate Authorities (CAs) for more information. This option implies the --ssl option.
--ssl-capath=nameDefines a path to a directory that contains one or more PEM files that should each contain one X509 certificate for a trusted Certificate Authority (CA) to use for TLS. This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the openssl rehash command. See Secure Connections Overview: Certificate Authorities (CAs) for more information. This option is only supported if the client was built with OpenSSL or yaSSL. If the client was built with GnuTLS or Schannel, then this option is not supported. See TLS and Cryptography Libraries Used by MariaDB for more information about which libraries are used on which platforms. This option implies the --ssl option.
--ssl-cert=nameDefines a path to the X509 certificate file to use for TLS. This option requires that you use the absolute path, not a relative path. This option implies the --ssl option.
--ssl-cipher=nameList of permitted ciphers or cipher suites to use for TLS. This option implies the --ssl option.
--ssl-crl=nameDefines a path to a PEM file that should contain one or more revoked X509 certificates to use for TLS. This option requires that you use the absolute path, not a relative path. See Secure Connections Overview: Certificate Revocation Lists (CRLs) for more information. This option is only supported if the client was built with OpenSSL or Schannel. If the client was built with yaSSL or GnuTLS, then this option is not supported. See TLS and Cryptography Libraries Used by MariaDB for more information about which libraries are used on which platforms.
--ssl-crlpath=nameDefines a path to a directory that contains one or more PEM files that should each contain one revoked X509 certificate to use for TLS. This option requires that you use the absolute path, not a relative path. The directory specified by this option needs to be run through the openssl rehash command. See Secure Connections Overview: Certificate Revocation Lists (CRLs) for more information. This option is only supported if the client was built with OpenSSL. If the client was built with yaSSL, GnuTLS, or Schannel, then this option is not supported. See TLS and Cryptography Libraries Used by MariaDB for more information about which libraries are used on which platforms.
--ssl-key=nameDefines a path to a private key file to use for TLS. This option requires that you use the absolute path, not a relative path. This option implies the --ssl option.
--ssl-verify-server-certEnables server certificate verification. This option is disabled by default.
-u, --user=nameUser for login if not current user.
-v, --verboseWrite more information.
-V, --versionOutput version information and exit.
-E, --verticalPrint output vertically. Is similar to '--relative', but prints output vertically.
-w[count], --wait[=count]If the connection cannot be established, wait and retry instead of aborting. If a count value is given, it indicates the number of times to retry. The default is one time.

Option Files

In addition to reading options from the command-line, mysqladmin can also read options from option files. If an unknown option is provided to mysqladmin in an option file, then it is ignored.

The following options relate to how MariaDB command-line tools handles option files. They must be given as the first argument on the command-line:

OptionDescription
--print-defaultsPrint the program argument list and exit.
--no-defaultsDon't read default options from any option file.
--defaults-file=# Only read default options from the given file #.
--defaults-extra-file=# Read this file after the global files are read.
--defaults-group-suffix=# In addition to the default option groups, also read option groups with this suffix.

In MariaDB 10.2 and later, mysqladmin is linked with MariaDB Connector/C. However, MariaDB Connector/C does not yet handle the parsing of option files for this client. That is still performed by the server option file parsing code. See MDEV-19035 for more information.

Option Groups

mysqladmin reads options from the following option groups from option files:

GroupDescription
[mysqladmin] Options read by mysqladmin, which includes both MariaDB Server and MySQL Server.
[client] Options read by all MariaDB and MySQL client programs, which includes both MariaDB and MySQL clients. For example, mysqldump.
[client-server]Options read by all MariaDB client programs and the MariaDB Server. This is useful for options like socket and port, which is common between the server and the clients.
[client-mariadb]Options read by all MariaDB client programs.

mysqladmin Variables

Variables can be set with --variable-name=value.

Variables and boolean optionsValue
count0
debug-checkFALSE
debug-infoFALSE
forceFALSE
compressFALSE
character-sets-dir(No default value)
default-character-set(No default value)
host(No default value)
no-beepFALSE
port3306
relativeFALSE
socket/var/run/mysqld/mysqld.sock
sleep0
sslFALSE
ssl-ca(No default value)
ssl-capath(No default value)
ssl-cert(No default value)
ssl-cipher(No default value)
ssl-key(No default value)
ssl-verify-server-certFALSE
user(No default value)
verboseFALSE
verticalFALSE
connect_timeout43200
shutdown_timeout3600

mysqladmin Commands

Command is one or more of the following. Commands may be shortened to a unique prefix.

CommandDescriptionAdded
create databasenameCreate a new database.
debugInstruct server to write debug information to log.
drop databasenameDelete a database and all its tables.
extended-statusReturn all status variables and their values.
flush-all-statisticsFlush all statistics tables
flush-all-statusFlush status and statistics.
flush-binary-logFlush binary log.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-client-statisticsFlush client statistics.
flush-engine-logFlush engine log.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-error-logFlush error log.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-general-logFlush general query log.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-hostsFlush all cached hosts.
flush-index-statisticsFlush index statistics.
flush-logsFlush all logs.
flush-privilegesReload grant tables (same as reload).
flush-relay-logFlush relay log.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-slow-logFlush slow query log.
flush-statusClear status variables.
flush-table-statisticsClear table statistics.
flush-tablesFlush all tables.
flush-threadsFlush the thread cache.
flush-user-resourcesFlush user resources.MariaDB 10.0.30,
MariaDB 10.1.25,
MariaDB 10.2.5
flush-user-statisticsFlush user statistics.
kill id,id,...Kill mysql threads.
password new-passwordChange old password to new-password. The new password can be passed on the commandline as the next argument (for example, mysqladmin password "new_password", or, from MariaDB 10.0, can be omitted (as long as no other command follows), in which case the user will be prompted for a password. If the password contains special characters, it needs to be enclosed in quotation marks. In Windows, the quotes can only be double quotes, as single quotes are assumed to be part of the password. If the server was started with the --skip-grant-tables option, changing the password in this way will have no effect.
old-password new-passwordChange old password to new-password using the old pre-MySQL 4.1 format.
pingCheck if mysqld is alive. Return status is 0 if the server is running (even in the case of an error such as access denied), 1 if it is not.
processlistShow list of active threads in server, equivalent to SHOW PROCESSLIST. With --verbose, equivalent to SHOW FULL PROCESSLIST.
reloadReload grant tables.
refreshFlush all tables and close and open log files.
shutdownTake server down by executing the SHUTDOWN command on the server. If connected to a local server using a Unix socket file, mysqladmin waits until the server's process ID file has been removed to ensure that the server has stopped properly.
statusGives a short status message from the server.
start-all-slavesStart all slaves.MariaDB 10.0.0
start-slaveStart replication on a slave server.
stop-all-slavesStop all slaves.MariaDB 10.0.0
stop-slaveStop replication on a slave server.
variablesPrints variables available.
versionReturns version as well as status info from the server.

Examples

Quick check of what the server is doing:

shell> mysqladmin status
Uptime: 8023 Threads: 1 Questions: 14 Slow queries: 0 Opens: 15 Flush tables: 1 Open tables: 8 Queries per second avg: 0.1
shell> mysqladmin processlist
+----+-------+-----------+----+---------+------+-------+------------------+
| Id | User | Host | db | Command | Time | State | Info |
+----+-------+-----------+----+---------+------+-------+------------------+
....
+----+-------+-----------+----+---------+------+-------+------------------+

More extensive information of what is happening 'just now' changing (great for troubleshooting a slow server):

shell> mysqladmin --relative --sleep=1 extended-status | grep -v " 0 "

Check the variables for a running server:

shell> mysqladmin variables | grep datadir
| datadir | /my/data/ |

Using a shortened prefix for the version command:

shell> mysqladmin ver
mysqladmin Ver 9.1 Distrib 10.1.6-MariaDB, for debian-linux-gnu on x86_64
Copyright (c) 2000, 2015, Oracle, MariaDB Corporation Ab and others.

Server version		10.1.6-MariaDB-1~trusty-log
Protocol version	10
Connection		Localhost via UNIX socket
UNIX socket		/var/run/mysqld/mysqld.sock
Uptime:			1 hour 33 min 33 sec

Threads: 1 Questions: 281 Slow queries: 0 Opens: 64 Flush tables: 1 Open tables: 76 Queries per second avg: 0.050

Other Ways To Stop mysqld (Unix)

If you get the error:

mysqladmin: shutdown failed; error: 'Access denied; you need (at least one of) the SHUTDOWN privilege(s) for this operation'

It means that you didn't use mysqladmin with a user that has the SUPER or SHUTDOWN privilege.

If you don't know the user password, you can still take the mysqld process down with a system kill command:

kill -SIGTERM pid-of-mysqld-process

The above is identical to mysqladmin shutdown.

On windows you should use:

NET STOP MySQL

With MariaDB 10.0 and newer you can use the SHUTDOWN command from any client.

See Also

  • SHUTDOWN command
  • mytop, a 'top' like program for MariaDB/MySQL that allows you to see what the server is doing. A mytop optimized for MariaDB is included in MariaDB 5.3

Comments

Comments loading...