Author: jstephens
Date: 2009-12-16 12:32:23 +0100 (Wed, 16 Dec 2009)
New Revision: 18256
Log:
Fixes Docs Bug #48853 (Thanks, Frazer and Jonas!)
Modified:
trunk/dynamic-docs/command-optvars/ndb-config-params.xml
trunk/refman-5.1/mysql-cluster-configuration-core.xml
Modified: trunk/dynamic-docs/command-optvars/ndb-config-params.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/ndb-config-params.xml 2009-12-16 11:21:07 UTC (rev 18255)
+++ trunk/dynamic-docs/command-optvars/ndb-config-params.xml 2009-12-16 11:32:23 UTC (rev 18256)
Changed blocks: 4, Lines Added: 4, Lines Deleted: 9; 1566 bytes
@@ -3227,8 +3227,6 @@
</mysqloption>
-<!-- !LONGDESCRIPTION -->
-
<mysqloption id="overloadlimit-sci" section="cluster" subsection="sci">
<xrefto id="ndbparam-sci-overloadlimit"/>
@@ -3253,8 +3251,6 @@
</mysqloption>
-<!-- !LONGDESCRIPTION -->
-
<mysqloption id="overloadlimit-shm" section="cluster" subsection="shm">
<xrefto id="ndbparam-shm-overloadlimit"/>
@@ -3279,8 +3275,6 @@
</mysqloption>
-<!-- !LONGDESCRIPTION -->
-
<mysqloption id="overloadlimit-tcp" section="cluster" subsection="tcp">
<xrefto id="ndbparam-tcp-overloadlimit"/>
@@ -3579,9 +3573,10 @@
<name>ReservedSendBufferMemory</name>
<shortdescription>
- Amount of memory in bytes (out of TotalSendBufferMemory) to
- reserve for connections between data nodes. This memory is not
- available for connections to management servers or API nodes.
+ This parameter is present in NDBCLUSTER code and is intended to
+ reserve memory from TotalSendBufferMemory for connections between
+ data nodes (but not for connections from data nodes to management
+ servers or API nodes). It is currently not enabled.
</shortdescription>
<values vartype="numeric" platform="all" units="bytes" inversion="5.1.30-ndb-6.4.0">
Modified: trunk/refman-5.1/mysql-cluster-configuration-core.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-configuration-core.xml 2009-12-16 11:21:07 UTC (rev 18255)
+++ trunk/refman-5.1/mysql-cluster-configuration-core.xml 2009-12-16 11:32:23 UTC (rev 18256)
Changed blocks: 6, Lines Added: 91, Lines Deleted: 65; 9198 bytes
@@ -6597,8 +6597,7 @@
configuration parameters were added in MySQL Cluster NDB 6.4.0
to permit the setting of limits on this memory allocation;
this change is reflected by the addition of the configuration
- parameters <literal>TotalSendBufferMemory</literal>,
- <literal>ReservedSendBufferMemory</literal>, and
+ parameters <literal>TotalSendBufferMemory</literal> and
<literal>OverLoadLimit</literal>, as well as a change in how
the existing <literal>SendBufferMemory</literal> configuration
parameter is used. For more information, see
@@ -6642,29 +6641,45 @@
</para>
<para>
- This optional parameter is available beginning with MySQL
- Cluster NDB 6.4.0. If set, it reserves an amount of memory
+ This parameter is present in
+ <literal role="se">NDBCLUSTER</literal> source code
+ beginning with MySQL Cluster NDB 6.4.0. However, it is not
+ currently enabled.
+
+ <remark role="note">
+ [js] Following commented out until this parameter is
+ actually enabled.
+ </remark>
+
+<!--
+ If set, it reserves an amount of memory
(in bytes) for connections between data nodes, and that
cannot be allocated for send buffers to be used for
management or API nodes. This helps prevent API nodes from
using excess send buffer memory and thereby causing
communications failures in the NDB kernel.
+-->
</para>
+<!--
<para>
If this parameter is set, its minimum allowed value is 256K;
the maxmimum is 4294967039.
</para>
+-->
</listitem>
</itemizedlist>
<para>
For more detailed information about the behavior and use of
- <literal>TotalSendBufferMemory</literal> and
- <literal>ReservedSendBufferMemory</literal>, and about
- configuring send buffer memory parameters in MySQL Cluster NDB
- 6.4.0 and later, see
+ <literal>TotalSendBufferMemory</literal>
+
+<!--and
+ <literal>ReservedSendBufferMemory</literal>,-->
+
+ and about configuring send buffer memory parameters in MySQL
+ Cluster NDB 6.4.0 and later, see
<xref linkend="mysql-cluster-config-send-buffers"/>.
</para>
@@ -8135,34 +8150,36 @@
transporters, plus an additional 32KB (one page) per
transporter. The maximum depends on the type of transporter,
as shown in the following table:
+ </para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="30*"/>
- <colspec colwidth="70*"/>
- <thead>
- <row>
- <entry>Transporter</entry>
- <entry>Maxmimum Send Buffer Size (bytes)</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>TCP</entry>
- <entry><literal>SendBufferMemory</literal> (default = 2M)</entry>
- </row>
- <row>
- <entry>SCI</entry>
- <entry><literal>SendLimit</literal> (default = 8K) plus 16K</entry>
- </row>
- <row>
- <entry>SHM</entry>
- <entry>20K</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="30*"/>
+ <colspec colwidth="70*"/>
+ <thead>
+ <row>
+ <entry>Transporter</entry>
+ <entry>Maxmimum Send Buffer Size (bytes)</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>TCP</entry>
+ <entry><literal>SendBufferMemory</literal> (default = 2M)</entry>
+ </row>
+ <row>
+ <entry>SCI</entry>
+ <entry><literal>SendLimit</literal> (default = 8K) plus 16K</entry>
+ </row>
+ <row>
+ <entry>SHM</entry>
+ <entry>20K</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
This allows existing configurations to function in close to
the same way as they did with MySQL Cluster NDB 6.3 and
earlier, with the same amount of memory and send buffer
@@ -8175,26 +8192,6 @@
<listitem>
<formalpara>
- <title><literal>ReservedSendBufferMemory</literal></title>
-
- <para>
- This optional data node parameter, if set, gives an amount
- of memory (in bytes) that is reserved for connections
- between data nodes; this memory is not allocated to send
- buffers used for communications with management servers or
- API nodes. This provides a way to protect the cluster
- against misbehaving API nodes that use excess send memory
- and thus cause failures in communications internally in
- the NDB kernel. If set, its the minimum permitted value
- for this parameters is 256K; the maximum is 4294967039.
- </para>
-
- </formalpara>
- </listitem>
-
- <listitem>
- <formalpara>
-
<title><literal>OverloadLimit</literal></title>
<para>
@@ -8207,8 +8204,10 @@
affect the overloaded connection fail with NDB API Error
1218 (<errortext>Send Buffers overloaded in NDB
kernel</errortext>) until the overload status passes. The
- default value is 0; there is no defined maximum value for
- this parameter.
+ default value is 0, in which case the effective overload
+ limit is calculated as <literal>SendBufferMemory *
+ 0.8</literal> for a given connection. The maximum value
+ for this parameter is 4G.
</para>
</formalpara>
@@ -8224,20 +8223,47 @@
configuration parameter represented the amount of memory
allocated at startup for each configured TCP connection.
Beginning with MySQL Cluster NDB 7.0, this value denotes a
- hard limit for how much memory (out of the total available
- — that is, <literal>TotalSendBufferMemory</literal>)
- that may be used by a single transporter. However, the sum
- of <literal>TotalSendBufferMemory</literal> for all
- configured transporters may be greater than
- <literal>SendBufferMemory</literal>. This is a way to save
- memory when many nodes are in use, as long as the maximum
- amount of memory is never required by all transporters at
- the same time.
+ hard limit for the amount of memory that may be used by a
+ single transporter out of the entire pool specified by
+ <literal>TotalSendBufferMemory</literal>. However, the sum
+ of <literal>SendBufferMemory</literal> for all configured
+ transporters may be greater than the
+ <literal>TotalSendBufferMemory</literal> that is set for a
+ given node. This is a way to save memory when many nodes
+ are in use, as long as the maximum amount of memory is
+ never required by all transporters at the same time.
</para>
</formalpara>
+
+ <remark role="note">
+ [js] Next listitem commented until ReservedSendBufferMemory
+ is actually enabled.
+ </remark>
</listitem>
+<!--
+ <listitem>
+ <formalpara>
+
+ <title><literal>ReservedSendBufferMemory</literal></title>
+
+ <para>
+ This optional data node parameter, if set, gives an amount
+ of memory (in bytes) that is reserved for connections
+ between data nodes; this memory is not allocated to send
+ buffers used for communications with management servers or
+ API nodes. This provides a way to protect the cluster
+ against misbehaving API nodes that use excess send memory
+ and thus cause failures in communications internally in
+ the NDB kernel. If set, its the minimum permitted value
+ for this parameters is 256K; the maximum is 4294967039.
+ </para>
+
+ </formalpara>
+ </listitem>
+-->
+
</itemizedlist>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r18256 - in trunk: dynamic-docs/command-optvars refman-5.1 | jon.stephens | 16 Dec |
