Author: mcbrown
Date: 2007-07-23 12:55:40 +0200 (Mon, 23 Jul 2007)
New Revision: 7178
Log:
Updating Falcon config parameters (thanks Calvin, Ann)
Reorganizing the config parameter list
Adding sample variables
Modified:
trunk/falcon/se-falcon.xml
Modified: trunk/falcon/se-falcon.xml
===================================================================
--- trunk/falcon/se-falcon.xml 2007-07-23 10:16:00 UTC (rev 7177)
+++ trunk/falcon/se-falcon.xml 2007-07-23 10:55:40 UTC (rev 7178)
Changed blocks: 4, Lines Added: 164, Lines Deleted: 127; 12204 bytes
@@ -29,45 +29,109 @@
<literal>gb</literal>.
</para>
- <itemizedlist>
+ <para>
+ You can obtain a list of variables relevant to Falcon using
+ <literal>SHOW VARIABLES</literal>:
+ </para>
-<!--
-<listitem>
- <para>
- <literal>falcon_page_size</literal> — (Page Size)
- controls the size of the pages used to store information
- within the tablespace. Valid sizes are 1, 2, 4, 8, 16 and 32
- KB.
- </para>
- </listitem>
--->
+<programlisting>mysql> show variables like "%falcon%";
++--------------------------------+----------+
+| Variable_name | Value |
++--------------------------------+----------+
+| falcon_debug_mask | 0 |
+| falcon_debug_server | OFF |
+| falcon_index_chill_threshold | 4 |
+| falcon_max_record_memory | 20971520 |
+| falcon_max_transaction_backlog | 10000 |
+| falcon_min_record_memory | 0 |
+| falcon_page_cache_size | 4194304 |
+| falcon_page_size | 4096 |
+| falcon_record_chill_threshold | 5 |
+| falcon_serial_log_buffers | 10 |
+| falcon_serial_log_dir | |
+| have_falcon | YES |
++--------------------------------+----------+
+12 rows in set (0.01 sec)</programlisting>
- <listitem>
- <para>
- <literal>falcon_min_record_memory</literal> — (Record
- Cache Base) sets the minimum amount of memory that will be
- allocated for caching record data. When cache memory is
- scavenged, the process will stop when the cache usage reaches
- this value.
- </para>
+ <itemizedlist>
- <para>
- The default is <literal>falcon_max_record_memory</literal>/2
- (10MB).
- </para>
- </listitem>
-
<listitem>
<para>
- <literal>falcon_log_windows</literal> — the number of
- memory windows allocated for the Falcon serial log. Each
- window is 1 MByte in size.
+ <literal>falcon_debug_mask</literal> — (formerly
+ <literal>falcon_log_mask</literal>) sets the log information
+ that is output to the standard output of
+ <command>mysqld</command> in the event of an error. The value
+ is a bit mask; you must combine values to enables different
+ combinations of error message types. The supported values are:
</para>
- <para>
- The minimum accepted value is 10, the maximum is 32768 and the
- default value is 10.
- </para>
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colwidth="10*"/>
+ <colspec colwidth="20*"/>
+ <colspec colwidth="70*"/>
+ <thead>
+ <row>
+ <entry>Value</entry>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>1</entry>
+ <entry>LogLog</entry>
+ <entry>Outputs minor errors, index, record and other faults.</entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>LogDebug</entry>
+ <entry>Outputs detailed status and progress information for the purposes of
+ debugging errors.</entry>
+ </row>
+ <row>
+ <entry>4</entry>
+ <entry>LogInfo</entry>
+ <entry>Generates general information and status messages</entry>
+ </row>
+ <row>
+ <entry>8</entry>
+ <entry>Unused</entry>
+ <entry>Currently unused.</entry>
+ </row>
+ <row>
+ <entry>16</entry>
+ <entry>Unused</entry>
+ <entry>Currently unused.</entry>
+ </row>
+ <row>
+ <entry>32</entry>
+ <entry>LogGG</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>64</entry>
+ <entry>LogPanic</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>128</entry>
+ <entry>LogScrub</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>256</entry>
+ <entry>LogException</entry>
+ <entry>Logs exceptions and SQL errors.</entry>
+ </row>
+ <row>
+ <entry>512</entry>
+ <entry>LogScavenge</entry>
+ <entry>Reports record scavenger statistics.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</listitem>
<listitem>
@@ -96,33 +160,38 @@
<listitem>
<para>
- <literal>falcon_record_chill_threshold</literal> — the
- number of Mbytes of pending record data that Falcon will keep
- in memory during a large transaction before flushing these
- records to the serial log. This flushing is called chilling
- since it makes the data not immediately available. If chilled
- records are accessed again during the transaction, they are
- immediately restored (thawed) from the serial log. Chilling
- pending records helps Falcon to accomplish very large
- transactions without running out of memory.
+ <literal>falcon_max_record_memory</literal> — sets the
+ maximum amount of memory that will be allocated for caching
+ record data.
</para>
<para>
- The minimum accepted value is 1, the maximum is 1024 and the
- default value is 5.
+ The default is 20MB.
</para>
</listitem>
<listitem>
<para>
- <literal>falcon_max_record_memory</literal> — (Record
- Cache Top) sets the maximum size of memory that will be
- allocated for caching record data.
+ <literal>falcon_max_transaction_backlog</literal> — the
+ maximum number of pending transactions that will be active
+ before the update process is blocked until the number of
+ pending transactions reduces.
</para>
+ </listitem>
+ <listitem>
<para>
- The default value is 20MB.
+ <literal>falcon_min_record_memory</literal> — (Record
+ Cache Base) sets the minimum amount of memory that will be
+ allocated for caching record data. When cache memory is
+ scavenged, the process will stop when the cache usage reaches
+ this value.
</para>
+
+ <para>
+ The default is <literal>falcon_max_record_memory</literal>/2
+ (10MB).
+ </para>
</listitem>
<listitem>
@@ -139,77 +208,58 @@
<listitem>
<para>
- <literal>falcon_log_mask</literal> — sets the log
- information that is output to the standard output of
- <command>mysqld</command> in the event of an error. The value
- is a bit mask; you must combine values to enables different
- combinations of error message types. The supported values are:
+ <literal>falcon_page_size</literal> — (Page Size)
+ controls the size of the pages used to store information
+ within the tablespace. Valid sizes are 1, 2, 4, 8, 16 and 32
+ KB.
</para>
+ </listitem>
- <informaltable>
- <thead>
- <row>
- <entry>Value</entry>
- <entry>Name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>1</entry>
- <entry>LogLog</entry>
- <entry>Outputs minor errors, index, record and other faults.</entry>
- </row>
- <row>
- <entry>2</entry>
- <entry>LogDebug</entry>
- <entry>Outputs detailed status and progress information for the purposes of
- debugging errors.</entry>
- </row>
- <row>
- <entry>4</entry>
- <entry>LogInfo</entry>
- <entry>Generates general information and status messages</entry>
- </row>
- <row>
- <entry>8</entry>
- <entry>Unused</entry>
- <entry>Currently unused.</entry>
- </row>
- <row>
- <entry>16</entry>
- <entry>Unused</entry>
- <entry>Currently unused.</entry>
- </row>
- <row>
- <entry>32</entry>
- <entry>LogGG</entry>
- <entry></entry>
- </row>
- <row>
- <entry>64</entry>
- <entry>LogPanic</entry>
- <entry></entry>
- </row>
- <row>
- <entry>128</entry>
- <entry>LogScrub</entry>
- <entry></entry>
- </row>
- <row>
- <entry>256</entry>
- <entry>LogException</entry>
- <entry>Logs exceptions and SQL errors.</entry>
- </row>
- <row>
- <entry>512</entry>
- <entry>LogScavenge</entry>
- <entry>Reports record scavenger statistics.</entry>
- </row>
- </tbody>
- </informaltable>
+ <listitem>
+ <para>
+ <literal>falcon_record_chill_threshold</literal> — the
+ number of Mbytes of pending record data that Falcon will keep
+ in memory during a large transaction before flushing these
+ records to the serial log. This flushing is called chilling
+ since it makes the data not immediately available. If chilled
+ records are accessed again during the transaction, they are
+ immediately restored (thawed) from the serial log. Chilling
+ pending records helps Falcon to accomplish very large
+ transactions without running out of memory.
+ </para>
+
+ <para>
+ The minimum accepted value is 1, the maximum is 1024 and the
+ default value is 5.
+ </para>
</listitem>
+ <listitem>
+ <para>
+ <literal>falcon_serial_log_buffers</literal> — the
+ number of memory windows allocated for the Falcon serial log.
+ Each window is 1 MByte in size. Formerly
+ <literal>falcon_log_windows</literal>.
+ </para>
+
+ <para>
+ The minimum accepted value is 10, the maximum is 32768 and the
+ default value is 10.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>falcon_serial_log_dir</literal> — (Log file
+ location) sets the directory for storing the serial log. The
+ filenames used by the serial log (two files are create for
+ storing serial data) are allocated according to the name of
+ the tablespace. The default location is in the same directory
+ as the tablespace file. Formerly
+ <literal>falcon_log_dir</literal>.
+ </para>
+ </listitem>
+
<!--
<remark>
[MC] Not currently implemented
@@ -224,19 +274,6 @@
</para>
</listitem>-->
-<!--[MC] Not supported in alpha release
- <listitem>
- <para>
- <literal>falcon_log_dir</literal> — (Log file location)
- sets the directory for storing the serial log. The filenames
- used by the serial log (two files are create for storing
- serial data) are allocated according to the name of the
- tablespace. The default location is in the same directory as
- the tablespace file.
- </para>
- </listitem>
--->
-
<!--
<remark>
[MC] Not currently implemented
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7178 - trunk/falcon | mcbrown | 24 Jul |
