Author: jstephens
Date: 2009-05-13 10:10:27 +0200 (Wed, 13 May 2009)
New Revision: 14897
Log:
Documented new --configinfo and --xml options for ndb_config
(WL #4778)
Modified:
trunk/dynamic-docs/changelog/mysqld-1.xml
trunk/dynamic-docs/command-optvars/ndb_config.xml
trunk/refman-5.1/mysql-cluster-programs-core.xml
trunk/refman-5.1/mysql-cluster-roadmap.xml
Modified: trunk/dynamic-docs/changelog/mysqld-1.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld-1.xml 2009-05-13 07:23:28 UTC (rev 14896)
+++ trunk/dynamic-docs/changelog/mysqld-1.xml 2009-05-13 08:10:27 UTC (rev 14897)
Changed blocks: 1, Lines Added: 31, Lines Deleted: 0; 1331 bytes
@@ -6,6 +6,37 @@
]>
<changelog>
+ <logentry entrytype="feature">
+
+ <tags>
+ <highlight type="cluster"/>
+ <manual type="ndb_config"/>
+ </tags>
+
+ <versions>
+ <version ver="5.1.34-ndb-6.3.25"/>
+ <version ver="5.1.34-ndb-7.0.6"/>
+ </versions>
+
+ <message>
+
+ <para>
+ The <command>ndb_config</command> utility program can now
+ provide an offline dump of all MySQL Cluster configuration
+ parameters including information such as default and permitted
+ values, brief description, and applicable section of the
+ <filename>config.ini</filename> file. A dump in text format is
+ produced when running <command>ndb_config</command> with the new
+ <option>--configinfo</option> option, and in XML format when the
+ options <option>--configinfo --xml</option> are used together.
+ For more information and examples, see
+ <xref linkend="mysql-cluster-programs-ndb-config"/>.
+ </para>
+
+ </message>
+
+ </logentry>
+
<logentry entrytype="bug">
<tags>
Modified: trunk/dynamic-docs/command-optvars/ndb_config.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb_config.xml 2009-05-13 07:23:28 UTC (rev 14896)
+++ trunk/dynamic-docs/command-optvars/ndb_config.xml 2009-05-13 08:10:27 UTC (rev 14897)
Changed blocks: 2, Lines Added: 57, Lines Deleted: 1; 1831 bytes
@@ -269,7 +269,7 @@
<mysqloption id="opt_ndb_config_c">
- <!--
+<!--
<xrefto id="option_ndb-connectstring"/>
-->
@@ -296,4 +296,60 @@
</mysqloption>
+ <mysqloption id="configinfo">
+
+ <xrefto id="option_ndb_config-configinfo"/>
+
+ <name>configinfo</name>
+
+ <shortdescription lang="en">
+ Dumps information about all NDB configuration parameters in text
+ format with default, maximum, and minimum values. Use with --xml
+ to obtain XML output.
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--configinfo"/>
+ </types>
+
+ <values vartype="boolean" platform="all">
+ <value default="false"/>
+ </values>
+
+ <versions>
+ <manual version="5.1"/>
+ <introduced version="5.1.34-ndb-6.3.25"/>
+ <introduced version="5.1.34-ndb-7.0.6"/>
+ </versions>
+
+ </mysqloption>
+
+ <mysqloption id="xml">
+
+ <xrefto id="option_ndb_config-configinfo"/>
+
+ <name>xml</name>
+
+ <shortdescription lang="en">
+ Use with --configinfo to obtain a dump of all NDB configuration
+ parameters in XML format with default, maximum, and minimum
+ values.
+ </shortdescription>
+
+ <types>
+ <optype class="cmdline" format="--configinfo --xml"/>
+ </types>
+
+ <values vartype="boolean" platform="all">
+ <value default="false"/>
+ </values>
+
+ <versions>
+ <manual version="5.1"/>
+ <introduced version="5.1.34-ndb-6.3.25"/>
+ <introduced version="5.1.34-ndb-7.0.6"/>
+ </versions>
+
+ </mysqloption>
+
</mysqloptions>
Modified: trunk/refman-5.1/mysql-cluster-programs-core.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-programs-core.xml 2009-05-13 07:23:28 UTC (rev 14896)
+++ trunk/refman-5.1/mysql-cluster-programs-core.xml 2009-05-13 08:10:27 UTC (rev 14897)
Changed blocks: 2, Lines Added: 206, Lines Deleted: 3; 8477 bytes
@@ -2040,9 +2040,16 @@
<title>Description</title>
<para>
- This tool extracts configuration information for data nodes,
- SQL nodes, and API nodes from a cluster management node (and
- possibly its <filename>config.ini</filename> file).
+ This tool extracts current configuration information for data
+ nodes, SQL nodes, and API nodes from a cluster management node
+ (and possibly its <filename>config.ini</filename> 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
+ <option>--configinfo</option> and <option>--xml</option>
+ options later in this section).
</para>
<para>
@@ -2409,6 +2416,202 @@
</note>
</listitem>
+ <listitem>
+ <para id="option_ndb_config-configinfo">
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>configinfo option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>ndb_config</primary>
+ <secondary>xml option</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>configinfo option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
+
+ <indexterm>
+ <primary>xml option</primary>
+ <secondary>ndb_config</secondary>
+ </indexterm>
+
+ <option>--configinfo</option> [<option>--xml</option>]
+ </para>
+
+ <para condition="dynamic:optvar:item" role="5.1:ndb_config:configinfo"/>
+
+ <para condition="dynamic:optvar:item" role="5.1:ndb_config:xml"/>
+
+ <para>
+ The <option>--configinfo</option> option, added in MySQL
+ Cluster NDB 6.3.25 and MySQL Cluster NDB 7.0.6, causes
+ <command>ndb_config</command> to dump a list of each MySQL
+ Cluster configuration parameter supported by the MySQL
+ Cluster distribution of which
+ <command>ndb_config</command> is a part, including the
+ following information:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ A brief description of each parameter's purpose,
+ effects, and usage
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The section of the <filename>config.ini</filename>
+ file where the parameter may be used
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The parameter's data type or unit of measurement
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Where applicable, the parameter's default,
+ minimum, and maximum values
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A brief description of the parameter's purpose,
+ effects, and usage
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ MySQL Cluster release version and build information
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ By default, this output is in text format. Part of this
+ output is shown here:
+ </para>
+
+<programlisting>
+shell> <userinput>ndb_config --configinfo</userinput>
+
+****** SYSTEM ******
+
+Name (String)
+Name of system (NDB Cluster)
+MANDATORY
+
+PrimaryMGMNode (Non-negative Integer)
+Node id of Primary ndb_mgmd(MGM) node
+Default: 0 (Min: 0, Max: 4294967039)
+
+ConfigGenerationNumber (Non-negative Integer)
+Configuration generation number
+Default: 0 (Min: 0, Max: 4294967039)
+
+****** DB ******
+
+MaxNoOfSubscriptions (Non-negative Integer)
+Max no of subscriptions (default 0 == MaxNoOfTables)
+Default: 0 (Min: 0, Max: 4294967039)
+
+MaxNoOfSubscribers (Non-negative Integer)
+Max no of subscribers (default 0 == 2 * MaxNoOfTables)
+Default: 0 (Min: 0, Max: 4294967039)
+
+…
+</programlisting>
+
+ <para>
+ You can obtain the output as XML by using the
+ <option>--xml</option> option (also available beginning
+ with MySQL Cluster NDB 6.3.25 and MySQL Cluster NDB 7.0.6)
+ in addition to <option>--configinfo</option>. A portion of
+ the resulting output is shown in this example:
+ </para>
+
+<programlisting>
+shell> <userinput>ndb_config --configinfo --xml</userinput>
+
+<configvariables protocolversion="1" ndbversionstring="mysql-5.1.34 ndb-7.0.6"
+ ndbversion="458758" ndbversionmajor="7" ndbversionminor="0"
+ ndbversionbuild="6">
+ <section name="SYSTEM">
+ <param name="Name" comment="Name of system (NDB Cluster)" type="string"
+ mandatory="true"/>
+ <param name="PrimaryMGMNode" comment="Node id of Primary ndb_mgmd(MGM) node"
+ type="unsigned" default="0" min="0" max="4294967039"/>
+ <param name="ConfigGenerationNumber" comment="Configuration generation number"
+ type="unsigned" default="0" min="0" max="4294967039"/>
+ </section>
+ <section name="NDBD">
+ <param name="MaxNoOfSubscriptions" comment="Max no of subscriptions (default 0 == MaxNoOfTables)"
+ type="unsigned" default="0" min="0" max="4294967039"/>
+ <param name="MaxNoOfSubscribers" comment="Max no of subscribers (default 0 == 2 * MaxNoOfTables)"
+ type="unsigned" default="0" min="0" max="4294967039"/>
+
+ …
+
+ </section>
+
+ …
+
+</configvariables>
+</programlisting>
+
+ <important>
+ <para>
+ The <option>--xml</option> option can be used only with
+ the <option>--configinfo</option> option. Using
+ <option>--xml</option> without
+ <option>--configinfo</option> fails with an error.
+ </para>
+ </important>
+
+ <para>
+ Unlike the options used with this program to obtain
+ current configuration data, <option>--configinfo</option>
+ and <option>--xml</option> use information obtained from
+ the MySQL Cluster sources when
+ <command>ndb_config</command> was compiled. For this
+ reason, no connection to a running MySQL Cluster or access
+ to a <filename>config.ini</filename> or
+ <filename>my.cnf</filename> file is required for these two
+ options.
+ </para>
+
+ <para>
+ Combining other <command>ndb_config</command> options
+ (such as <option>--query</option> or
+ <option>--type</option>) with
+ <option>--configinfo</option> or <option>--xml</option> is
+ not supported. If you attempt to do so, the usual
+ (current) result is that all other options besides
+ <option>--configinfo</option> or <option>--xml</option>
+ are simply ignored. However, this behavior is not
+ guaranteed and is subject to change at any time. In
+ addition, since <command>ndb_config</command> when used
+ with the <option>--configinfo</option> option does not
+ access the MySQL Cluster or read any files, trying to
+ specify additional options such as
+ <option>--ndb-connectstring</option> or
+ <option>--config-file</option> with
+ <option>--configinfo</option> serves no purpose.
+ </para>
+ </listitem>
+
</itemizedlist>
<para>
Modified: trunk/refman-5.1/mysql-cluster-roadmap.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-roadmap.xml 2009-05-13 07:23:28 UTC (rev 14896)
+++ trunk/refman-5.1/mysql-cluster-roadmap.xml 2009-05-13 08:10:27 UTC (rev 14897)
Changed blocks: 2, Lines Added: 56, Lines Deleted: 0; 2961 bytes
@@ -1509,6 +1509,34 @@
</formalpara>
</listitem>
+ <listitem>
+ <formalpara>
+
+ <title>Configuration parameter data dumps</title>
+
+ <para>
+ Starting with MySQL Cluster NDB 6.3.25, the
+ <command>ndb_config</command> utility supports a
+ <option>--configinfo</option> option that causes it to
+ dump a list of all configuration parameters supported by
+ the cluster, along with brief descriptions, information
+ about the parameters' default and allowed values, and
+ the sections of the <filename>config.ini</filename> file
+ in which the parameters apply. An additional
+ <option>--xml</option> switch causes
+ <command>ndb_config</command> to use XML rather than
+ plaintext output. Using <command>ndb_config
+ <option>--configinfo</option></command> or
+ <command>ndb_config <option>--configinfo
+ --xml</option></command> requires no access to a running
+ MySQL Cluster, any other programs, or any files. For more
+ information and examples, see
+ <xref linkend="mysql-cluster-programs-ndb-config"/>.
+ </para>
+
+ </formalpara>
+ </listitem>
+
</itemizedlist>
</para>
@@ -1876,6 +1904,34 @@
</para>
</listitem>
+ <listitem>
+ <formalpara>
+
+ <title>Configuration parameter data dumps</title>
+
+ <para>
+ Starting with MySQL Cluster NDB 7.0.6, the
+ <command>ndb_config</command> utility supports a
+ <option>--configinfo</option> option that causes it to dump
+ a list of all configuration parameters supported by the
+ cluster, along with brief descriptions, information about
+ the parameters' default and allowed values, and the
+ sections of the <filename>config.ini</filename> file in
+ which the parameters apply. An additional
+ <option>--xml</option> switch causes
+ <command>ndb_config</command> to use XML rather than
+ plaintext output. Using <command>ndb_config
+ <option>--configinfo</option></command> or
+ <command>ndb_config <option>--configinfo
+ --xml</option></command> requires no access to a running
+ MySQL Cluster, any other programs, or any files. For more
+ information and examples, see
+ <xref linkend="mysql-cluster-programs-ndb-config"/>.
+ </para>
+
+ </formalpara>
+ </listitem>
+
</itemizedlist>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r14897 - in trunk: dynamic-docs/changelog dynamic-docs/command-optvars refman-5.1 | jon.stephens | 13 May |
