Ubuntu Manpage: mysqladmin - client for administering a MySQL server

Provided by: mysql-client-5.6_5.6.33-0ubuntu0.14.04.1_amd64

NAME

       mysqladmin - client for administering a MySQL server

SYNOPSIS

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

DESCRIPTION

mysqladmin is a client for performing administrative operations. You can use it to check
the server's configuration and current status, to create and drop databases, and more.

Invoke mysqladmin like this:

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

mysqladmin supports the following commands. Some of the commands take an argument
following the command name.

• create db_name

Create a new database named db_name.

• debug

Tell the server to write debug information to the error log. Format and content of
this information is subject to change.

This includes information about the Event Scheduler. See Section 20.4.5, “Event
Scheduler Status”.

• drop db_name

Delete the database named db_name and all its tables.

• extended-status

Display the server status variables and their values.

• flush-hosts

Flush all information in the host cache.

• flush-logs

Flush all logs.

• flush-privileges

Reload the grant tables (same as reload).

• flush-status

Clear status variables.

• flush-tables

Flush all tables.

• flush-threads

Flush the thread cache.

• kill id,id,...

Kill server threads. If multiple thread ID values are given, there must be no spaces
in the list.

• old-password new_password

This is like the password command but stores the password using the old (pre-4.1)
password-hashing format. (See Section 6.1.2.4, “Password Hashing in MySQL”.)

• password new_password

Set a new password. This changes the password to new_password for the account that you
use with mysqladmin for connecting to the server. Thus, the next time you invoke
mysqladmin (or any other client program) using the same account, you will need to
specify the new password.

If the new_password value contains spaces or other characters that are special to your
command interpreter, you need to enclose it within quotation marks. On Windows, be
sure to use double quotation marks rather than single quotation marks; single
quotation marks are not stripped from the password, but rather are interpreted as part
of the password. For example:

shell> mysqladmin password "my new password"

In MySQL 5.6, the new password can be omitted following the password command. In this
case, mysqladmin prompts for the password value, which enables you to avoid specifying
the password on the command line. Omitting the password value should be done only if
password is the final command on the mysqladmin command line. Otherwise, the next
argument is taken as the password.

Caution
Do not use this command used if the server was started with the
--skip-grant-tables option. No password change will be applied. This is true even
if you precede the password command with flush-privileges on the same command line
to re-enable the grant tables because the flush operation occurs after you
connect. However, you can use mysqladmin flush-privileges to re-enable the grant
table and then use a separate mysqladmin password command to change the password.

• ping

Check whether the server is available. The return status from mysqladmin is 0 if the
server is running, 1 if it is not. This is 0 even in case of an error such as Access
denied, because this means that the server is running but refused the connection,
which is different from the server not running.

• processlist

Show a list of active server threads. This is like the output of the SHOW PROCESSLIST
statement. If the --verbose option is given, the output is like that of SHOW FULL
PROCESSLIST. (See Section 13.7.5.30, “SHOW PROCESSLIST Syntax”.)

• reload

Reload the grant tables.

• refresh

Flush all tables and close and open log files.

• shutdown

Stop the server.

• start-slave

Start replication on a slave server.

• status

Display a short server status message.

• stop-slave

Stop replication on a slave server.

• variables

Display the server system variables and their values.

• version

Display version information from the server.

All commands can be shortened to any unique prefix. For example:

The mysqladmin status command result displays the following values:

• Uptime

The number of seconds the MySQL server has been running.

• Threads

The number of active threads (clients).

• Questions

The number of questions (queries) from clients since the server was started.

• Slow queries

The number of queries that have taken more than long_query_time seconds. See
Section 5.4.5, “The Slow Query Log”.

• Opens

The number of tables the server has opened.

• Flush tables

The number of flush-*, refresh, and reload commands the server has executed.

• Open tables

The number of tables that currently are open.

If you execute mysqladmin shutdown when connecting 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.

mysqladmin supports the following options, which can be specified on the command line or
in the [mysqladmin] and [client] groups of an option file. For information about option
files used by MySQL programs, see Section 4.2.6, “Using Option Files”.

• --help, -?

Display a help message and exit.

• --bind-address=ip_address

On a computer having multiple network interfaces, use this option to select which
interface to use for connecting to the MySQL server.

This option is supported beginning with MySQL 5.6.1.

• --character-sets-dir=dir_name

The directory where character sets are installed. See Section 10.5, “Character Set
Configuration”.

• --compress, -C

Compress all information sent between the client and the server if both support
compression.

• --count=N, -c N

The number of iterations to make for repeated command execution if the --sleep option
is given.

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

Print some debugging information when the program exits.

• --debug-info

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

• --default-auth=plugin

A hint about the client-side authentication plugin to use. See Section 6.3.7,
“Pluggable Authentication”.

• --default-character-set=charset_name

Use charset_name as the default character set. See Section 10.5, “Character Set
Configuration”.

• --defaults-extra-file=file_name

Read this option file after the global option file but (on Unix) before the user
option file. If the file does not exist or is otherwise inaccessible, an error occurs.
file_name is interpreted relative to the current directory if given as a relative path
name rather than a full path name.

• --defaults-file=file_name

