~ubuntu-branches/ubuntu/maverick/mysql-5.1/maverick-proposed

« back to all changes in this revision

Viewing changes to man/mysqlmanager.8

  • Committer: Package Import Robot
  • Author(s): Marc Deslauriers
  • Date: 2012-02-22 14:16:05 UTC
  • mto: This revision was merged to the branch mainline in revision 20.
  • Revision ID: package-import@ubuntu.com-20120222141605-nxlu9yzc6attylc2
Tags: upstream-5.1.61
ImportĀ upstreamĀ versionĀ 5.1.61

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
.\"     Title: \fBmysqlmanager\fR
3
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
 
.\"      Date: 07/06/2010
 
5
.\"      Date: 12/16/2011
6
6
.\"    Manual: MySQL Database System
7
7
.\"    Source: MySQL 5.1
8
8
.\"  Language: English
9
9
.\"
10
 
.TH "\FBMYSQLMANAGER\FR" "8" "07/06/2010" "MySQL 5\&.1" "MySQL Database System"
 
10
.TH "\FBMYSQLMANAGER\FR" "8" "12/16/2011" "MySQL 5\&.1" "MySQL Database System"
11
11
.\" -----------------------------------------------------------------
12
12
.\" * set default formatting
13
13
.\" -----------------------------------------------------------------
47
47
is the MySQL Instance Manager (IM)\&. This program monitors and manages MySQL Database Server instances\&. MySQL Instance Manager is available for Unix\-like operating systems, as well as Windows\&. It runs as a daemon that listens on a TCP/IP port\&. On Unix, it also listens on a Unix socket file\&.
48
48
.PP
49
49
MySQL Instance Manager can be used in place of the
50
 
mysqld_safe
 
50
\fBmysqld_safe\fR
51
51
script to start and stop one or more instances of MySQL Server\&. Because Instance Manager can manage multiple server instances, it can also be used in place of the
52
52
\fBmysqld_multi\fR
53
53
script\&. Instance Manager offers these capabilities:
438
438
.sp
439
439
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
440
440
MySQL_Instance_Manager
441
 
user account to check whether it is alive/not hanging\&. If the result of the connection attempt indicates that the instance is unavailable, Instance Manager performs several attempts to restart the instance\&.
 
441
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\&.
442
442
.sp
443
443
Normally, the
444
444
MySQL_Instance_Manager
981
981
.PP
982
982
Instance Manager also stops all guarded server instances when it shuts down\&.
983
983
.PP
984
 
The allowable options for
 
