~mathiaz/ubuntu/lucid/mysql-dfsg-5.1/zap-bug-552053

'\" t

.\"     Title: \fBndbd\fR

.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]

.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>

.\"      Date: 11/04/2009

.\"    Manual: MySQL Database System

.\"    Source: MySQL 5.1

.\"  Language: English

.\"

.TH "\FBNDBD\FR" "8" "11/04/2009" "MySQL 5\&.1" "MySQL Database System"

.\" -----------------------------------------------------------------

.\" * set default formatting

.\" -----------------------------------------------------------------

.\" disable hyphenation

.nh

.\" disable justification (adjust text to left margin only)

.ad l

.\" -----------------------------------------------------------------

.\" * MAIN CONTENT STARTS HERE *

.\" -----------------------------------------------------------------

.\" ndbd

.\" MySQL Cluster: ndbd

.\" MySQL Cluster: data nodes

.\" data nodes (MySQL Cluster)

.\" storage nodes - see data nodes, ndbd

.SH "NAME"

ndbd \- the MySQL Cluster data node daemon

.SH "SYNOPSIS"

.HP \w'\fBndbd\ \fR\fB\fIoptions\fR\fR\ 'u

\fBndbd \fR\fB\fIoptions\fR\fR

.SH "DESCRIPTION"

.PP

\fBndbd\fR

is the process that is used to handle all the data in tables using the NDB Cluster storage engine\&. This is the process that empowers a data node to accomplish distributed transaction handling, node recovery, checkpointing to disk, online backup, and related tasks\&.

.PP

In a MySQL Cluster, a set of

\fBndbd\fR

processes cooperate in handling data\&. These processes can execute on the same computer (host) or on different computers\&. The correspondences between data nodes and Cluster hosts is completely configurable\&.

.\" MySQL Cluster: administration

.\" MySQL Cluster: commands

.\" command options (MySQL Cluster): ndbd

.\" MySQL Cluster: ndbd process

.PP

The following table includes command options specific to the MySQL Cluster data node program