Use only the given option file. If the file does not exist or is otherwise
inaccessible, an error occurs. file_name is interpreted relative to the current
directory if given as a relative path name rather than a full path name.

• --defaults-group-suffix=str

Read not only the usual option groups, but also groups with the usual names and a
suffix of str. For example, mysqladmin normally reads the [client] and [mysqladmin]
groups. If the --defaults-group-suffix=_other option is given, mysqladmin also reads
the [client_other] and [mysqladmin_other] groups.

• --enable-cleartext-plugin

Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.5.1.7,
“The Cleartext Client-Side Authentication Plugin”.) This option was added in MySQL
5.6.7.

• --force, -f

Do not ask for confirmation for the drop db_name command. With multiple commands,
continue even if an error occurs.

• --host=host_name, -h host_name

Connect to the MySQL server on the given host.

• --login-path=name

Read options from the named login path in the .mylogin.cnf login path file. A “login
path” is an option group containing options that specify which MySQL server to connect
to and which account to authenticate as. To create or modify a login path file, use
the mysql_config_editor utility. See mysql_config_editor(1). This option was added in
MySQL 5.6.6.

• --no-beep, -b

Suppress the warning beep that is emitted by default for errors such as a failure to
connect to the server.

• --no-defaults

Do not read any option files. If program startup fails due to reading unknown options
from an option file, --no-defaults can be used to prevent them from being read.

The exception is that the .mylogin.cnf file, if it exists, is read in all cases. This
permits passwords to be specified in a safer way than on the command line even when
--no-defaults is used. (.mylogin.cnf is created by the mysql_config_editor utility.
See mysql_config_editor(1).)

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

The password to use when connecting to the server. If you use the short option form
(-p), you cannot have a space between the option and the password. If you omit the
password value following the --password or -p option on the command line, mysqladmin
prompts for one.

Specifying a password on the command line should be considered insecure. See
Section 6.1.2.1, “End-User Guidelines for Password Security”. You can use an option
file to avoid giving the password on the command line.

• --pipe, -W

On Windows, connect to the server using a named pipe. This option applies only if the
server supports named-pipe connections.

• --plugin-dir=dir_name

The directory in which to look for plugins. Specify this option if the --default-auth
option is used to specify an authentication plugin but mysqladmin does not find it.
See Section 6.3.7, “Pluggable Authentication”.

• --port=port_num, -P port_num

The TCP/IP port number to use for the connection.

• --print-defaults

Print the program name and all options that it gets from option files.

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

The connection protocol to use for connecting to the server. It is useful when the
other connection parameters normally would cause a protocol to be used other than the
one you want. For details on the permissible values, see Section 4.2.2, “Connecting to
the MySQL Server”.

• --relative, -r

Show the difference between the current and previous values when used with the --sleep
option. This option works only with the extended-status command.

• --secure-auth

Do not send passwords to the server in old (pre-4.1) format. This prevents connections
except for servers that use the newer password format. This option is enabled by
default; use --skip-secure-auth to disable it. This option was added in MySQL 5.6.17.

Note
Passwords that use the pre-4.1 hashing method are less secure than passwords that
use the native password hashing method and should be avoided. Pre-4.1 passwords
are deprecated and support for them will be removed in a future MySQL release. For
account upgrade instructions, see Section 6.5.1.3, “Migrating Away from Pre-4.1
Password Hashing and the mysql_old_password Plugin”.

Note
This option is deprecated and will be removed in a future release. As of MySQL
5.7.5, it is always enabled and attempting to disable it produces an error.

• --shared-memory-base-name=name

On Windows, the shared-memory name to use, for connections made using shared memory to
a local server. The default value is MYSQL. The shared-memory name is case sensitive.

The server must be started with the --shared-memory option to enable shared-memory
connections.

• --silent, -s

Exit silently if a connection to the server cannot be established.

• --sleep=delay, -i 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.

• --socket=path, -S path

For connections to localhost, the Unix socket file to use, or, on Windows, the name of
the named pipe to use.

• --ssl*

Options that begin with --ssl specify whether to connect to the server using SSL and
indicate where to find SSL keys and certificates. See Section 6.4.5, “Command Options
for Secure Connections”.

• --user=user_name, -u user_name

The MySQL user name to use when connecting to the server.

• --verbose, -v

Verbose mode. Print more information about what the program does.

• --version, -V

Display version information and exit.

• --vertical, -E

Print output vertically. This is similar to --relative, but prints output vertically.

• --wait[=count], -w[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.

You can also set the following variables by using --var_name=value.

• connect_timeout

The maximum number of seconds before connection timeout. The default value is 43200
(12 hours).

• shutdown_timeout

The maximum number of seconds to wait for server shutdown. The default value is 3600
(1 hour).

COPYRIGHT

       Copyright © 1997, 2016, Oracle and/or its affiliates. All rights reserved.

       This documentation is free software; you can redistribute it and/or modify it only under
       the terms of the GNU General Public License as published by the Free Software Foundation;
       version 2 of the License.

       This documentation is distributed in the hope that it will be useful, but WITHOUT ANY
       WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE. See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with the program;
       if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
       Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

AUTHOR

       Oracle Corporation (http://dev.mysql.com/).

NAME

SYNOPSIS

DESCRIPTION

COPYRIGHT

SEE ALSO

AUTHOR