This manual page is for Mac OS X Server version 10.6

If you are running Mac OS X (client), this command is not available.

If you are running a different version of Mac OS X Server, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



MYSQLADMIN(1)                               MySQL Database System                              MYSQLADMIN(1)



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 commands described in the following list. 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.

         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 5.5.6.3, "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 quotes. On Windows, be sure to use double quotes rather
          than single quotes; single quotes are not stripped from the password, but rather are interpreted
          as part of the password. For example:

          shell> mysqladmin password "my new 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 alive. 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 12.5.5.27, "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:

          shell> mysqladmin proc stat
          +----+-------+-----------+----+---------+------+-------+------------------+
          | Id | User  | Host      | db | Command | Time | State | Info             |
          +----+-------+-----------+----+---------+------+-------+------------------+
          | 51 | monty | localhost |    | Query   | 0    |       | show processlist |
          +----+-------+-----------+----+---------+------+-------+------------------+
          Uptime: 1473624  Threads: 1  Questions: 39487
          Slow queries: 0  Opens: 541  Flush tables: 1
          Open tables: 19  Queries per second avg: 0.0268

       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.2.4, "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.

         Memory in use

          The amount of memory allocated directly by mysqld. This value is displayed only when MySQL has
          been compiled with --with-debug=full.

         Maximum memory used

          The maximum amount of memory allocated directly by mysqld. This value is displayed only when MySQL
          has been compiled with --with-debug=full.


       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 options in the following list. It also reads option files and supports the
       options for processing them described at Section 4.2.3.2.1, "Command-Line Options that Affect
       Option-File Handling".

         --help, -?

          Display a help message and exit.

         --character-sets-dir=path

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

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

         --default-character-set=charset_name

          Use charset_name as the default character set. See Section 9.2, "The Character Set Used for Data
          and Sorting".

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

         --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, you are prompted for one.

          Specifying a password on the command line should be considered insecure. See Section 5.5.6.2,
          "End-User Guidelines for Password Security".

         --pipe, -W

          On Windows, connect to the server via a named pipe. This option applies only for connections to a
          local server, and only if the server supports named-pipe connections.

         --port=port_num, -P port_num

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

         --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 allowable 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.
          Currently, this option works only with the extended-status command.

         --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 via SSL and indicate where
          to find SSL keys and certificates. See Section 5.5.7.3, "SSL Command Options".

         --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 The --set-variable format is
       deprecated. syntax:

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


       It is also possible to set variables by using --var_name=value. The --set-variable format is
       deprecated.

COPYRIGHT
       Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.

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

SEE ALSO
       For more information, please refer to the MySQL Reference Manual, which may already be installed
       locally and which is also available online at http://dev.mysql.com/doc/.

AUTHOR
       Sun Microsystems, Inc. (http://www.mysql.com/).



MySQL 5.0                                        05/07/2009                                    MYSQLADMIN(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.