MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

Instances are guarded by default. An instance can be designated as nonguarded by including the nonguarded option in the configuration file.

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

Display a help message and exit.

Add a new user (specified with the --username option) to the password file. This option was added in MySQL 5.1.12.

The file in which the angel process records its process ID when mysqlmanager runs in daemon mode (that is, when the --run-as-service option is given). The default file name is mysqlmanager.angel.pid.

If the --angel-pid-file option is not given, the default angel PID file has the same name as the PID file except that any PID file extension is replaced with an extension of .angel.pid. (For example, mysqlmanager.pid becomes mysqlmanager.angel.pid.)

This option was added in MySQL 5.1.11.

The IP address to bind to.

Check the validity and consistency of the password file. This option was added in MySQL 5.1.12.

Drop all users from the password file. This option was added in MySQL 5.1.12.

Write a debugging log. A typical debug_options string is 'd:t:o,file_name'. This option was added in MySQL 5.1.10.

The path name of the MySQL Server binary. This path name is used for all server instance sections in the configuration file for which no mysqld-path option is present. The default value of this option is the compiled-in path name, which depends on how the MySQL distribution was configured. Example: --default-mysqld-path=/usr/sbin/mysqld

Read Instance Manager and MySQL Server settings from the given file. All configuration changes made by the Instance Manager will be written to this file. This must be the first option on the command line if it is used, and the file must exist.

If this option is not given, Instance Manager uses its standard configuration file. On Windows, the standard file is my.ini in the directory where Instance Manager is installed. On Unix, the standard file is /etc/my.cnf.

Drop a user (specified with the --username option) from the password file. This option was added in MySQL 5.1.12.

Change an entry for an existing user (specified with the --username option) in the password file. This option was added in MySQL 5.1.12.

On Windows, install Instance Manager as a Windows service. The service name is MySQL Manager.

List the users in the password file. This option was added in MySQL 5.1.12.

The path to the Instance Manager log file. This option has no effect unless the --run-as-service option is also given. If the file name specified for the option is a relative name, the log file is created under the directory from which Instance Manager is started. To ensure that the file is created in a specific directory, specify it as a full path name.

If --run-as-service is given without --log, the log file is mysqlmanager.log in the data directory.

If --run-as-service is not given, log messages go to the standard output. To capture log output, you can redirect Instance Manager output to a file:

mysqlmanager > im.log

The interval in seconds for monitoring server instances. The default value is 20 seconds. Instance Manager tries to connect to each monitored (guarded) instance using the nonexisting MySQL_Instance_Manager user account to check whether it is available/not hanging. If the result of the connection attempt indicates that the instance is unavailable, Instance Manager performs several attempts to restart the instance.

Normally, the MySQL_Instance_Manager account does not exist, so the connection attempts by Instance Manager cause the monitored instance to produce messages in its general query log similar to the following:

Access denied for user 'MySQL_Instance_M'@'localhost' »


    (using password: YES)

The nonguarded option in the appropriate server instance section disables monitoring for a particular instance. If the instance dies after being started, Instance Manager will not restart it. Instance Manager tries to connect to a nonguarded instance only when you request the instance's status (for example, with the SHOW INSTANCES status.

See the section called “MYSQL SERVER INSTANCE STATUS MONITORING”, for more information.

Run in a mysqld_safe-compatible manner. For details, see the section called “STARTING THE MYSQL SERVER WITH MYSQL INSTANCE MANAGER”. This option was added in MySQL 5.1.12.

Specify the password for an entry to be added to or modified in the password file. Unlike the --password/-P option for most MySQL programs, the password value is required, not optional. See also the section called “INSTANCE MANAGER USER AND PASSWORD MANAGEMENT”. This option was added in MySQL 5.1.12.

The name of the file where the Instance Manager looks for users and passwords. On Windows, the default is mysqlmanager.passwd in the directory where Instance Manager is installed. On Unix, the default file is /etc/mysqlmanager.passwd. See also the section called “INSTANCE MANAGER USER AND PASSWORD MANAGEMENT”.

The process ID file to use. On Windows, the default file is mysqlmanager.pid in the directory where Instance Manager is installed. On Unix, the default is mysqlmanager.pid in the data directory.

The port number to use when listening for TCP/IP connections from clients. The default port number (assigned by IANA) is 2273.

Print the current defaults and exit. This must be the first option on the command line if it is used.

Prepare an entry for the password file, print it to the standard output, and exit. You can redirect the output from Instance Manager to a file to save the entry in the file.

Prior to MySQL 5.1.12, this option was named --passwd.

On Windows, removes Instance Manager as a Windows service. This assumes that Instance Manager has been run with --install previously.

On Unix, daemonize and start an angel process. The angel process monitors Instance Manager and restarts it if it crashes. (The angel process itself is simple and unlikely to crash.)

On Unix, the socket file to use for incoming connections. The default file is named /tmp/mysqlmanager.sock. This option has no meaning on Windows.

This option is used on Windows to run Instance Manager in standalone mode. You should specify it when you start Instance Manager from the command line.

On Unix, the user name of the system account to use for starting and running mysqlmanager. This option generates a warning and has no effect unless you start mysqlmanager as root (so that it can change its effective user ID), or as the named user. It is recommended that you configure mysqlmanager to run using the same account used to run the mysqld server. (“User” in this context refers to a system login account, not a MySQL user listed in the grant tables.)

Specify the user name for an entry to be added to or modified in the password file. This option was added in MySQL 5.1.12.

Display version information and exit.

The number of seconds to wait for activity on an incoming connection before closing it. The default is 28800 seconds (8 hours).

This option was added in MySQL 5.1.7. Before that, the timeout is 30 seconds and cannot be changed.

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

# MySQL Instance Manager options section
[manager]
default-mysqld-path = /usr/local/mysql/libexec/mysqld
socket=/tmp/manager.sock
pid-file=/tmp/manager.pid
password-file = /home/cps/.mysqlmanager.passwd
monitoring-interval = 2
port = 1999
bind-address = 192.168.1.5

The Instance Manager-specific options must not be used in a [mysqld] section. If a server is started without using Instance Manager, it will not recognize these options and will fail to start properly.

The path name of the mysqld server binary to use for the server instance.

This option disables Instance Manager monitoring functionality for the server instance. By default, an instance is guarded: At Instance Manager start time, it starts the instance. It also monitors the instance status and attempts to restart it if it fails. At Instance Manager exit time, it stops the instance. None of these things happen for nonguarded instances.

The number of seconds Instance Manager should wait for the server instance to shut down. The default value is 35 seconds. After the delay expires, Instance Manager assumes that the instance is hanging and attempts to terminate it. If you use InnoDB with large tables, you should increase this value.

[mysqld1]
mysqld-path=/usr/local/mysql/libexec/mysqld
socket=/tmp/mysql.sock
port=3307
server_id=1
skip-stack-trace
core-file
log-bin
log-error
log=mylog
log-slow-queries
[mysqld2]
nonguarded
port=3308
server_id=2
mysqld-path= /home/cps/mysql/trees/mysql-5.1/sql/mysqld
socket     = /tmp/mysql.sock5
pid-file   = /tmp/hostname.pid5
datadir= /home/cps/mysql_data/data_dir1
language=/home/cps/mysql/trees/mysql-5.1/sql/share/english
log-bin
log=/tmp/fordel.log

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

[mysql.server]
use-manager

The [mysqld] instance section, if it exists, must not contain any Instance Manager-specific options.

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

Any Instance Manager process that is running to monitor server instances does not notice changes to the password file. You must stop it and restart it after making password entry changes.

petr:*35110DC9B4D8140F5DE667E28C72DD2597B5C848

shell> mysql -h 127.0.0.1 -P 2273

shell> mysqlmanager --passwd >> /etc/mysqlmanager.passwd
Creating record for new user.
Enter user name: mike
Enter password: mikepass
Re-type password: mikepass

