← Back to branch summary

~ubuntu-branches/ubuntu/maverick/mysql-5.1/maverick-proposed

« 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 14:16:05 UTC
  • mto: This revision was merged to the branch mainline in revision 20.
  • Revision ID: package-import@ubuntu.com-20120222141605-nxlu9yzc6attylc2
Tags: upstream-5.1.61
Import upstream version 5.1.61

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: 07/06/2010
 
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" "07/06/2010" "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(:);
 
74
l l s s
 
75
l l s s
56
76
l l s s.
57
77
T{
58
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(:);
 
172
l l s s
83
173
l l s s.
84
174
T{
85
175
\fBCommand\-Line Format\fR
86
176
T}:T{
 
177
\-\-version
 
178
T}
 
179
T{
 
180
T}:T{
87
181
\-V
88
182
T}
89
183
.TE
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 s
110
 
l l s s
111
 
^ l l s
112
 
^ l l s.
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,
177
314
allbox tab(:);
178
315
l l s s
179
316
l l s s
 
317
l l s s
180
318
^ l l s
181
319
^ l l s.
182
320
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
212
354
.\" ndb_config: query option
213
355
.\" query option: ndb_config
214
356
\fB\-\-query=id,type,indexmemory,datamemory\fR
215
 
would return the node ID, node type,
 
357
returns the node ID, node type,
216
358
DataMemory, and
217
359
IndexMemory
218
360
for each node\&.
314
456
.\}
315
457
.\" ndb_config: id option
316
458
.\" id option: ndb_config
317
 
\fB\-\-id=\fR\fB\fInode_id\fR\fR,
 
459
\fB\-\-id=\fR\fB\fInode_id\fR\fR
 
460
.sp
318
461
.\" ndb_config: nodeid option
319
462
.\" nodeid option: ndb_config
320
463
\fB\-\-nodeid=\fR\fB\fInode_id\fR\fR
321
464
.sp
322
 
Used to specify the node ID of the node for which configuration information is to be obtained\&.
 
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\&.
323
468
.RE
324
469
.sp
325
470
.RS 4
361
506
T}
362
507
.TE
363
508
.sp 1
364
 
(Tells
 
509
Tells
365
510
\fBndb_config\fR
366
511
to print information from parameters defined in
367
 
[ndbd]
368
 
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
369
 
[tcp]
370
 
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\&.
371
624
.RE
372
625
.sp
373
626
.RS 4
410
663
:T{
411
664
\fBValid Values\fR
412
665
T}:T{
413
 
ndbd, mysqld, ndb_mgmd
 
666
ndbd
 
667
.sp
 
668
mysqld
 
669
.sp
 
670
ndb_mgmd
414
671
T}
415
672
.TE
416
673
.sp 1
438
695
allbox tab(:);
439
696
l l s s
440
697
l l s s
 
698
l l s s
441
699
^ l l s
442
700
^ l l s.
443
701
T{
446
704
\-\-fields=string
447
705
T}
448
706
T{
 
707
T}:T{
 
708
\-f
 
709
T}
 
710
T{
449
711
\ \&
450
712
T}:T{
451
713
\fBPermitted Values \fR
504
766
allbox tab(:);
505
767
l l s s
506
768
l l s s
 
769
l l s s
507
770
^ l l s
508
771
^ l l s.
509
772
T{
512
775
\-\-rows=string
513
776
T}
514
777
T{
 
778
T}:T{
 
779
\-r
 
780
T}
 
781
T{
515
782
\ \&
516
783
T}:T{
517
784
\fBPermitted Values \fR
683
950
T{
684
951
\fBVersion Introduced\fR
685
952
T}:T{
686
 
5\&.1\&.34\-ndb\-7\&.0\&.6
 
953
5\&.1\&.34\-ndb\-6\&.3\&.25, 5\&.1\&.34\-ndb\-7\&.0\&.6
687
954
T}
688
955
T{
689
956
\fBCommand\-Line Format\fR
765
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\&.
766
1033
.sp .5v
767
1034
.RE
768
 
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 nodes be restarted using the
 
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
769
1036
\fB\-\-initial\fR
770
1037
option\&. This is shown by the presence of an
771
1038
initial="true"
777
1044
restart="system"
778
1045
attribute in the corresponding
779
1046
<param>
780
 
element\&. For example, the
 
1047
element\&. For example, changing the value set for the
781
1048
Diskless
782
1049
parameter requires a system initial restart, as shown here (with the
783
1050
restart
857
1124
\fB\-\-configinfo\fR
858
1125
or
859
1126
\fB\-\-xml\fR
860
 
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
861
1128
\fB\-\-configinfo\fR
862
1129
or
863
1130
\fB\-\-xml\fR
864
 
are simply ignored\&. However, this behavior is not guaranteed and is subject to change at any time\&. In addition, since
865
 
\fBndb_config\fR
866
 
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
867
1134
\fB\-\-configinfo\fR
868
 
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
869
1136
\fB\-\-ndb\-connectstring\fR
870
1137
or
871
1138
\fB\-\-config\-file\fR
873
1140
\fB\-\-configinfo\fR
874
1141
serves no purpose\&.
875
1142
.RE
876
 
.PP
877
 
\fBExamples\fR:
 
1143
          Examples
878
1144
.sp
879
1145
.RS 4
880
1146
.ie n \{\
946
1212
\fBndb_config\fR
947
1213
checks only data nodes (using the
948
1214
\fB\-\-type\fR
949
 
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
950
1216
DataMemory,
951
1217
IndexMemory, and
952
1218
DataDir
1010
1276
.SH "COPYRIGHT"
1011
1277
.br
1012
1278
.PP
1013
 
Copyright \(co 1997, 2010, Oracle and/or its affiliates. All rights reserved.
 
1279
Copyright \(co 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1014
1280
.PP
1015
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.
1016
1282
.PP