~ubuntu-branches/ubuntu/wily/mysql-5.6/wily

'\" t
.\"     Title: \fBndb_mgm\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 05/05/2015
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.6
.\"  Language: English
.\"
.TH "\FBNDB_MGM\FR" "1" "05/05/2015" "MySQL 5\&.6" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" ndb_mgm
.\" MySQL Cluster: ndb_mgm
.\" MySQL Cluster: management client (ndb_mgm)
.\" management client (MySQL Cluster)
.\" ndb_mgm
.\" MySQL Cluster: administration
.\" administration of MySQL Cluster
.SH "NAME"
ndb_mgm \- the MySQL Cluster management client
.SH "SYNOPSIS"
.HP \w'\fBndb_mgm\ \fR\fB\fIoptions\fR\fR\ 'u
\fBndb_mgm \fR\fB\fIoptions\fR\fR
.SH "DESCRIPTION"
.PP
The
\fBndb_mgm\fR
management client process is actually not needed to run the cluster\&. Its value lies in providing a set of commands for checking the cluster\*(Aqs status, starting backups, and performing other administrative functions\&. The management client accesses the management server using a C API\&. Advanced users can also employ this API for programming dedicated management processes to perform tasks similar to those performed by
\fBndb_mgm\fR\&.
.PP
To start the management client, it is necessary to supply the host name and port number of the management server:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBndb_mgm [\fR\fB\fIhost_name\fR\fR\fB [\fR\fB\fIport_num\fR\fR\fB]]\fR
.fi
.if n \{\
.RE
.\}
.PP
For example:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBndb_mgm ndb_mgmd\&.mysql\&.com 1186\fR
.fi
.if n \{\
.RE
.\}
.PP
The default host name and port number are
localhost
and 1186, respectively\&.
.\" MySQL Cluster: administration
.\" MySQL Cluster: commands
.\" command options (MySQL Cluster): ndb_mgm
.\" MySQL Cluster: mgm process
.PP
The following table includes options that are specific to the MySQL Cluster management client program
\fBndb_mgm\fR\&. Additional descriptions follow the table\&. For options common to most MySQL Cluster programs (including
\fBndb_mgm\fR), see
Options Common to MySQL Cluster Programs(1)\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&18.81.\ \& This table describes command-line options for the ndb_mgm program
.TS
allbox tab(:);
lB lB lB.
T{
Format
T}:T{
Description
T}:T{
Added or Removed
T}
.T&
l l l
l l l.
T{
.PP
--try-reconnect=#,
.PP
-t
T}:T{
Specify number of tries for connecting to ndb_mgmd (0 = infinite)
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--execute=name,
.PP
-e
T}:T{
Execute command and exit
T}:T{
.PP
All MySQL 5.6 based releases
T}
.TE
.sp 1
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" execute option (ndb_mgm)
.\" -e option (ndb_mgm)
\fB\-\-execute=\fR\fBcommand\fR,
\fB\-e \fR\fBcommand\fR
.TS
allbox tab(:);
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-execute=name
T}
.TE
.sp 1
This option can be used to send a command to the MySQL Cluster management client from the system shell\&. For example, either of the following is equivalent to executing
SHOW
in the management client:
.sp
.if n \{\
.RS 4
.\}
.nf
shell> \fBndb_mgm \-e "SHOW"\fR
shell> \fBndb_mgm \-\-execute="SHOW"\fR
.fi
.if n \{\
.RE
.\}
.sp
This is analogous to how the
\fB\-\-execute\fR
or
\fB\-e\fR
option works with the
\fBmysql\fR
command\-line client\&. See
Section\ \&4.2.4, \(lqUsing Options on the Command Line\(rq\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If the management client command to be passed using this option contains any space characters, then the command
\fImust\fR
be enclosed in quotation marks\&. Either single or double quotation marks may be used\&. If the management client command contains no space characters, the quotation marks are optional\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-try\-reconnect=\fR\fB\fInumber\fR\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-try\-reconnect=#
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
boolean
T}
:T{
\fBDefault\fR
T}:T{
TRUE
T}
.TE
.sp 1
If the connection to the management server is broken, the node tries to reconnect to it every 5 seconds until it succeeds\&. By using this option, it is possible to limit the number of attempts to
\fInumber\fR
before giving up and reporting an error instead\&.
.RE
.PP
Additional information about using
\fBndb_mgm\fR
can be found in
Section\ \&18.5.2, \(lqCommands in the MySQL Cluster Management Client\(rq\&.
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2015, Oracle and/or its affiliates. All rights reserved.
.PP
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.
.PP
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.
.PP
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/.
.sp
.SH "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/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).