mike:*BBF1F551DD9DD96A01E66EC7DDC073911BAD17BA

shell> mysql -B --skip-column-name \


         -e 'SELECT CONCAT("user_name",":",PASSWORD("pass_val"));'

shell> mysqlmanager --print-password-line


         --username=mike --password=mikepass >> /etc/mysqlmanager.passwd

mysqlmanager --add-user --username=user_name [--password=password]

This command adds a new entry with the given user name and password to the password file. The --username (or -u) option is required. mysqlmanager prompts for the password if it is not given on the command line with the --password (or -p) option. The command fails if the user already exists.

mysqlmanager --drop-user --username=user_name

This command removes the entry with the given user name from the password file. The user name is required. The command fails if the user does not exist.

mysqlmanager --edit-user --username=user_name [--password=password]

This command changes the given user's password in the password file. The user name is required. mysqlmanager prompts for the password it is not given on the command line. The command fails if the user does not exist.

mysqlmanager --list-users

This command lists the user names of the accounts in the password file.

mysqlmanager --check-password-file

This command performs a consistency and validity check of the password file. The command fails if there is something wrong with the file.

mysqlmanager --clean-password-file

This command empties the password file, which has the effect of dropping all users listed in it. The option creates the password file if it does not exist, so it can be used to initialize a new password file to be used for other account-management operations. Take care not to use this option to reinitialize a file containing accounts that you do not want to drop.

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

shell> mysql --port=2273 --host=im.example.org --user=mysql --password

MySQL Instance Manager has been deprecated and is removed in MySQL 5.5.

As of MySQL 5.1.12, configuration-changing commands modify both the in-memory cache and the server instance section recorded in the configuration file to maintain consistency between them. For this to occur, the instance must be offline and the configuration file must be accessible and not malformed. If the configuration file cannot be updated, the command fails and the cache remains unchanged.

This command configures a new instance by creating an [instance_name] section in the configuration file. The command fails if instance_name is not a valid instance name or the instance already exists.

The created section instance is empty if no options are given. Otherwise, the options are added to the section. Options should be given in the same format used when you write options in option files. (See Section 4.2.3.3, “Using Option Files” for a description of the permissible syntax.) If you specify multiple options, separate them by commas.

For example, to create an instance section named [mysqld98], you might write something like this were you to modify the configuration file directly:

[mysqld98]
basedir=/var/mysql98

To achieve the same effect using CREATE INSTANCE, issue this command to Instance Manager:

mysql> CREATE INSTANCE mysqld98 basedir="/var/mysql98";
Query OK, 0 rows affected (0,00 sec)

CREATE INSTANCE creates the instance but does not start it.

If the instance name is the (deprecated) name mysqld, the option list cannot include any options that are specific to Instance Manager, such as nonguarded (see the section called “MYSQL INSTANCE MANAGER CONFIGURATION FILES”).

This command was added in MySQL 5.1.12.

This command removes the configuration for instance_name from the configuration file.

mysql> DROP INSTANCE mysqld98;
Query OK, 0 rows affected (0,00 sec)

The command fails if instance_name is not a valid instance name, the instance does not exist, or is not offline.

This command was added in MySQL 5.1.12.

This command attempts to start an offline instance. The command is asynchronous; it does not wait for the instance to start.

mysql> START INSTANCE mysqld4;
Query OK, 0 rows affected (0,00 sec)

This command attempts to stop an instance. The command is synchronous; it waits for the instance to stop.

mysql> STOP INSTANCE mysqld4;
Query OK, 0 rows affected (0,00 sec)

Shows the names and status of all loaded instances.

mysql> SHOW INSTANCES;
+---------------+---------+
| instance_name | status  |
+---------------+---------+
| mysqld3       | offline |
| mysqld4       | online  |
| mysqld2       | offline |
+---------------+---------+

Shows status and version information for an instance.

mysql> SHOW INSTANCE STATUS mysqld3;
+---------------+--------+---------+
| instance_name | status | version |
+---------------+--------+---------+
| mysqld3       | online | unknown |
+---------------+--------+---------+

