← Back to branch summary

~ubuntu-branches/ubuntu/precise/mysql-5.1/precise

« back to all changes in this revision

Viewing changes to man/ndb_waiter.1

  • Committer: Bazaar Package Importer
  • Author(s): Norbert Tretkowski
  • Date: 2010-03-17 14:56:02 UTC
  • Revision ID: james.westby@ubuntu.com-20100317145602-x7e30l1b2sb5s6w6
Tags: upstream-5.1.45
Import upstream version 5.1.45

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/ndb_waiter.1
 
1
'\" t
 
2
.\"     Title: \fBndb_waiter\fR
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 03/01/2010
 
6
.\"    Manual: MySQL Database System
 
7
.\"    Source: MySQL 5.1
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "\FBNDB_WAITER\FR" "1" "03/01/2010" "MySQL 5\&.1" "MySQL Database System"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.\" ndb_waiter
 
22
.SH "NAME"
 
23
ndb_waiter \- wait for MySQL Cluster to reach a given status
 
24
.SH "SYNOPSIS"
 
25
.HP \w'\fBndb_waiter\ \fR\fB\fIoptions\fR\fR\ 'u
 
26
\fBndb_waiter \fR\fB\fIoptions\fR\fR
 
27
.SH "DESCRIPTION"
 
28
.PP
 
29
\fBndb_waiter\fR
 
30
repeatedly (each 100 milliseconds) prints out the status of all cluster data nodes until either the cluster reaches a given status or the
 
31
\fB\-\-timeout\fR
 
32
limit is exceeded, then exits\&. By default, it waits for the cluster to achieve
 
33
STARTED
 
34
status, in which all nodes have started and connected to the cluster\&. This can be overridden using the
 
35
\fB\-\-no\-contact\fR
 
36
and
 
37
\fB\-\-not\-started\fR
 
38
options (see
 
39
Additional Options)\&.
 
40
.PP
 
41
The node states reported by this utility are as follows:
 
42
.sp
 
43
.RS 4
 
