svn commit - mysqldoc@docsrva: r3883 - trunk/refman-5.1

[mcbrown]

Author: mcbrown
Date: 2006-11-08 17:00:47 +0100 (Wed, 08 Nov 2006)
New Revision: 3883

Log:
Added Falcon to the SE chapter
Added warnings about Falcon fork and location 



Modified:
   trunk/refman-5.1/se-falcon.xml
   trunk/refman-5.1/storage-engines.xml


Modified: trunk/refman-5.1/se-falcon.xml
===================================================================
--- trunk/refman-5.1/se-falcon.xml	2006-11-08 15:14:42 UTC (rev 3882)
+++ trunk/refman-5.1/se-falcon.xml	2006-11-08 16:00:47 UTC (rev 3883)
Changed blocks: 11, Lines Added: 47, Lines Deleted: 37; 7702 bytes

@@ -11,7 +11,7 @@
 ]>
 <section id="se-falcon">
 
-  <title>Falcon Storage Engine</title>
+  <title>The Falcon Storage Engine</title>
 
   <para>
     The Falcon Storage Engine has been designed with modern database

@@ -24,8 +24,18 @@
   <warning>
     <para>
       Falcon is currently an Alpha release and should not be used in
-      production environments.
+      production environments. Falcon is currently only supported within
+      a fork of the MySQL 5.1 release tree and is not considered ready
+      for production. It is provided only for testing and evaluation
+      purposes. It is included in the 5.1 manual because it is
+      compatible with features and functionality within the MySQL 5.1
+      server.
     </para>
+
+    <para>
+      Note that the Falcon 5.1 fork may not include all feature or bug
+      fixes that are applied to the main MySQL 5.1 tree.
+    </para>
   </warning>
 
   <para>

@@ -166,36 +176,37 @@
 
       <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.
+          <literal>falcon_page_size</literal> &mdash; (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>
 
       <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. The
-          default is <literal>falcon_max_record_memory</literal>/2
-          (10MB).
+          <literal>falcon_min_record_memory</literal> &mdash; (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. The default is
+          <literal>falcon_max_record_memory</literal>/2 (10MB).
         </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. The default is 20MB.
+          <literal>falcon_max_record_memory</literal> &mdash; (Record
+          Cache Top) sets the maximum size of memory that will be
+          allocated for caching record data. The default is 20MB.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          <literal>falcon_page_cache_size</literal> (Page Cache Size)
-          sets the amount of memory that will be allocated for caching
-          pages from the tablespace file. The default is 4MB.
+          <literal>falcon_page_cache_size</literal> &mdash; (Page Cache
+          Size) sets the amount of memory that will be allocated for
+          caching pages from the tablespace file. The default is 4MB.
         </para>
       </listitem>
 

@@ -215,12 +226,12 @@
 
       <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.
+          <literal>falcon_log_dir</literal> &mdash; (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>
 

@@ -343,12 +354,11 @@
     </para>
 
     <para>
-      Table definitions are, as with with the other MySQL engines,
-      stored within a <literal>.frm</literal> file within a database
-      specific directory. For example, the table
-      <literal>falcontest</literal> within the
<literal>test</literal>
-      database will create the table definition file
-      <filename>falcontest.frm</filename>.
+      Table definitions are, as with the other MySQL engines, stored
+      within a <literal>.frm</literal> file within a database specific
+      directory. For example, the table <literal>falcontest</literal>
+      within the <literal>test</literal> database will create the table
+      definition file <filename>falcontest.frm</filename>.
     </para>
 
     <para>

@@ -377,7 +387,7 @@
 <programlisting>CREATE TABLE names (id INT, fname VARCHAR (20), lname VARCHAR (20))
ENGINE=Falcon</programlisting>
 
     <para>
-      Indexes can be created using all fothe standard methods; for
+      Indexes can be created using all of the standard methods; for
       example you can explicitly specify an index on a column:
     </para>
 

@@ -655,8 +665,8 @@
 
           <listitem>
             <para>
-              Whilte Transaction 1 commits are being written,
-              Transacations 2 and 3 write their log entries into the
+              While Transaction 1 commits are being written,
+              Transactions 2 and 3 write their log entries into the
               serial log.
             </para>
           </listitem>

@@ -666,8 +676,8 @@
               Once Transaction 1 has finished the physical write, either
               transaction 2 or 3 (but not both) will write out the
               unwritten portion of the in-memory log to disk. Because
-              both transacations have occurred since the last disk-write
-              of the serial log, the informaiton for both is written to
+              both transactions have occurred since the last disk-write
+              of the serial log, the information for both is written to
               the disk at the same time.
             </para>
           </listitem>

@@ -722,7 +732,7 @@
         <para>
           The above process works in tandem with the use of the two
           serial log files to ensure that the in-memory information and
-          on disk information are kiept up to date.
+          on disk information are kept up to date.
         </para>
 
       </section>

@@ -745,7 +755,7 @@
       <para>
         During crash recovery, Falcon examines the serial log and
         identifies the first entry that has not been committed to the
-        database. The recovery process wriutes all unwritten data,
+        database. The recovery process writes all unwritten data,
         changes index and blob data, releasing any necessary record
         slots (from deleted records) and committing any structural
         changes.

@@ -822,7 +832,7 @@
             versions of records that have been modified or deleted. This
             technique guarantees that active data needed to satisfy user
             requests is in memory, shortens row access time, and reduces
-            cache bloat by not including un-requested information. The
+            cache bloat by not including unrequested information. The
             record cache also assists in supporting the multi-version
             concurrency control (MVCC) mechanisms of the Falcon engine.
             The record cache is controlled by two parameters. The


Modified: trunk/refman-5.1/storage-engines.xml
===================================================================
--- trunk/refman-5.1/storage-engines.xml	2006-11-08 15:14:42 UTC (rev 3882)
+++ trunk/refman-5.1/storage-engines.xml	2006-11-08 16:00:47 UTC (rev 3883)
Changed blocks: 3, Lines Added: 18, Lines Deleted: 0; 1742 bytes

@@ -74,6 +74,10 @@
     <primary><literal>FEDERATED</literal> storage
engine</primary>
   </indexterm>
 
+  <indexterm>
+    <primary><literal>Falcon</literal> storage engine</primary>
+  </indexterm>
+  
   <para>
     MySQL supports several storage engines that act as handlers for
     different table types. MySQL storage engines include both those that

@@ -396,6 +400,18 @@
         </para>
       </listitem>
 
+      <listitem><para><link
linkend="se-falcon"><literal>Falcon</literal></link>
+      &mdash; Designed with high-volume transactional websites in mind, Falcon
+        works with multiple threads and a secure transaction environment that
+        keeps data safe while providing high throughput. </para>
+      
+     <para><emphasis role="bold">WARNING:</emphasis> Falcon is
currently only
+       supported within a fork ofthe MySQL 5.1 release tree and is not
+       considered ready for production. It is provided only testing and
+       evaluation purposes at this stage.</para>
+        
+      </listitem>
+      
       <listitem>
         <para>
           <link
linkend="memory-storage-engine"><literal>Memory</literal></link>

@@ -1017,6 +1033,8 @@
 
   <xi:include href="se-innodb.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
+  <xi:include href="se-falcon.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  
   <xi:include href="se-merge.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
   <xi:include href="se-memory.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>