Commit 1ac18836 authored by jani@prima.mysql.com's avatar jani@prima.mysql.com

Added documentation about mysql_multi_mysqld.

parent 330a30a8
jani@janikt.pp.saunalahti.fi jani@prima.mysql.com
sasha@mysql.sashanet.com
monty@donna.mysql.com
...@@ -28333,15 +28333,15 @@ edited version that you can reinstall. ...@@ -28333,15 +28333,15 @@ edited version that you can reinstall.
@code{mysql_multi_mysqld} is meant for managing several @code{mysqld} @code{mysql_multi_mysqld} is meant for managing several @code{mysqld}
processes running in different UNIX sockets and TCP/IP ports. processes running in different UNIX sockets and TCP/IP ports.
The program will search for group(s) named [mysqld#] from my.cnf (or The program will search for group(s) named [mysqld#] from my.cnf (or the
the given --config-file=...), where # can be any positive number given --config-file=...), where # can be any positive number starting
starting from 1. These groups should be the same as the usual [mysqld] from 1. These groups should be the same as the usual @code{[mysqld]}
group (e.g. options to mysqld, see MySQL manual for detailed group (e.g. options to mysqld, see @strong{MySQL} manual for detailed
information about this group), but with those port, socket information about this group), but with those port, socket etc. options
etc. options that are wanted for each separate mysqld processes. The that are wanted for each separate @code{mysqld} processes. The number in
number in the group name has another function; it can be used for the group name has another function; it can be used for starting,
starting, stopping, or reporting some specific mysqld servers with stopping, or reporting some specific @code{mysqld} servers with this
this program. See the usage and options below for more information. program. See the usage and options below for more information.
@example @example
Usage: mysql_multi_mysqld [OPTIONS] @{start|stop|report@} [GNR,GNR,GNR...] Usage: mysql_multi_mysqld [OPTIONS] @{start|stop|report@} [GNR,GNR,GNR...]
...@@ -28362,8 +28362,9 @@ list. Anything after a white space are ignored. ...@@ -28362,8 +28362,9 @@ list. Anything after a white space are ignored.
@cindex config-file option @cindex config-file option
@item --config-file=... @item --config-file=...
Alternative config file. NOTE: This will not affect this program's own Alternative config file. NOTE: This will not affect this program's own
options (group [mysql_multi_mysqld]), but only groups [mysqld#]. Without options (group @code{[mysql_multi_mysqld]}), but only groups
this option everything will be searched from the ordinary my.cnf file. [mysqld#]. Without this option everything will be searched from the
ordinary my.cnf file.
@cindex example option @cindex example option
@item --example @item --example
Give an example of a config file. Give an example of a config file.
...@@ -28376,28 +28377,29 @@ Log file. Full path to and the name for the log file. NOTE: If the file ...@@ -28376,28 +28377,29 @@ Log file. Full path to and the name for the log file. NOTE: If the file
exists, everything will be appended. exists, everything will be appended.
@cindex mysqladmin option @cindex mysqladmin option
@item --mysqladmin=... @item --mysqladmin=...
mysqladmin binary to be used for a server shutdown. @code{mysqladmin} binary to be used for a server shutdown.
@cindex mysqld option @cindex mysqld option
@item --mysqld=... @item --mysqld=...
mysqld binary to be used. Note that you can give safe_mysqld to this @code{mysqld} binary to be used. Note that you can give
option also. The options are passed to mysqld. Just make sure you have @code{safe_mysqld} to this option also. The options are passed to
mysqld in your PATH or fix safe_mysqld. @code{mysqld}. Just make sure you have @code{mysqld} in your environment
variable @code{PATH} or fix @code{safe_mysqld}.
@cindex no-log option @cindex no-log option
@item --no-log @item --no-log
Print to stdout instead of the log file. By default the log file is Print to stdout instead of the log file. By default the log file is
turned on. turned on.
@cindex password option @cindex password option
@item --password=... @item --password=...
Password for user for mysqladmin. Password for user for @code{mysqladmin}.
@cindex tcp-ip option @cindex tcp-ip option
@item --tcp-ip @item --tcp-ip
Connect to the MySQL server(s) via the TCP/IP port instead of the UNIX Connect to the @strong{MySQL} server(s) via the TCP/IP port instead of
socket. This affects stopping and reporting. If a socket file is the UNIX socket. This affects stopping and reporting. If a socket file
missing, the server may still be running, but can be accessed only via is missing, the server may still be running, but can be accessed only
the TCP/IP port. By default connecting is done via the UNIX socket. via the TCP/IP port. By default connecting is done via the UNIX socket.
@cindex user option @cindex user option
@item --user=... @item --user=...
MySQL user for mysqladmin. @strong{MySQL} user for @code{mysqladmin}.
@cindex version option @cindex version option
@item --version @item --version
Print the version number and exit. Print the version number and exit.
...@@ -28430,8 +28432,10 @@ should have it's own @code{pid-file}. The advantage using ...@@ -28430,8 +28432,10 @@ should have it's own @code{pid-file}. The advantage using
it, if a @code{mysqld} process fails due to signal kill -9, or it, if a @code{mysqld} process fails due to signal kill -9, or
similar. (Like segmentation fault, which @strong{MySQL} should never do, similar. (Like segmentation fault, which @strong{MySQL} should never do,
of course ;) Please note that @code{safe_mysqld} script may require that of course ;) Please note that @code{safe_mysqld} script may require that
you start it from a certain place. If you have problems starting, please you start it from a certain place. This means that you may have to CD to
see the script. Check especially the lines: a certain directory, before you start the @code{mysql_multi_mysqld}. If
you have problems starting, please see the @code{safe_mysqld}
script. Check especially the lines:
@example @example
-------------------------------------------------------------------------- --------------------------------------------------------------------------
MY_PWD=`pwd` Check if we are starting this relative (for the binary MY_PWD=`pwd` Check if we are starting this relative (for the binary
...@@ -28452,18 +28456,19 @@ the example. You may have 'gaps' in the config file. This gives you ...@@ -28452,18 +28456,19 @@ the example. You may have 'gaps' in the config file. This gives you
more flexibility. The order in which the @code{mysqlds} are started or more flexibility. The order in which the @code{mysqlds} are started or
stopped depends on the order in which they appear in the config file. stopped depends on the order in which they appear in the config file.
@item @item
When you want to refer to a certain group with GNR with this program, When you want to refer to a certain group using GNR with this program,
just use the number in the end of the group name ( [mysqld# <== ) just use the number in the end of the group name ( [mysqld# <== ).
@item @item
You may want to use option '--user' for @code{mysqld}, but in order to You may want to use option '--user' for @code{mysqld}, but in order to
do this you need to be root when you start this script. Having the do this you need to be root when you start the @code{mysql_multi_mysqld}
option in the config file doesn't matter; you will just get a warning, script. Having the option in the config file doesn't matter; you will
if you are no the superuser and the @code{mysqlds} are started under just get a warning, if you are not the superuser and the @code{mysqlds}
@strong{YOUR} UNIX account. @strong{IMPORTANT}: Make sure that the are started under @strong{YOUR} UNIX account. @strong{IMPORTANT}: Make
@code{pid-file} and the data directory is read+write(+execute for the sure that the @code{pid-file} and the data directory are
latter one) accessible for @strong{THAT} UNIX user, who the specific read+write(+execute for the latter one) accessible for @strong{THAT}
@code{mysqld} process is started as. @strong{DON'T} use the UNIX root UNIX user, who the specific @code{mysqld} process is started
account for this, unless you @strong{KNOW} what you are doing! as. @strong{DON'T} use the UNIX root account for this, unless you
@strong{KNOW} what you are doing!
@item @item
@strong{MOST IMPORTANT}: Make sure that you understand the meanings of @strong{MOST IMPORTANT}: Make sure that you understand the meanings of
the options that are passed to the @code{mysqlds} and why @strong{WOULD the options that are passed to the @code{mysqlds} and why @strong{WOULD
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment