← Back to branch summary

~ubuntu-branches/ubuntu/natty/mysql-5.1/natty-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 08:30:45 UTC
  • mfrom: (1.4.1)
  • Revision ID: package-import@ubuntu.com-20120222083045-2rd53r4bnyx7qus4
Tags: 5.1.61-0ubuntu0.11.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

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/29/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" "11/29/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 \{\
84
102
.sp -1
85
103
.IP \(bu 2.3
86
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
.\}
87
166
.\" ndb_config: version option
88
167
.\" version option: ndb_config
89
168
\fB\-\-version\fR,
95
174
T{
96
175
\fBCommand\-Line Format\fR
97
176
T}:T{
 
177
\-\-version
 
178
T}
 
179
T{
 
180
T}:T{
98
181
\-V
99
182
T}
100
 
T{
101
 
T}:T{
102
 
\-\-version
103
 
T}
104
183
.TE
105
184
.sp 1
106
185
Causes
119
198
.\" ndb_config: ndb-connectstring option
120
199
.\" ndb-connectstring option: ndb_config
121
200
\fB\-\-ndb\-connectstring=\fR\fB\fIconnect_string\fR\fR
122
 
.TS
123
 
allbox tab(:);
124
 
l l s s
125
 
l l s s
126
 
l l s s
127
 
l l s s
128
 
^ l l s
129
 
^ l l s.
130
 
T{
131
 
\fBCommand\-Line Format\fR
132
 
T}:T{
133
 
\-\-ndb\-connectstring=name
134
 
T}
135
 
T{
136
 
T}:T{
137
 
\-\-connect\-string=name
138
 
T}
139
 
T{
140
 
T}:T{
141
 
\-c
142
 
T}
143
 
T{
144
 
\ \&
145
 
T}:T{
146
 
\fBPermitted Values \fR
147
 
T}
148
 
:T{
149
 
\fBType\fR
150
 
T}:T{
151
 
string
152
 
T}
153
 
:T{
154
 
\fBDefault\fR
155
 
T}:T{
156
 
localhost:1186
157
 
T}
158
 
.TE
159
 
.sp 1
 
201
.sp
160
202
Specifies the connectstring to use in connecting to the management server\&. The format for the connectstring is the same as described in
161
 
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
162
204
localhost:1186\&.
163
205
.sp
164
206
The use of
179
221
.\" ndb_config: config-file option
180
222
.\" config-file option: ndb_config
181
223
\fB\-\-config\-file=\fR\fB\fIpath\-to\-file\fR\fR
182
 
.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
183
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
184
252
\fBndb_config\fR
185
253
is invoked, then an absolute path must be used\&.
193
261
.sp -1
194
262
.IP \(bu 2.3
195
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
.\}
196
308
.\" ndb_config: query option
197
309
.\" query option: ndb_config
198
310
\fB\-\-query=\fR\fB\fIquery\-options\fR\fR,
344
456
.\}
345
457
.\" ndb_config: id option
346
458
.\" id option: ndb_config
347
 
\fB\-\-id=\fR\fB\fInode_id\fR\fR,
 
459
\fB\-\-id=\fR\fB\fInode_id\fR\fR
348
460
.sp
349
461
.\" ndb_config: nodeid option
350
462
.\" nodeid option: ndb_config
397
509
Tells
398
510
\fBndb_config\fR
399
511
to print information from parameters defined in
400
 
[ndbd]
401
 
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
402
 
[tcp]
403
 
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\&.
404
624
.RE
405
625
.sp
406
626
.RS 4
443
663
:T{
444
664
\fBValid Values\fR
445
665
T}:T{
446
 
ndbd, mysqld, ndb_mgmd
 
666
ndbd
 
667
.sp
 
668
mysqld
 
669
.sp
 
670
ndb_mgmd
447
671
T}
448
672
.TE
449
673
.sp 1
726
950
T{
727
951
\fBVersion Introduced\fR
728
952
T}:T{
729
 
5\&.1\&.34\-ndb\-7\&.0\&.6
 
953
5\&.1\&.34\-ndb\-6\&.3\&.25, 5\&.1\&.34\-ndb\-7\&.0\&.6
730
954
T}
731
955
T{
732
956
\fBCommand\-Line Format\fR
1052
1276
.SH "COPYRIGHT"
1053
1277
.br
1054
1278
.PP
1055
 
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.
1056
1280
.PP
1057
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.
1058
1282
.PP