984
The permissible options for
985
985
[mysqld\fIN\fR]
986
986
server instance sections are described in
987
987
the section called \(lqMYSQL INSTANCE MANAGER CONFIGURATION FILES\(rq\&. In these sections, you can use a special
992
992
\fBdatadir\fR
993
993
and
994
994
\fBport\fR, to ensure that each instance has a different data directory and TCP/IP port number\&.
995
 
Section\ \&5.6, \(lqRunning Multiple MySQL Servers on the Same Machine\(rq, discusses the configuration values that must differ for each instance when you run multiple instance on the same machine\&.
 
995
Section\ \&5.6, \(lqRunning Multiple MySQL Instances on One Machine\(rq, discusses the configuration values that must differ for each instance when you run multiple instance on the same machine\&.
996
996
.if n \{\
997
997
.sp
998
998
.\}
1241
1241
.PP
1242
1242
\fB\-\-print\-password\-line\fR
1243
1243
causes Instance Manager to send the resulting account entry to its output, which you can append to the password file\&. The following list describes other account\-management options that cause Instance Manager to operate directly on the password file\&. (These options make Instance Manager scriptable for account\-management purposes\&.) For operations on the password file to succeed, the file must exist and it must be accessible by Instance Manager\&. (The exception is
1244
 
\fB\-\-clean\-password\-file\fR, which creates the file if it does not exist\&. Alternatively, if there is no password file, manually create it as an empty file and ensure that its ownership and access modes allow it to be read and written by Instance Manager\&.) The default password file is used unless you specify a
 
1244
\fB\-\-clean\-password\-file\fR, which creates the file if it does not exist\&. Alternatively, if there is no password file, manually create it as an empty file and ensure that its ownership and access modes permit it to be read and written by Instance Manager\&.) The default password file is used unless you specify a
1245
1245
\fB\-\-password\-file\fR
1246
1246
option\&.
1247
1247
.PP
1430
1430
.PP
1431
1431
Instance Manager knows if a server instance fails at startup because it receives a status from the attempt\&. For an instance that starts but later crashes, Instance Manager receives a signal because it is the parent process of the instance\&.
1432
1432
.PP
1433
 
Beginning with MySQL 5\&.1\&.12, Instance Manager tracks instance states so that it can determine which commands are allowed for each instance\&. For example, commands that modify an instance\'s configuration are allowed only while the instance is offline\&.
 
1433
Beginning with MySQL 5\&.1\&.12, Instance Manager tracks instance states so that it can determine which commands are permitted for each instance\&. For example, commands that modify an instance\'s configuration are permitted only while the instance is offline\&.
1434
1434
.PP
1435
1435
Each instance is in one of the states described in the following table\&. Guarded instances can be in any of the states\&. Nonguarded instances can only be offline or online\&. Instance state information is displayed in the
1436
1436
status
1441
1441
commands\&.
1442
1442
.TS
1443
1443
allbox tab(:);
1444
 
l l
 
1444
lB lB.
 
1445
T{
 
1446
State
 
1447
T}:T{
 
1448
Meaning
 
1449
T}
 
1450
.T&
1445
1451
l l
1446
1452
l l
1447
1453
l l
1450
1456
l l
1451
1457
l l.
1452
1458
T{
1453
 
\fBState\fR
1454
 
T}:T{
1455
 
\fBMeaning\fR
1456
 
T}
1457
 
T{
1458
1459
offline
1459
1460
T}:T{
1460
1461
The instance has not been started and is not running\&.
1529
1530
.sp .5v
1530
1531
.RE
1531
1532
.PP
1532
 
After you set up a password file for the MySQL Instance Manager and Instance Manager is running, you can connect to it\&. The MySQL client\-server protocol is used to communicate with the Instance Manager\&. For example, you can connect to it using the standard
 
1533
After you set up a password file for the MySQL Instance Manager and Instance Manager is running, you can connect to it\&. The MySQL client/server protocol is used to communicate with the Instance Manager\&. For example, you can connect to it using the standard
1533
1534
\fBmysql\fR
1534
1535
client program:
1535
1536
.sp
1543
1544
.RE
1544
1545
.\}
1545
1546
.PP
1546
 
Instance Manager supports the version of the MySQL client\-server protocol used by the client tools and libraries distributed with MySQL 4\&.1 or later, so other programs that use the MySQL C API also can connect to it\&.
 
1547
Instance Manager supports the version of the MySQL client/server protocol used by the client tools and libraries distributed with MySQL 4\&.1 or later, so other programs that use the MySQL C API also can connect to it\&.
1547
1548
.SH "MYSQL INSTANCE MANAGER COMMANDS"
1548
1549
.if n \{\
1549
1550
.sp
1662
1663
.sp
1663
1664
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
1664
1665
Section\ \&4.2.3.3, \(lqUsing Option Files\(rq
1665
 
for a description of the allowable syntax\&.) If you specify multiple options, separate them by commas\&.
 
1666
for a description of the permissible syntax\&.) If you specify multiple options, separate them by commas\&.
1666
1667
.sp
1667
1668
For example, to create an instance section named
1668
1669
[mysqld98], you might write something like this were you to modify the configuration file directly:
1678
1679
.RE
1679
1680
.\}
1680
1681
.sp
1681
 
To achieve the same effect via
 
1682
To achieve the same effect using
1682
1683
CREATE INSTANCE, issue this command to Instance Manager:
1683
1684
.sp
1684
1685
.if n \{\
2062
2063
.SH "COPYRIGHT"
2063
2064
.br
2064
2065
.PP
2065
 
Copyright \(co 1997, 2010, Oracle and/or its affiliates. All rights reserved.
 
2066
Copyright \(co 1997, 2011, Oracle and/or its affiliates. All rights reserved.
2066
2067
.PP
2067
2068
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.
2068
2069
.PP