← Back to branch summary

~ubuntu-branches/ubuntu/lucid/mysql-dfsg-5.1/lucid-security

« back to all changes in this revision

Viewing changes to man/ndb_config.1

  • Committer: Package Import Robot
  • Author(s): Marc Deslauriers
  • Date: 2012-02-22 22:33:55 UTC
  • mfrom: (1.1.5)
  • Revision ID: package-import@ubuntu.com-20120222223355-or06x1euyk8n0ldi
Tags: 5.1.61-0ubuntu0.10.04.1
https://launchpad.net/bugs/937869
* SECURITY UPDATE: Update to 5.1.61 to fix multiple security issues
  (LP: #937869)
  - http://www.oracle.com/technetwork/topics/security/cpujan2012-366304.html
  - CVE-2011-2262
  - CVE-2012-0075
  - CVE-2012-0112
  - CVE-2012-0113
  - CVE-2012-0114
  - CVE-2012-0115
  - CVE-2012-0116
  - CVE-2012-0117
  - CVE-2012-0118
  - CVE-2012-0119
  - CVE-2012-0120
  - CVE-2012-0484
  - CVE-2012-0485
  - CVE-2012-0486
  - CVE-2012-0487
  - CVE-2012-0488
  - CVE-2012-0489
  - CVE-2012-0490
  - CVE-2012-0491
  - CVE-2012-0492
  - CVE-2012-0493
  - CVE-2012-0494
  - CVE-2012-0495
  - CVE-2012-0496
* Dropped patches unnecessary with 5.1.61:
  - debian/patches/90_mysql_safer_strmov.dpatch
  - debian/patches/51_ssl_test_certs.dpatch
  - debian/patches/52_CVE-2009-4030.dpatch
  - debian/patches/53_CVE-2009-4484.dpatch
  - debian/patches/54_CVE-2008-7247.dpatch
  - debian/patches/55_CVE-2010-1621.dpatch
  - debian/patches/56_CVE-2010-1850.dpatch
  - debian/patches/57_CVE-2010-1849.dpatch
  - debian/patches/58_CVE-2010-1848.dpatch
  - debian/patches/59_CVE-2010-1626.dpatch
  - debian/patches/60_CVE-2010-2008.dpatch
  - debian/patches/60_CVE-2010-3677.dpatch
  - debian/patches/60_CVE-2010-3678.dpatch
  - debian/patches/60_CVE-2010-3679.dpatch
  - debian/patches/60_CVE-2010-3680.dpatch
  - debian/patches/60_CVE-2010-3681.dpatch
  - debian/patches/60_CVE-2010-3682.dpatch
  - debian/patches/60_CVE-2010-3683.dpatch
  - debian/patches/60_CVE-2010-3833.dpatch
  - debian/patches/60_CVE-2010-3834.dpatch
  - debian/patches/60_CVE-2010-3835.dpatch
  - debian/patches/60_CVE-2010-3836.dpatch
  - debian/patches/60_CVE-2010-3837.dpatch
  - debian/patches/60_CVE-2010-3838.dpatch
  - debian/patches/60_CVE-2010-3839.dpatch
  - debian/patches/60_CVE-2010-3840.dpatch
  - debian/patches/61_disable_longfilename_test.dpatch
  - debian/patches/62_alter_table_fix.dpatch
  - debian/patches/63_cherrypick-upstream-49479.dpatch
  - debian/patches/10_readline_build_fix.dpatch
* debian/mysql-client-5.1.docs: removed EXCEPTIONS-CLIENT file
* debian/mysql-server-5.1.docs,debian/libmysqlclient16.docs,
  debian/libmysqlclient-dev.docs: removed, no longer necessary.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/ndb_config.1
2
2
.\"     Title: \fBndb_config\fR
3
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
 
.\"      Date: 11/04/2009
 
5
.\"      Date: 12/16/2011
6
6
.\"    Manual: MySQL Database System
7
7
.\"    Source: MySQL 5.1
8
8
.\"  Language: English
9
9
.\"
10
 
.TH "\FBNDB_CONFIG\FR" "1" "11/04/2009" "MySQL 5\&.1" "MySQL Database System"
 
10
.TH "\FBNDB_CONFIG\FR" "1" "12/16/2011" "MySQL 5\&.1" "MySQL Database System"
11
11
.\" -----------------------------------------------------------------
12
12
.\" * set default formatting
13
13
.\" -----------------------------------------------------------------
26
26
\fBndb_config \fR\fB\fIoptions\fR\fR
27
27
.SH "DESCRIPTION"
28
28
.PP
29
 
This tool extracts current configuration information for data nodes, SQL nodes, and API nodes from a cluster management node (and possibly its
 
29
This tool extracts current configuration information for data nodes, SQL nodes, and API nodes from one of a number of sources: a MySQL Cluster management node, or its
30
30
config\&.ini
31
 
file)\&. Beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6, it can also provide an offline dump (in text or XML format) of all configuration parameters which can be used, along with their default, maximum, and minimum values and other information (see the discussion of the
 
31
or
 
32
my\&.cnf
 
33
file\&. By default, the management node is the source for the configuration data; to override the default, execute ndb_config with the
 
34
\fB\-\-config\-file\fR
 
35
or
 
36
\fB\-\-mycnf\fR
 
37
option\&. Beginning with MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, it is also possible to use a data node as the source by specifying its node ID using
 
38
\fB\-\-config_from_node=\fR\fB\fInode_id\fR\fR\-
 
39
.PP
 
40
Beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6,
 
41
\fBndb_config\fR
 
42
can also provide an offline dump of all configuration parameters which can be used, along with their default, maximum, and minimum values and other information\&. The dump can be produced in either text or XML format; for more information, see the discussion of the
32
43
\fB\-\-configinfo\fR
33
44
and
34
45
\fB\-\-xml\fR
35
46
options later in this section)\&.
36
47
.PP
 
48
Beginning with MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, you can filter the results by section (DB,
 
49
SYSTEM, or
 
50
CONNECTIONS) using one of the options
 
51
\fB\-\-nodes\fR,
 
52
\fB\-\-system\fR, or
 
53
\fB\-\-connections\fR\&.
 
54
.PP
37
55
The following table includes options that are specific to
38
56
\fBndb_config\fR\&. Additional descriptions follow the table\&. For options common to all MySQL Cluster programs, see
39
 
Section\ \&17.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.
 
57
Section\ \&16.4.2, \(lqOptions Common to MySQL Cluster Programs\(rq\&.
40
58
.sp
41
59
.RS 4
42
60
.ie n \{\
53
71
\fB\-?\fR
54
72
.TS
55
73
allbox tab(:);
56
 
l l s.
 
74
l l s s
 
75
l l s s
 
76
l l s s.
57
77
T{
58
 
\fBCommand Line Format\fR
 
78
\fBCommand\-Line Format\fR
59
79
T}:T{
60
80
\-\-help
61
81
T}
 
82
T{
 
83
T}:T{
 
84
\-\-usage
 
85
T}
 
86
T{
 
87
T}:T{
 
88
\-?
 
89
T}
62
90
.TE
63
91
.sp 1
64
92
Causes
74
102
.sp -1
75
103
.IP \(bu 2.3
76
104
.\}
 
105
.\" ndb_config: config_from_node option
 
106
.\" config_from_node option: ndb_config
 
107
\fB\-\-config_from_node=#\fR
 
108
.TS
 
109
allbox tab(:);
 
110
l l s s
 
111
l l s s
 
112
l l s s
 
113
^ l l s
 
114
^ l l s
 
115
^ l l s.
 
116
T{
 
117
\fBVersion Introduced\fR
 
118
T}:T{
 
119
5\&.1\&.56\-ndb\-7\&.0\&.27, 5\&.1\&.56\-ndb\-7\&.1\&.16
 
120
T}
 
121
T{
 
122
\fBCommand\-Line Format\fR
 
123
T}:T{
 
124
\-\-config_from_node=#
 
125
T}
 
126
T{
 
127
\ \&
 
128
T}:T{
 
129
\fBPermitted Values \fR
 
130
T}
 
131
:T{
 
132
\fBType\fR
 
133
T}:T{
 
134
numeric
 
135
T}
 
136
:T{
 
137
\fBDefault\fR
 
138
T}:T{
 
139
none
 
140
T}
 
141
:T{
 
142
\fBRange\fR
 
143
T}:T{
 
144
1 \&.\&. 48
 
145
T}
 
146
.TE
 
147
.sp 1
 
148
Obtain the cluster\'s configuration data from the data node that has this ID\&.
 
149
.sp
 
150
If the node having this ID is not a data node,
 
151
\fBndb_config\fR
 
152
fails with an error\&. (To obtain configuration data from the management node instead, simply omit this option\&.)
 
153
.sp
 
154
\fB\-\-config_from_node\fR
 
155
was added in MySQL Cluster NDB 7\&.0\&.27 and MySQL NDB 7\&.1\&.16\&.
 
156
.RE
 
157
.sp
 
158
.RS 4
 
159
.ie n \{\
 
160
\h'-04'\(bu\h'+03'\c
 
161
.\}
 
162
.el \{\
 
163
.sp -1
 
164
.IP \(bu 2.3
 
165
.\}
77
166
.\" ndb_config: version option
78
167
.\" version option: ndb_config
79
168
\fB\-\-version\fR,
80
169
\fB\-V\fR
81
170
.TS
82
171
allbox tab(:);
83
 
l l s.
84
 
T{
85
 
\fBCommand Line Format\fR
 
172
l l s s
 
173
l l s s.
 
174
T{
 
175
\fBCommand\-Line Format\fR
 
176
T}:T{
 
177
\-\-version
 
178
T}
 
179
T{
86
180
T}:T{
87
181
\-V
88
182
T}
104
198
.\" ndb_config: ndb-connectstring option
105
199
.\" ndb-connectstring option: ndb_config
106
200
\fB\-\-ndb\-connectstring=\fR\fB\fIconnect_string\fR\fR
107
 
.TS
108
 
allbox tab(:);
109
 
l l s
110
 
l l s
111
 
^ l l
112
 
^ l l.
113
 
T{
114
 
\fBCommand Line Format\fR
115
 
T}:T{
116
 
\-\-ndb\-connectstring=name
117
 
T}
118
 
T{
119
 
\ \&
120
 
T}:T{
121
 
\fBPermitted Values \fR
122
 
T}
123
 
:T{
124
 
\fBType\fR
125
 
T}:T{
126
 
string
127
 
T}
128
 
:T{
129
 
\fBDefault\fR
130
 
T}:T{
131
 
localhost:1186
132
 
T}
133
 
.TE
134
 
.sp 1
 
201
.sp
135
202
Specifies the connectstring to use in connecting to the management server\&. The format for the connectstring is the same as described in
136
 
Section\ \&17.3.2.3, \(lqThe MySQL Cluster Connectstring\(rq, and defaults to
 
203
Section\ \&16.3.2.3, \(lqThe MySQL Cluster Connectstring\(rq, and defaults to
137
204
localhost:1186\&.
138
205
.sp
139
206
The use of
154
221
.\" ndb_config: config-file option
155
222
.\" config-file option: ndb_config
156
223
\fB\-\-config\-file=\fR\fB\fIpath\-to\-file\fR\fR
157
 
.sp
 
224
.TS
 
225
allbox tab(:);
 
226
l l s s
 
227
l l s s
 
228
^ l l s
 
229
^ l l s.
 
230
T{
 
231
\fBCommand\-Line Format\fR
 
232
T}:T{
 
233
\-\-config\-file=path
 
234
T}
 
235
T{
 
236
\ \&
 
237
T}:T{
 
238
\fBPermitted Values \fR
 
239
T}
 
240
:T{
 
241
\fBType\fR
 
242
T}:T{
 
243
file name
 
244
T}
 
245
:T{
 
246
\fBDefault\fR
 
247
T}:T{
 
248
T}
 
249
.TE
 
250
.sp 1
158
251
Gives the path to the management server\'s configuration file (config\&.ini)\&. This may be a relative or absolute path\&. If the management node resides on a different host from the one on which
159
252
\fBndb_config\fR
160
253
is invoked, then an absolute path must be used\&.
168
261
.sp -1
169
262
.IP \(bu 2.3
170
263
.\}
 
264
.\" ndb_config: mycnf option
 
265
.\" mycnf option: ndb_config
 
266
\fB\-\-mycnf\fR
 
267
.TS
 
268
allbox tab(:);
 
269
l l s s
 
270
l l s s
 
271
^ l l s
 
272
^ l l s.
 
273
T{
 
274
\fBCommand\-Line Format\fR
 
275
T}:T{
 
276
\-\-mycnf
 
277
T}
 
278
T{
 
279
\ \&
 
280
T}:T{
 
281
\fBPermitted Values \fR
 
282
T}
 
283
:T{
 
284
\fBType\fR
 
285
T}:T{
 
286
boolean
 
287
T}
 
288
:T{
 
289
\fBDefault\fR
 
290
T}:T{
 
291
FALSE
 
292
T}
 
293
.TE
 
294
.sp 1
 
295
Read configuration data from the
 
296
my\&.cnf
 
297
file\&.
 
298
.RE
 
299
.sp
 
300
.RS 4
 
301
.ie n \{\
 
302
\h'-04'\(bu\h'+03'\c
 
303
.\}
 
304
.el \{\
 
305
.sp -1
 
306
.IP \(bu 2.3
 
307
.\}
171
308
.\" ndb_config: query option
172
309
.\" query option: ndb_config
173
310
\fB\-\-query=\fR\fB\fIquery\-options\fR\fR,
175
312
\fIquery\-options\fR
176
313
.TS
177
314
allbox tab(:);
178
 
l l s
179
 
l l s
180
 
^ l l
181
 
^ l l.
 
315
l l s s
 
316
l l s s
 
317
l l s s
 
318
^ l l s
 
319
^ l l s.
182
320
T{
183
 
\fBCommand Line Format\fR
 
321
\fBCommand\-Line Format\fR
184
322
T}:T{
185
323
\-\-query=string
186
324
T}
187
325
T{
 
326
T}:T{
 
327
\-q
 
328
T}
 
329
T{
188
330
\ \&
189
331
T}:T{
190
332
\fBPermitted Values \fR
201
343
.TE
202
344
.sp 1
203
345
This is a comma\-delimited list of
204
 
query options
205
 
\(em that is, a list of one or more node attributes to be returned\&. These include
 
346
query options\(emthat is, a list of one or more node attributes to be returned\&. These include
206
347
id
207
 
(node ID), type (node type \(em that is,
 
348
(node ID), type (node type\(emthat is,
208
349
ndbd,
209
350
mysqld, or
210
351
ndb_mgmd), and any configuration parameters whose values are to be obtained\&.
213
354
.\" ndb_config: query option
214
355
.\" query option: ndb_config
215
356
\fB\-\-query=id,type,indexmemory,datamemory\fR
216
 
would return the node ID, node type,
 
357
returns the node ID, node type,
217
358
DataMemory, and
218
359
IndexMemory
219
360
for each node\&.
247
388
\fB\-\-host=\fR\fB\fIhostname\fR\fR
248
389
.TS
249
390
allbox tab(:);
250
 
l l s
251
 
l l s
252
 
^ l l
253
 
^ l l.
 
391
l l s s
 
392
l l s s
 
393
^ l l s
 
394
^ l l s.
254
395
T{
255
 
\fBCommand Line Format\fR
 
396
\fBCommand\-Line Format\fR
256
397
T}:T{
257
398
\-\-host=name
258
399
T}
273
414
.TE
274
415
.sp 1
275
416
Specifies the host name of the node for which configuration information is to be obtained\&.
 
417
.if n \{\
 
418
.sp
 
419
.\}
 
420
.RS 4
 
421
.it 1 an-trap
 
422
.nr an-no-space-flag 1
 
423
.nr an-break-flag 1
 
424
.br
 
425
.ps +1
 
426
\fBNote\fR
 
427
.ps -1
 
428
.br
 
429
While the hostname
 
430
localhost
 
431
usually resolves to the IP address
 
432
127\&.0\&.0\&.1, this may not necessarily be true for all operating platforms and configurations\&. This means that it is possible, when
 
433
localhost
 
434
is used in
 
435
config\&.ini, for
 
436
\fBndb_config \fR\fB\fB\-\-host=localhost\fR\fR
 
437
to fail if
 
438
\fBndb_config\fR
 
439
is run on a different host where
 
440
localhost
 
441
resolves to a different address (for example, on some versions of SUSE Linux, this is
 
442
127\&.0\&.0\&.2)\&. In general, for best results, you should use numeric IP addresses for all MySQL Clustewr configuration values relating to hosts, or verify that all MySQL Cluster hosts handle
 
443
localhost
 
444
in the same fashion\&.
 
445
.sp .5v
 
446
.RE
276
447
.RE
277
448
.sp
278
449
.RS 4
285
456
.\}
286
457
.\" ndb_config: id option
287
458
.\" id option: ndb_config
288
 
\fB\-\-id=\fR\fB\fInode_id\fR\fR,
 
459
\fB\-\-id=\fR\fB\fInode_id\fR\fR
 
460
.sp
289
461
.\" ndb_config: nodeid option
290
462
.\" nodeid option: ndb_config
291
463
\fB\-\-nodeid=\fR\fB\fInode_id\fR\fR
292
 
.TS
293
 
allbox tab(:);
294
 
l l s
295
 
l l s
296
 
^ l l
297
 
^ l l.
298
 
T{
299
 
\fBCommand Line Format\fR
300
 
T}:T{
301
 
\-\-ndb\-nodeid=#
302
 
T}
303
 
T{
304
 
\ \&
305
 
T}:T{
306
 
\fBPermitted Values \fR
307
 
T}
308
 
:T{
309
 
\fBType\fR
310
 
T}:T{
311
 
numeric
312
 
T}
313
 
:T{
314
 
\fBDefault\fR
315
 
T}:T{
316
 
0
317
 
T}
318
 
.TE
319
 
.sp 1
320
 
Used to specify the node ID of the node for which configuration information is to be obtained\&.
 
464
.sp
 
465
Either of these options can be used to specify the node ID of the node for which configuration information is to be obtained\&.
 
466
\fB\-\-nodeid\fR
 
467
is the preferred form\&.
321
468
.RE
322
469
.sp
323
470
.RS 4
333
480
\fB\-\-nodes\fR
334
481
.TS
335
482
allbox tab(:);
336
 
l l s
337
 
l l s
338
 
^ l l
339
 
^ l l.
 
483
l l s s
 
484
l l s s
 
485
^ l l s
 
486
^ l l s.
340
487
T{
341
 
\fBCommand Line Format\fR
 
488
\fBCommand\-Line Format\fR
342
489
T}:T{
343
490
\-\-nodes
344
491
T}
359
506
T}
360
507
.TE
361
508
.sp 1
362
 
(Tells
 
509
Tells
363
510
\fBndb_config\fR
364
511
to print information from parameters defined in
365
 
[ndbd]
366
 
sections only\&. Currently, using this option has no affect, since these are the only values checked, but it may become possible in future to query parameters set in
367
 
[tcp]
368
 
and other sections of cluster configuration files\&.)
 
512
DB
 
513
sections only\&. Prior to MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, this option had no affect\&. This option cannot be used together with
 
514
\fB\-\-connections\fR
 
515
or
 
516
\fB\-\-system\fR\&.
 
517
.RE
 
518
.sp
 
519
.RS 4
 
520
.ie n \{\
 
521
\h'-04'\(bu\h'+03'\c
 
522
.\}
 
523
.el \{\
 
524
.sp -1
 
525
.IP \(bu 2.3
 
526
.\}
 
527
.\" ndb_config: connections option
 
528
.\" connections option: ndb_config
 
529
\fB\-\-connections\fR
 
530
.TS
 
531
allbox tab(:);
 
532
l l s s
 
533
l l s s
 
534
^ l l s
 
535
^ l l s.
 
536
T{
 
537
\fBCommand\-Line Format\fR
 
538
T}:T{
 
539
\-\-connections
 
540
T}
 
541
T{
 
542
\ \&
 
543
T}:T{
 
544
\fBPermitted Values \fR
 
545
T}
 
546
:T{
 
547
\fBType\fR
 
548
T}:T{
 
549
boolean
 
550
T}
 
551
:T{
 
552
\fBDefault\fR
 
553
T}:T{
 
554
FALSE
 
555
T}
 
556
.TE
 
557
.sp 1
 
558
Tells
 
559
\fBndb_config\fR
 
560
to print
 
561
CONNECTIONS
 
562
information only\&. This option existed prior to MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16, but had no affect before then\&. This option cannot be used together with
 
563
\fB\-\-nodes\fR
 
564
or
 
565
\fB\-\-system\fR\&.
 
566
.RE
 
567
.sp
 
568
.RS 4
 
569
.ie n \{\
 
570
\h'-04'\(bu\h'+03'\c
 
571
.\}
 
572
.el \{\
 
573
.sp -1
 
574
.IP \(bu 2.3
 
575
.\}
 
576
.\" ndb_config: system option
 
577
.\" system option: ndb_config
 
578
\fB\-\-system\fR
 
579
.TS
 
580
allbox tab(:);
 
581
l l s s
 
582
l l s s
 
583
l l s s
 
584
^ l l s
 
585
^ l l s.
 
586
T{
 
587
\fBVersion Introduced\fR
 
588
T}:T{
 
589
5\&.1\&.56\-ndb\-7\&.0\&.27, 5\&.1\&.56\-ndb\-7\&.1\&.16
 
590
T}
 
591
T{
 
592
\fBCommand\-Line Format\fR
 
593
T}:T{
 
594
\-\-system
 
595
T}
 
596
T{
 
597
\ \&
 
598
T}:T{
 
599
\fBPermitted Values \fR
 
600
T}
 
601
:T{
 
602
\fBType\fR
 
603
T}:T{
 
604
boolean
 
605
T}
 
606
:T{
 
607
\fBDefault\fR
 
608
T}:T{
 
609
FALSE
 
610
T}
 
611
.TE
 
612
.sp 1
 
613
Tells
 
614
\fBndb_config\fR
 
615
to print
 
616
SYSTEM
 
617
information only\&.
 
618
.sp
 
619
This option was introduced in MySQL Cluster NDB 7\&.0\&.27 and MySQL Cluster NDB 7\&.1\&.16\&. It cannot be used together with the
 
620
\fB\-\-nodes\fR
 
621
or
 
622
\fB\-\-system\fR
 
623
options\&.
369
624
.RE
370
625
.sp
371
626
.RS 4
381
636
\fB\-\-type=\fR\fB\fInode_type\fR\fR
382
637
.TS
383
638
allbox tab(:);
384
 
l l s
385
 
l l s
386
 
^ l l
387
 
^ l l
388
 
^ l l.
 
639
l l s s
 
640
l l s s
 
641
^ l l s
 
642
^ l l s
 
643
^ l l s.
389
644
T{
390
 
\fBCommand Line Format\fR
 
645
\fBCommand\-Line Format\fR
391
646
T}:T{
392
647
\-\-type=name
393
648
T}
408
663
:T{
409
664
\fBValid Values\fR
410
665
T}:T{
411
 
ndbd, mysqld, ndb_mgmd
 
666
ndbd
 
667
.sp
 
668
mysqld
 
669
.sp
 
670
ndb_mgmd
412
671
T}
413
672
.TE
414
673
.sp 1
434
693
\fIdelimiter\fR
435
694
.TS
436
695
allbox tab(:);
437
 
l l s
438
 
l l s
439
 
^ l l
440
 
^ l l.
 
696
l l s s
 
697
l l s s
 
698
l l s s
 
699
^ l l s
 
700
^ l l s.
441
701
T{
442
 
\fBCommand Line Format\fR
 
702
\fBCommand\-Line Format\fR
443
703
T}:T{
444
704
\-\-fields=string
445
705
T}
446
706
T{
 
707
T}:T{
 
708
\-f
 
709
T}
 
710
T{
447
711
\ \&
448
712
T}:T{
449
713
\fBPermitted Values \fR
500
764
\fIseparator\fR
501
765
.TS
502
766
allbox tab(:);
503
 
l l s
504
 
l l s
505
 
^ l l
506
 
^ l l.
 
767
l l s s
 
768
l l s s
 
769
l l s s
 
770
^ l l s
 
771
^ l l s.
507
772
T{
508
 
\fBCommand Line Format\fR
 
773
\fBCommand\-Line Format\fR
509
774
T}:T{
510
775
\-\-rows=string
511
776
T}
512
777
T{
 
778
T}:T{
 
779
\-r
 
780
T}
 
781
T{
513
782
\ \&
514
783
T}:T{
515
784
\fBPermitted Values \fR
558
827
.IP \(bu 2.3
559
828
.\}
560
829
.\" ndb_config: configinfo option
561
 
.\" ndb_config: xml option
562
830
.\" configinfo option: ndb_config
563
 
.\" xml option: ndb_config
564
831
\fB\-\-configinfo\fR
565
 
[\fB\-\-xml\fR]
566
 
.TS
567
 
allbox tab(:);
568
 
l l s
569
 
l l s
570
 
l l s
571
 
^ l l
572
 
^ l l.
573
 
T{
574
 
\fBVersion Introduced\fR
575
 
T}:T{
576
 
5\&.1\&.34\-ndb\-7\&.0\&.6
577
 
T}
578
 
T{
579
 
\fBCommand Line Format\fR
580
 
T}:T{
581
 
\-\-configinfo
582
 
T}
583
 
T{
584
 
\ \&
585
 
T}:T{
586
 
\fBPermitted Values \fR
587
 
T}
588
 
:T{
589
 
\fBType\fR
590
 
T}:T{
591
 
boolean
592
 
T}
593
 
:T{
594
 
\fBDefault\fR
595
 
T}:T{
596
 
false
597
 
T}
598
 
.TE
599
 
.sp 1
600
 
.TS
601
 
allbox tab(:);
602
 
l l s
603
 
l l s
604
 
l l s
605
 
^ l l
606
 
^ l l.
607
 
T{
608
 
\fBVersion Introduced\fR
609
 
T}:T{
610
 
5\&.1\&.34\-ndb\-7\&.0\&.6
611
 
T}
612
 
T{
613
 
\fBCommand Line Format\fR
614
 
T}:T{
615
 
\-\-configinfo \-\-xml
616
 
T}
617
 
T{
618
 
\ \&
619
 
T}:T{
620
 
\fBPermitted Values \fR
621
 
T}
622
 
:T{
623
 
\fBType\fR
624
 
T}:T{
625
 
boolean
626
 
T}
627
 
:T{
628
 
\fBDefault\fR
629
 
T}:T{
630
 
false
631
 
T}
632
 
.TE
633
 
.sp 1
 
832
.sp
634
833
The
635
834
\fB\-\-configinfo\fR
636
835
option, added in MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6, causes
737
936
.RE
738
937
.\}
739
938
.sp
740
 
You can obtain the output as XML by using the
741
 
\fB\-\-xml\fR
742
 
option (also available beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6) in addition to
743
 
\fB\-\-configinfo\fR\&. A portion of the resulting output is shown in this example:
 
939
.\" ndb_config: xml option
 
940
.\" xml option: ndb_config
 
941
\fB\-\-configinfo\fR
 
942
\fB\-\-xml\fR
 
943
.TS
 
944
allbox tab(:);
 
945
l l s s
 
946
l l s s
 
947
l l s s
 
948
^ l l s
 
949
^ l l s.
 
950
T{
 
951
\fBVersion Introduced\fR
 
952
T}:T{
 
953
5\&.1\&.34\-ndb\-6\&.3\&.25, 5\&.1\&.34\-ndb\-7\&.0\&.6
 
954
T}
 
955
T{
 
956
\fBCommand\-Line Format\fR
 
957
T}:T{
 
958
\-\-configinfo \-\-xml
 
959
T}
 
960
T{
 
961
\ \&
 
962
T}:T{
 
963
\fBPermitted Values \fR
 
964
T}
 
965
:T{
 
966
\fBType\fR
 
967
T}:T{
 
968
boolean
 
969
T}
 
970
:T{
 
971
\fBDefault\fR
 
972
T}:T{
 
973
false
 
974
T}
 
975
.TE
 
976
.sp 1
 
977
You can obtain the output of
 
978
\fBndb_config\fR
 
979
\fB\-\-configinfo\fR
 
980
as XML by adding the
 
981
\fB\-\-xml\fR
 
982
option (like the
 
983
\fB\-\-configinfo\fR
 
984
option, available beginning with MySQL Cluster NDB 6\&.3\&.25 and MySQL Cluster NDB 7\&.0\&.6)\&. A portion of the resulting output is shown in this example:
744
985
.sp
745
986
.if n \{\
746
987
.RS 4
781
1022
.nr an-break-flag 1
782
1023
.br
783
1024
.ps +1
 
1025
\fBNote\fR
 
1026
.ps -1
 
1027
.br
 
1028
Normally, the XML output produced by
 
1029
\fBndb_config\fR
 
1030
\fB\-\-configinfo\fR
 
1031
\fB\-\-xml\fR
 
1032
is formatted using one line per element; we have added extra whitespace in the previous example, as well as the next one, for reasons of legibility\&. This should not make any difference to applications using this output, since most XML processors either ignore nonessential whitespace as a matter of course, or can be instructed to do so\&.
 
1033
.sp .5v
 
1034
.RE
 
1035
Beginning with MySQL Cluster NDB 6\&.3\&.29 and MySQL Cluster NDB 7\&.0\&.10, the XML output also indicates when changing a given parameter requires that data nodes be restarted using the
 
1036
\fB\-\-initial\fR
 
1037
option\&. This is shown by the presence of an
 
1038
initial="true"
 
1039
attribute in the corresponding
 
1040
<param>
 
1041
element\&. In addition (also beginning with MySQL Cluster NDB 6\&.3\&.29 and MySQL Cluster NDB 7\&.0\&.10), the restart type (system
 
1042
or
 
1043
node) is also shown; if a given parameter requires a system restart, this is indicated by the presence of a
 
1044
restart="system"
 
1045
attribute in the corresponding
 
1046
<param>
 
1047
element\&. For example, changing the value set for the
 
1048
Diskless
 
1049
parameter requires a system initial restart, as shown here (with the
 
1050
restart
 
1051
and
 
1052
initial
 
1053
attributes highlighted for visibility):
 
1054
.sp
 
1055
.if n \{\
 
1056
.RS 4
 
1057
.\}
 
1058
.nf
 
1059
<param name="Diskless" comment="Run wo/ disk" type="bool" default="false" 
 
1060
          \fIrestart="system" initial="true"\fR/>
 
1061
.fi
 
1062
.if n \{\
 
1063
.RE
 
1064
.\}
 
1065
.sp
 
1066
Currently, no
 
1067
initial
 
1068
attribute is included in the XML output for
 
1069
<param>
 
1070
elements corresponding to parameters which do not require initial restarts; in other words,
 
1071
initial="false"
 
1072
is the default, and the value
 
1073
false
 
1074
should be assumed if the attribute is not present\&. Similarly, the default restart type is
 
1075
node
 
1076
(that is, an online or
 
1077
\(lqrolling\(rq
 
1078
restart of the cluster), but the
 
1079
restart
 
1080
attribute is included only if the restart type is
 
1081
system
 
1082
(meaning that all cluster nodes must be shut down at the same time, then restarted)\&.
 
1083
.if n \{\
 
1084
.sp
 
1085
.\}
 
1086
.RS 4
 
1087
.it 1 an-trap
 
1088
.nr an-no-space-flag 1
 
1089
.nr an-break-flag 1
 
1090
.br
 
1091
.ps +1
784
1092
\fBImportant\fR
785
1093
.ps -1
786
1094
.br
816
1124
\fB\-\-configinfo\fR
817
1125
or
818
1126
\fB\-\-xml\fR
819
 
is not supported\&. If you attempt to do so, the usual (current) result is that all other options besides
 
1127
is not supported\&. Currently, if you attempt to do so, the usual result is that all other options besides
820
1128
\fB\-\-configinfo\fR
821
1129
or
822
1130
\fB\-\-xml\fR
823
 
are simply ignored\&. However, this behavior is not guaranteed and is subject to change at any time\&. In addition, since
824
 
\fBndb_config\fR
825
 
when used with the
 
1131
are simply ignored\&.
 
1132
\fIHowever, this behavior is not guaranteed and is subject to change at any time\fR\&. In addition, since
 
1133
\fBndb_config\fR, when used with the
826
1134
\fB\-\-configinfo\fR
827
 
option does not access the MySQL Cluster or read any files, trying to specify additional options such as
 
1135
option, does not access the MySQL Cluster or read any files, trying to specify additional options such as
828
1136
\fB\-\-ndb\-connectstring\fR
829
1137
or
830
1138
\fB\-\-config\-file\fR
832
1140
\fB\-\-configinfo\fR
833
1141
serves no purpose\&.
834
1142
.RE
835
 
.PP
836
 
\fBExamples\fR:
 
1143
          Examples
837
1144
.sp
838
1145
.RS 4
839
1146
.ie n \{\
905
1212
\fBndb_config\fR
906
1213
checks only data nodes (using the
907
1214
\fB\-\-type\fR
908
 
option), and shows the values for each node\'s ID and host name, and its
 
1215
option), and shows the values for each node\'s ID and host name, as well as the values set for its
909
1216
DataMemory,
910
1217
IndexMemory, and
911
1218
DataDir
969
1276
.SH "COPYRIGHT"
970
1277
.br
971
1278
.PP
972
 
Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.
 
1279
Copyright \(co 1997, 2011, Oracle and/or its affiliates. All rights reserved.
973
1280
.PP
974
1281
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.
975
1282
.PP
982
1289
which may already be installed locally and which is also available
983
1290
online at http://dev.mysql.com/doc/.
984
1291
.SH AUTHOR
985
 
Sun Microsystems, Inc. (http://www.mysql.com/).
 
1292
Oracle Corporation (http://dev.mysql.com/).