Shows the options used by an instance.

mysql> SHOW INSTANCE OPTIONS mysqld3;
+---------------+---------------------------------------------------+
| option_name   | value                                             |
+---------------+---------------------------------------------------+
| instance_name | mysqld3                                           |
| mysqld-path   | /home/cps/mysql/trees/mysql-4.1/sql/mysqld        |
| port          | 3309                                              |
| socket        | /tmp/mysql.sock3                                  |
| pid-file      | hostname.pid3                                     |
| datadir       | /home/cps/mysql_data/data_dir1/                   |
| language      | /home/cps/mysql/trees/mysql-4.1/sql/share/english |
+---------------+---------------------------------------------------+

The command lists all log files used by the instance. The result set contains the path to the log file and the log file size. If no log file path is specified in the instance section of the configuration file (for example, log=/var/mysql.log), the Instance Manager tries to guess its placement. If Instance Manager is unable to guess the log file placement you should specify the log file location explicitly by using a log option in the appropriate instance section of the configuration file.

mysql> SHOW mysqld LOG FILES;
+-------------+------------------------------------+----------+
| Logfile     | Path                               | Filesize |
+-------------+------------------------------------+----------+
| ERROR LOG   | /home/cps/var/mysql/owlet.err      | 9186     |
| GENERAL LOG | /home/cps/var/mysql/owlet.log      | 471503   |
| SLOW LOG    | /home/cps/var/mysql/owlet-slow.log | 4463     |
+-------------+------------------------------------+----------+

SHOW ... LOG FILES displays information only about log files. If a server instance uses log tables (see Section 5.2.1, “Selecting General Query and Slow Query Log Output Destinations”), no information about those tables is shown.

Log options are described in Section 5.1.3, “Server Command Options”.

This command retrieves a portion of the specified log file. Because most users are interested in the latest log messages, the size parameter defines the number of bytes to retrieve from the end of the log. To retrieve data from the middle of the log file, specify the optional offset_from_end parameter. The following example retrieves 21 bytes of data, starting 23 bytes before the end of the log file and ending 2 bytes before the end:

mysql> SHOW mysqld LOG GENERAL 21, 2;
+---------------------+
| Log                 |
+---------------------+
| using password: YES |
+---------------------+

This command edits the specified instance's configuration section to change or add instance options. The option is added to the section is it is not already present. Otherwise, the new setting replaces the existing one.

mysql> SET mysqld2.port=3322;
Query OK, 0 rows affected (0.00 sec)

As of MySQL 5.1.12, you can specify multiple options (separated by commas), and SET can be used only for offline instances. Each option must indicate the instance name:

mysql> SET mysqld2.port=3322, mysqld3.nonguarded;
Query OK, 0 rows affected (0.00 sec)

Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a FLUSH INSTANCES command is executed.

This command removes an option from an instance's configuration section.

mysql> UNSET mysqld2.port;
Query OK, 0 rows affected (0.00 sec)

As of MySQL 5.1.12, you can specify multiple options (separated by commas), and UNSET can be used only for offline instances. Each option must indicate the instance name:

mysql> UNSET mysqld2.port, mysqld4.nonguarded;
Query OK, 0 rows affected (0.00 sec)

Before MySQL 5.1.12, only a single option can be specified. Also, changes made to the configuration file do not take effect until the MySQL server is restarted. In addition, these changes are not stored in the instance manager's local cache of instance settings until a FLUSH INSTANCES command is executed.

As of MySQL 5.1.12, FLUSH INSTANCES cannot be used unless all instances are offline. The command causes Instance Manager to reread the configuration file, update its in-memory configuration cache, and start any guarded instances.

Before MySQL 5.1.12, this command forces Instance Manager reread the configuration file and to refresh internal structures. This command should be performed after editing the configuration file. The command does not restart instances.

mysql> FLUSH INSTANCES;
Query OK, 0 rows affected (0.04 sec)