\fBndbd\fR\&. Additional descriptions follow the table\&. For options common to all MySQL Cluster programs, see

Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(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

.PP

All of these options also apply to the multi\-threaded version of this program \(em

\fBndbmtd\fR, which is available in MySQL Cluster NDB 7\&.0 \(em and you may substitute

\(lq\fBndbmtd\fR\(rq

for

\(lq\fBndbd\fR\(rq

wherever the latter occurs in this section\&.

.sp .5v

.RE

.PP

For options common to all

NDBCLUSTER

programs, see

Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

\fB\-\-bind\-address\fR

.TS

allbox tab(:);

l l s

l l s

l l s

^ l l

^ l l.

T{

\fBVersion Introduced\fR

T}:T{

5\&.1\&.12

T}

T{

\fBCommand Line Format\fR

T}:T{

\-\-bind\-address=name

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

string

T}

:T{

\fBDefault\fR

T}:T{

T}

.TE

.sp 1

Causes

\fBndbd\fR

to bind to a specific network interface (host name or IP address)\&. This option has no default value\&.

.sp

This option was added in MySQL 5\&.1\&.12\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

\fB\-\-daemon\fR,

\fB\-d\fR

.TS

allbox tab(:);

l l s

l l s

^ l l

^ l l.

T{

\fBCommand Line Format\fR

T}:T{

\-\-daemon

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

boolean

T}

:T{

\fBDefault\fR

T}:T{

TRUE

T}

.TE

.sp 1

Instructs

\fBndbd\fR

to execute as a daemon process\&. This is the default behavior\&.

\fB\-\-nodaemon\fR

can be used to prevent the process from running as a daemon\&.

.sp

This option has no effect when running

\fBndbd\fR

or

\fBndbmtd\fR

on Windows platforms\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --initial option (ndbd)

.\" --initial option (ndbmtd)

\fB\-\-initial\fR

.TS

allbox tab(:);

l l s

l l s

^ l l

^ l l.

T{

\fBCommand Line Format\fR

T}:T{

\-\-initial

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

boolean

T}

:T{

\fBDefault\fR

T}:T{

FALSE

T}

.TE

.sp 1

Instructs

\fBndbd\fR

to perform an initial start\&. An initial start erases any files created for recovery purposes by earlier instances of

\fBndbd\fR\&. It also re\-creates recovery log files\&. Note that on some operating systems this process can take a substantial amount of time\&.

.sp

An

\fB\-\-initial\fR

start is to be used

\fIonly\fR

when starting the

\fBndbd\fR

process under very special circumstances; this is because this option causes all files to be removed from the Cluster file system and all redo log files to be re\-created\&. These circumstances are listed here:

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

When performing a software upgrade which has changed the contents of any files\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

When restarting the node with a new version of

\fBndbd\fR\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

As a measure of last resort when for some reason the node restart or system restart repeatedly fails\&. In this case, be aware that this node can no longer be used to restore data due to the destruction of the data files\&.

.RE

.RS 4

Use of this option prevents the

StartPartialTimeout

and

StartPartitionedTimeout

configuration parameters from having any effect\&.

.if n \{\

.sp

.\}

.RS 4

.it 1 an-trap

.nr an-no-space-flag 1

.nr an-break-flag 1

.br

.ps +1

\fBImportant\fR

.ps -1

.br

This option does

\fInot\fR

affect either of the following:

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

Backup files that have already been created by the affected node

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

MySQL Cluster Disk Data files (see

Section\ \&17.5.9, \(lqMySQL Cluster Disk Data Tables\(rq)\&.

.RE

.RS 4

.sp

This option also has no effect on recovery of data by a data node that is just starting (or restarting) from data nodes that are already running\&. This recovery of data occurs automatically, and requires no user intervention in a MySQL Cluster that is running normally\&.

.sp .5v

.RE

It is permissible to use this option when starting the cluster for the very first time (that is, before any data node files have been created); however, it is

\fInot\fR

necessary to do so\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --initial-start option (ndbd)

.\" --initial-start option (ndbmtd)

\fB\-\-initial\-start\fR

.TS

allbox tab(:);

l l s

l l s

l l s

^ l l

^ l l.

T{

\fBVersion Introduced\fR

T}:T{

5\&.1\&.11

T}

T{

\fBCommand Line Format\fR

T}:T{

\-\-initial\-start

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

boolean

T}

:T{

\fBDefault\fR

T}:T{

FALSE

T}

.TE

.sp 1

This option is used when performing a partial initial start of the cluster\&. Each node should be started with this option, as well as

\fB\-\-nowait\-nodes\fR\&.

.sp

For example, suppose you have a 4\-node cluster whose data nodes have the IDs 2, 3, 4, and 5, and you wish to perform a partial initial start using only nodes 2, 4, and 5 \(em that is, omitting node 3:

.sp

.if n \{\

.RS 4

.\}

.nf

ndbd \-\-ndbd\-nodeid=2 \-\-nowait\-nodes=3 \-\-initial\-start

ndbd \-\-ndbd\-nodeid=4 \-\-nowait\-nodes=3 \-\-initial\-start

ndbd \-\-ndbd\-nodeid=5 \-\-nowait\-nodes=3 \-\-initial\-start

.fi

.if n \{\

.RE

.\}

.sp

This option was added in MySQL 5\&.1\&.11\&.

.if n \{\

.sp

.\}

.RS 4

.it 1 an-trap

.nr an-no-space-flag 1

.nr an-break-flag 1

.br

.ps +1

\fBImportant\fR

.ps -1

.br

Prior to MySQL 5\&.1\&.19, it was not possible to perform DDL operations involving Disk Data tables on a partially started cluster\&. (See

\m[blue]\fBBug#24631\fR\m[]\&\s-2\u[1]\d\s+2\&.)

.sp .5v

.RE

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --nowait-nodes option (ndbd)

.\" --nowait-nodes option (ndbmtd)

\fB\-\-nowait\-nodes=\fR\fB\fInode_id_1\fR\fR\fB[, \fR\fB\fInode_id_2\fR\fR\fB[, \&.\&.\&.]]\fR

.TS

allbox tab(:);

l l s

l l s

l l s

^ l l

^ l l.

T{

\fBVersion Introduced\fR

T}:T{

5\&.1\&.11

T}

T{

\fBCommand Line Format\fR

T}:T{

\-\-nowait\-nodes=list

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

string

T}

:T{

\fBDefault\fR

T}:T{

T}

.TE

.sp 1

This option takes a list of data nodes which for which the cluster will not wait for before starting\&.

.sp

This can be used to start the cluster in a partitioned state\&. For example, to start the cluster with only half of the data nodes (nodes 2, 3, 4, and 5) running in a 4\-node cluster, you can start each

\fBndbd\fR

process with

\fB\-\-nowait\-nodes=3,5\fR\&. In this case, the cluster starts as soon as nodes 2 and 4 connect, and does

\fInot\fR

wait

StartPartitionedTimeout

milliseconds for nodes 3 and 5 to connect as it would otherwise\&.

.sp

If you wanted to start up the same cluster as in the previous example without one

\fBndbd\fR

\(em say, for example, that the host machine for node 3 has suffered a hardware failure \(em then start nodes 2, 4, and 5 with

\fB\-\-nowait\-nodes=3\fR\&. Then the cluster will start as soon as nodes 2, 4, and 5 connect and will not wait for node 3 to start\&.

.sp

This option was added in MySQL 5\&.1\&.9\&.

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --nodaemon option (ndbd)

.\" --nodaemon option (ndbmtd)

\fB\-\-nodaemon\fR

.TS

allbox tab(:);

l l s

l l s

^ l l

^ l l.

T{

\fBCommand Line Format\fR

T}:T{

\-\-nodaemon

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

boolean

T}

:T{

\fBDefault\fR

T}:T{

FALSE

T}

.TE

.sp 1

Instructs

\fBndbd\fR

not to start as a daemon process\&. This is useful when

\fBndbd\fR

is being debugged and you want output to be redirected to the screen\&.

.sp

As of MySQL Cluster NDB 7\&.0\&.8, the default behavior for

\fBndbd\fR

and

\fBndbmtd\fR

on Windows is to run in the foreground, making this option unnecessary on Windows platforms\&. (\m[blue]\fBBug#45588\fR\m[]\&\s-2\u[2]\d\s+2)

.RE

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" --nostart option (ndbd)

.\" -n option (ndbd)

.\" --nostart option (ndbmtd)

.\" -n option (ndbmtd)

\fB\-\-nostart\fR,

\fB\-n\fR

.TS

allbox tab(:);

l l s

l l s

^ l l

^ l l.

T{

\fBCommand Line Format\fR

T}:T{

\-\-nostart

T}

T{

\ \&

T}:T{

\fBPermitted Values \fR

T}

:T{

\fBType\fR

T}:T{

boolean

T}

:T{

\fBDefault\fR

T}:T{

FALSE

T}

.TE

.sp 1

Instructs

\fBndbd\fR

not to start automatically\&. When this option is used,

\fBndbd\fR

connects to the management server, obtains configuration data from it, and initializes communication objects\&. However, it does not actually start the execution engine until specifically requested to do so by the management server\&. This can be accomplished by issuing the proper

START

command in the management client (see

Section\ \&17.5.2, \(lqCommands in the MySQL Cluster Management Client\(rq)\&.

.RE

.\" MySQL Cluster: log files

.\" log files (MySQL Cluster)

.PP

\fBndbd\fR

generates a set of log files which are placed in the directory specified by

DataDir

in the

config\&.ini

configuration file\&.

.PP

These log files are listed below\&.

\fInode_id\fR

is the node\'s unique identifier\&. Note that

\fInode_id\fR

represents the node\'s unique identifier\&. For example,

ndb_2_error\&.log

is the error log generated by the data node whose node ID is

2\&.

.sp

.RS 4

.ie n \{\

\h'-04'\(bu\h'+03'\c

.\}

.el \{\

.sp -1

.IP \(bu 2.3

.\}

.\" MySQL Cluster: error logs

.\" error logs (MySQL Cluster)

ndb_\fInode_id\fR_error\&.log

is a file containing records of all crashes which the referenced

\fBndbd\fR