44
.ie n \{\
 
45
\h'-04'\(bu\h'+03'\c
 
46
.\}
 
47
.el \{\
 
48
.sp -1
 
49
.IP \(bu 2.3
 
50
.\}
 
51
NO_CONTACT: The node cannot be contacted\&.
 
52
.RE
 
53
.sp
 
54
.RS 4
 
55
.ie n \{\
 
56
\h'-04'\(bu\h'+03'\c
 
57
.\}
 
58
.el \{\
 
59
.sp -1
 
60
.IP \(bu 2.3
 
61
.\}
 
62
UNKNOWN: The node can be contacted, but its status is not yet known\&. Usually, this means that the node has received a
 
63
START
 
64
or
 
65
RESTART
 
66
command from the management server, but has not yet acted on it\&.
 
67
.RE
 
68
.sp
 
69
.RS 4
 
70
.ie n \{\
 
71
\h'-04'\(bu\h'+03'\c
 
72
.\}
 
73
.el \{\
 
74
.sp -1
 
75
.IP \(bu 2.3
 
76
.\}
 
77
NOT_STARTED: The node has stopped, but remains in contact with the cluster\&. This is seen when restarting the node using the management client\'s
 
78
RESTART
 
79
command\&.
 
80
.RE
 
81
.sp
 
82
.RS 4
 
83
.ie n \{\
 
84
\h'-04'\(bu\h'+03'\c
 
85
.\}
 
86
.el \{\
 
87
.sp -1
 
88
.IP \(bu 2.3
 
89
.\}
 
90
STARTING: The node\'s
 
91
\fBndbd\fR
 
92
process has started, but the node has not yet joined the cluster\&.
 
93
.RE
 
94
.sp
 
95
.RS 4
 
96
.ie n \{\
 
97
\h'-04'\(bu\h'+03'\c
 
98
.\}
 
99
.el \{\
 
100
.sp -1
 
101
.IP \(bu 2.3
 
102
.\}
 
103
STARTED: The node is operational, and has joined the cluster\&.
 
104
.RE
 
105
.sp
 
106
.RS 4
 
107
.ie n \{\
 
108
\h'-04'\(bu\h'+03'\c
 
109
.\}
 
110
.el \{\
 
111
.sp -1
 
112
.IP \(bu 2.3
 
113
.\}
 
114
SHUTTING_DOWN: The node is shutting down\&.
 
115
.RE
 
116
.sp
 
117
.RS 4
 
118
.ie n \{\
 
119
\h'-04'\(bu\h'+03'\c
 
120
.\}
 
121
.el \{\
 
122
.sp -1
 
123
.IP \(bu 2.3
 
124
.\}
 
125
SINGLE USER MODE: This is shown for all cluster data nodes when the cluster is in single user mode\&.
 
126
.RE
 
127
.PP
 
128
\fBUsage\fR:
 
129
.sp
 
130
.if n \{\
 
131
.RS 4
 
132
.\}
 
133
.nf
 
134
ndb_waiter [\-c \fIconnect_string\fR]
 
135
.fi
 
136
.if n \{\
 
137
.RE
 
138
.\}
 
139
.PP
 
140
\fBAdditional Options\fR:
 
141
.sp
 
142
.RS 4
 
143
.ie n \{\
 
144
\h'-04'\(bu\h'+03'\c
 
145
.\}
 
146
.el \{\
 
147
.sp -1
 
148
.IP \(bu 2.3
 
149
.\}
 
150
.\" ndb_waiter: no-contact option
 
151
.\" no-contact option: ndb_waiter
 
152
\fB\-\-no\-contact\fR,
 
153
\fB\-n\fR
 
154
.sp
 
155
Instead of waiting for the
 
156
STARTED
 
157
state,
 
158
\fBndb_waiter\fR
 
159
continues running until the cluster reaches
 
160
NO_CONTACT
 
161
status before exiting\&.
 
162
.RE
 
163
.sp
 
164
.RS 4
 
165
.ie n \{\
 
166
\h'-04'\(bu\h'+03'\c
 
167
.\}
 
168
.el \{\
 
169
.sp -1
 
170
.IP \(bu 2.3
 
171
.\}
 
172
.\" ndb_waiter: not-started option
 
173
.\" not-started option: ndb_waiter
 
174
\fB\-\-not\-started\fR
 
175
.sp
 
176
Instead of waiting for the
 
177
STARTED
 
178
state,
 
179
\fBndb_waiter\fR
 
180
continues running until the cluster reaches
 
181
NOT_STARTED
 
182
status before exiting\&.
 
183
.RE
 
184
.sp
 
185
.RS 4
 
186
.ie n \{\
 
187
\h'-04'\(bu\h'+03'\c
 
188
.\}
 
189
.el \{\
 
190
.sp -1
 
191
.IP \(bu 2.3
 
192
.\}
 
193
.\" ndb_waiter: timeout option
 
194
.\" timeout option: ndb_waiter
 
195
\fB\-\-timeout=\fR\fB\fIseconds\fR\fR,
 
196
\fB\-t \fR\fB\fIseconds\fR\fR
 
197
.sp
 
198
Time to wait\&. The program exits if the desired state is not achieved within this number of seconds\&. The default is 120 seconds (1200 reporting cycles)\&.
 
199
.RE
 
200
.PP
 
201
\fBSample Output\fR. Shown here is the output from
 
202
\fBndb_waiter\fR
 
203
when run against a 4\-node cluster in which two nodes have been shut down and then started again manually\&. Duplicate reports (indicated by
 
204
\(lq\&.\&.\&.\(rq) are omitted\&.
 
205
.sp
 
206
.if n \{\
 
207
.RS 4
 
208
.\}
 
209
.nf
 
210
shell> \fB\&./ndb_waiter \-c localhost\fR
 
211
Connecting to mgmsrv at (localhost)
 
212
State node 1 STARTED
 
213
State node 2 NO_CONTACT
 
214
State node 3 STARTED
 
215
State node 4 NO_CONTACT
 
216
Waiting for cluster enter state STARTED
 
217
\&.\&.\&.
 
218
State node 1 STARTED
 
219
State node 2 UNKNOWN
 
220
State node 3 STARTED
 
221
State node 4 NO_CONTACT
 
222
Waiting for cluster enter state STARTED
 
223
\&.\&.\&.
 
224
State node 1 STARTED
 
225
State node 2 STARTING
 
226
State node 3 STARTED
 
227
State node 4 NO_CONTACT
 
228
Waiting for cluster enter state STARTED
 
229
\&.\&.\&.
 
230
State node 1 STARTED
 
231
State node 2 STARTING
 
232
State node 3 STARTED
 
233
State node 4 UNKNOWN
 
234
Waiting for cluster enter state STARTED
 
235
\&.\&.\&.
 
236
State node 1 STARTED
 
237
State node 2 STARTING
 
238
State node 3 STARTED
 
239
State node 4 STARTING
 
240
Waiting for cluster enter state STARTED
 
241
\&.\&.\&.
 
242
State node 1 STARTED
 
243
State node 2 STARTED
 
244
State node 3 STARTED
 
245
State node 4 STARTING
 
246
Waiting for cluster enter state STARTED
 
247
\&.\&.\&.
 
248
State node 1 STARTED
 
249
State node 2 STARTED
 
250
State node 3 STARTED
 
251
State node 4 STARTED
 
252
Waiting for cluster enter state STARTED
 
253
NDBT_ProgramExit: 0 \- OK
 
254
.fi
 
255
.if n \{\
 
256
.RE
 
257
.\}
 
258
.if n \{\
 
259
.sp
 
260
.\}
 
261
.RS 4
 
262
.it 1 an-trap
 
263
.nr an-no-space-flag 1
 
264
.nr an-break-flag 1
 
265
.br
 
266
.ps +1
 
267
\fBNote\fR
 
268
.ps -1
 
269
.br
 
270
.PP
 
271
If no connectstring is specified, then
 
272
\fBndb_waiter\fR
 
273
tries to connect to a management on
 
274
localhost, and reports
 
275
Connecting to mgmsrv at (null)\&.
 
276
.sp .5v
 
277
.RE
 
278
.SH "COPYRIGHT"
 
279
.br
 
280
.PP
 
281
Copyright 2007-2008 MySQL AB, 2008-2010 Sun Microsystems, Inc.
 
282
.PP
 
283
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.
 
284
.PP
 
285
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.
 
286
.PP
 
287
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/.
 
288
.sp
 
289
.SH "SEE ALSO"
 
290
For more information, please refer to the MySQL Reference Manual,
 
291
which may already be installed locally and which is also available
 
292
online at http://dev.mysql.com/doc/.
 
293
.SH AUTHOR
 
294
Sun Microsystems, Inc. (http://www.mysql.com/).