| blob | 7632d1e2add75d7cc3c6ae83530308f4dc59118f |
1 '\" t
2 .\" Title: \fBndb_waiter\fR
3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
5 .\" Date: 11/04/2013
6 .\" Manual: MySQL Database System
7 .\" Source: MySQL 5.1
8 .\" Language: English
9 .\"
10 .TH "\FBNDB_WAITER\FR" "1" "11/04/2013" "MySQL 5\&.1" "MySQL Database System"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .\" ndb_waiter
31 .SH "NAME"
32 ndb_waiter \- wait for MySQL Cluster to reach a given status
33 .SH "SYNOPSIS"
34 .HP \w'\fBndb_waiter\ \fR\fB\fIoptions\fR\fR\ 'u
35 \fBndb_waiter \fR\fB\fIoptions\fR\fR
36 .SH "DESCRIPTION"
37 .PP
38 \fBndb_waiter\fR
39 repeatedly (each 100 milliseconds) prints out the status of all cluster data nodes until either the cluster reaches a given status or the
40 \fB\-\-timeout\fR
41 limit is exceeded, then exits\&. By default, it waits for the cluster to achieve
42 STARTED
43 status, in which all nodes have started and connected to the cluster\&. This can be overridden using the
44 \fB\-\-no\-contact\fR
45 and
46 \fB\-\-not\-started\fR
47 options\&.
48 .PP
49 The node states reported by this utility are as follows:
50 .sp
51 .RS 4
52 .ie n \{\
53 \h'-04'\(bu\h'+03'\c
54 .\}
55 .el \{\
56 .sp -1
57 .IP \(bu 2.3
58 .\}
59 NO_CONTACT: The node cannot be contacted\&.
60 .RE
61 .sp
62 .RS 4
63 .ie n \{\
64 \h'-04'\(bu\h'+03'\c
65 .\}
66 .el \{\
67 .sp -1
68 .IP \(bu 2.3
69 .\}
70 UNKNOWN: The node can be contacted, but its status is not yet known\&. Usually, this means that the node has received a
71 START
72 or
73 RESTART
74 command from the management server, but has not yet acted on it\&.
75 .RE
76 .sp
77 .RS 4
78 .ie n \{\
79 \h'-04'\(bu\h'+03'\c
80 .\}
81 .el \{\
82 .sp -1
83 .IP \(bu 2.3
84 .\}
85 NOT_STARTED: The node has stopped, but remains in contact with the cluster\&. This is seen when restarting the node using the management client\*(Aqs
86 RESTART
87 command\&.
88 .RE
89 .sp
90 .RS 4
91 .ie n \{\
92 \h'-04'\(bu\h'+03'\c
93 .\}
94 .el \{\
95 .sp -1
96 .IP \(bu 2.3
97 .\}
98 STARTING: The node\*(Aqs
99 \fBndbd\fR
100 process has started, but the node has not yet joined the cluster\&.
101 .RE
102 .sp
103 .RS 4
104 .ie n \{\
105 \h'-04'\(bu\h'+03'\c
106 .\}
107 .el \{\
108 .sp -1
109 .IP \(bu 2.3
110 .\}
111 STARTED: The node is operational, and has joined the cluster\&.
112 .RE
113 .sp
114 .RS 4
115 .ie n \{\
116 \h'-04'\(bu\h'+03'\c
117 .\}
118 .el \{\
119 .sp -1
120 .IP \(bu 2.3
121 .\}
122 SHUTTING_DOWN: The node is shutting down\&.
123 .RE
124 .sp
125 .RS 4
126 .ie n \{\
127 \h'-04'\(bu\h'+03'\c
128 .\}
129 .el \{\
130 .sp -1
131 .IP \(bu 2.3
132 .\}
133 SINGLE USER MODE: This is shown for all cluster data nodes when the cluster is in single user mode\&.
134 .RE
135 .PP
136 The following table includes options that are specific to the MySQL Cluster native backup restoration program
137 \fBndb_waiter\fR\&. Additional descriptions follow the table\&. For options common to most MySQL Cluster programs (including
138 \fBndb_waiter\fR), see
139 Options Common to MySQL Cluster Programs(1)\&.
140 .sp
141 .it 1 an-trap
142 .nr an-no-space-flag 1
143 .nr an-break-flag 1
144 .br
145 .B Table\ \&17.28.\ \&ndb_waiter Options and Variables: MySQL 5.1, MySQL Cluster NDB 6.3-7.1
146 .TS
147 allbox tab(:);
148 lB lB lB.
149 T{
150 Format
151 T}:T{
152 Description
153 T}:T{
154 Added / Removed
155 T}
156 .T&
157 l l l
158 l l l
159 l l l
160 l l l
161 l l l
162 l l l.
163 T{
164 .PP
165 --no-contact,
166 .PP
167 -n
168 T}:T{
169 Wait for cluster to reach NO CONTACT state
170 T}:T{
171 .PP
172 All MySQL 5\&.1 based releases
173 T}
174 T{
175 .PP
176 --not-started
177 T}:T{
178 Wait for cluster to reach NOT STARTED state
179 T}:T{
180 .PP
181 All MySQL 5\&.1 based releases
182 T}
183 T{
184 .PP
185 --single-user
186 T}:T{
187 Wait for cluster to enter single user mode
188 T}:T{
189 .PP
190 All MySQL 5\&.1 based releases
191 T}
192 T{
193 .PP
194 --timeout=#,
195 .PP
196 -t
197 T}:T{
198 Wait this many seconds, then exit whether or not cluster has reached
199 desired state; default is 2 minutes (120 seconds)
200 T}:T{
201 .PP
202 All MySQL 5\&.1 based releases
203 T}
204 T{
205 .PP
206 --nowait-nodes=list
207 T}:T{
208 List of nodes not to be waited for\&.
209 T}:T{
210 .PP
211 ADDED: NDB 6\&.2\&.1
212 T}
213 T{
214 .PP
215 --wait-nodes=list,
216 .PP
217 -w
218 T}:T{
219 List of nodes to be waited for\&.
220 T}:T{
221 .PP
222 ADDED: NDB 6\&.3\&.34, NDB 7\&.0\&.15, NDB 7\&.1\&.4
223 T}
224 .TE
225 .sp 1
226 Usage
227 .sp
228 .if n \{\
229 .RS 4
230 .\}
231 .nf
232 ndb_waiter [\-c \fIconnect_string\fR]
233 .fi
234 .if n \{\
235 .RE
236 .\}
237 Additional Options
238 .sp
239 .RS 4
240 .ie n \{\
241 \h'-04'\(bu\h'+03'\c
242 .\}
243 .el \{\
244 .sp -1
245 .IP \(bu 2.3
246 .\}
247 .\" ndb_waiter: no-contact option
248 .\" no-contact option: ndb_waiter
249 \fB\-\-no\-contact\fR,
250 \fB\-n\fR
251 .sp
252 Instead of waiting for the
253 STARTED
254 state,
255 \fBndb_waiter\fR
256 continues running until the cluster reaches
257 NO_CONTACT
258 status before exiting\&.
259 .RE
260 .sp
261 .RS 4
262 .ie n \{\
263 \h'-04'\(bu\h'+03'\c
264 .\}
265 .el \{\
266 .sp -1
267 .IP \(bu 2.3
268 .\}
269 .\" ndb_waiter: not-started option
270 .\" not-started option: ndb_waiter
271 \fB\-\-not\-started\fR
272 .sp
273 Instead of waiting for the
274 STARTED
275 state,
276 \fBndb_waiter\fR
277 continues running until the cluster reaches
278 NOT_STARTED
279 status before exiting\&.
280 .RE
281 .sp
282 .RS 4
283 .ie n \{\
284 \h'-04'\(bu\h'+03'\c
285 .\}
286 .el \{\
287 .sp -1
288 .IP \(bu 2.3
289 .\}
290 .\" ndb_waiter: timeout option
291 .\" timeout option: ndb_waiter
292 \fB\-\-timeout=\fR\fB\fIseconds\fR\fR,
293 \fB\-t \fR\fB\fIseconds\fR\fR
294 .sp
295 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)\&.
296 .RE
297 .sp
298 .RS 4
299 .ie n \{\
300 \h'-04'\(bu\h'+03'\c
301 .\}
302 .el \{\
303 .sp -1
304 .IP \(bu 2.3
305 .\}
306 .\" ndb_waiter: single-user option
307 .\" single-user option: ndb_waiter
308 \fB\-\-single\-user\fR
309 .sp
310 The program waits for the cluster to enter single user mode\&.
311 .RE
312 .sp
313 .RS 4
314 .ie n \{\
315 \h'-04'\(bu\h'+03'\c
316 .\}
317 .el \{\
318 .sp -1
319 .IP \(bu 2.3
320 .\}
321 .\" ndb_waiter: nowait-nodes option
322 .\" nowait-nodes option: ndb_waiter
323 \fB\-\-nowait\-nodes=\fR\fB\fIlist\fR\fR
324 .sp
325 When this option is used, ndb_waiter does not wait for the nodes whose IDs are listed\&. The list is comma\-delimited; ranges can be indicated by dashes, as shown here:
326 .sp
327 .if n \{\
328 .RS 4
329 .\}
330 .nf
331 shell> \fBndb_waiter \-\-nowait\-nodes=1,3,7\-9\fR
332 .fi
333 .if n \{\
334 .RE
335 .\}
336 .sp
337 .if n \{\
338 .sp
339 .\}
340 .RS 4
341 .it 1 an-trap
342 .nr an-no-space-flag 1
343 .nr an-break-flag 1
344 .br
345 .ps +1
346 \fBImportant\fR
347 .ps -1
348 .br
349 Do
350 \fInot\fR
351 use this option together with the
352 \fB\-\-wait\-nodes\fR
353 option\&.
354 .sp .5v
355 .RE
356 This option was added in MySQL Cluster NDB 6\&.2\&.1\&.
357 .RE
358 .sp
359 .RS 4
360 .ie n \{\
361 \h'-04'\(bu\h'+03'\c
362 .\}
363 .el \{\
364 .sp -1
365 .IP \(bu 2.3
366 .\}
367 .\" ndb_waiter: wait-nodes option
368 .\" wait-nodes option: ndb_waiter
369 \fB\-\-wait\-nodes=\fR\fB\fIlist\fR\fR,
370 \fB\-w \fR\fB\fIlist\fR\fR
371 .sp
372 When this option is used,
373 \fBndb_waiter\fR
374 waits only for the nodes whose IDs are listed\&. The list is comma\-delimited; ranges can be indicated by dashes, as shown here:
375 .sp
376 .if n \{\
377 .RS 4
378 .\}
379 .nf
380 shell> \fBndb_waiter \-\-wait\-nodes=2,4\-6,10\fR
381 .fi
382 .if n \{\
383 .RE
384 .\}
385 .sp
386 .if n \{\
387 .sp
388 .\}
389 .RS 4
390 .it 1 an-trap
391 .nr an-no-space-flag 1
392 .nr an-break-flag 1
393 .br
394 .ps +1
395 \fBImportant\fR
396 .ps -1
397 .br
398 Do
399 \fInot\fR
400 use this option together with the
401 \fB\-\-nowait\-nodes\fR
402 option\&.
403 .sp .5v
404 .RE
405 This option was added in MySQL Cluster NDB 6\&.3\&.34, 7\&.0\&.15, and 7\&.1\&.4\&.
406 .RE
407 .PP
408 \fBSample Output\fR. Shown here is the output from
409 \fBndb_waiter\fR
410 when run against a 4\-node cluster in which two nodes have been shut down and then started again manually\&. Duplicate reports (indicated by
411 \(lq\&.\&.\&.\(rq) are omitted\&.
412 .sp
413 .if n \{\
414 .RS 4
415 .\}
416 .nf
417 shell> \fB\&./ndb_waiter \-c localhost\fR
418 Connecting to mgmsrv at (localhost)
419 State node 1 STARTED
420 State node 2 NO_CONTACT
421 State node 3 STARTED
422 State node 4 NO_CONTACT
423 Waiting for cluster enter state STARTED
424 \&.\&.\&.
425 State node 1 STARTED
426 State node 2 UNKNOWN
427 State node 3 STARTED
428 State node 4 NO_CONTACT
429 Waiting for cluster enter state STARTED
430 \&.\&.\&.
431 State node 1 STARTED
432 State node 2 STARTING
433 State node 3 STARTED
434 State node 4 NO_CONTACT
435 Waiting for cluster enter state STARTED
436 \&.\&.\&.
437 State node 1 STARTED
438 State node 2 STARTING
439 State node 3 STARTED
440 State node 4 UNKNOWN
441 Waiting for cluster enter state STARTED
442 \&.\&.\&.
443 State node 1 STARTED
444 State node 2 STARTING
445 State node 3 STARTED
446 State node 4 STARTING
447 Waiting for cluster enter state STARTED
448 \&.\&.\&.
449 State node 1 STARTED
450 State node 2 STARTED
451 State node 3 STARTED
452 State node 4 STARTING
453 Waiting for cluster enter state STARTED
454 \&.\&.\&.
455 State node 1 STARTED
456 State node 2 STARTED
457 State node 3 STARTED
458 State node 4 STARTED
459 Waiting for cluster enter state STARTED
460 NDBT_ProgramExit: 0 \- OK
461 .fi
462 .if n \{\
463 .RE
464 .\}
465 .if n \{\
466 .sp
467 .\}
468 .RS 4
469 .it 1 an-trap
470 .nr an-no-space-flag 1
471 .nr an-break-flag 1
472 .br
473 .ps +1
474 \fBNote\fR
475 .ps -1
476 .br
477 .PP
478 If no connection string is specified, then
479 \fBndb_waiter\fR
480 tries to connect to a management on
481 localhost, and reports
482 Connecting to mgmsrv at (null)\&.
483 .sp .5v
484 .RE
485 .SH "COPYRIGHT"
486 .br
487 .PP
488 Copyright \(co 1997, 2013, Oracle and/or its affiliates. All rights reserved.
489 .PP
490 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.
491 .PP
492 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.
493 .PP
494 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/.
495 .sp
496 .SH "SEE ALSO"
497 For more information, please refer to the MySQL Reference Manual,
498 which may already be installed locally and which is also available
499 online at http://dev.mysql.com/doc/.
500 .SH AUTHOR
501 Oracle Corporation (http://dev.mysql.com/).