Author: mcbrown
Date: 2008-02-13 15:58:46 +0100 (Wed, 13 Feb 2008)
New Revision: 9820
Log:
Some final edits from Maria team; reformat
Modified:
trunk/refman-5.1-maria/se-maria.xml
Modified: trunk/refman-5.1-maria/se-maria.xml
===================================================================
--- trunk/refman-5.1-maria/se-maria.xml 2008-02-13 13:35:03 UTC (rev 9819)
+++ trunk/refman-5.1-maria/se-maria.xml 2008-02-13 14:58:46 UTC (rev 9820)
Changed blocks: 16, Lines Added: 73, Lines Deleted: 46; 9842 bytes
@@ -95,8 +95,8 @@
<listitem>
<para>
<filename>maria_log_control</filename> — a control file
- that holds information about the current different log files in
- use.
+ that holds information about the current state of the
+ <literal>Maria</literal> engine.
</para>
<warning>
@@ -104,8 +104,10 @@
You should not delete the
<filename>maria_log_control</filename> file from an active
<literal>Maria</literal> installation as it records
- information about the log files and the default page block
- size used for the log and data files.
+ information about thec current state of the
+ <literal>Maria</literal> engine, including information about
+ the log files and the default page block size used for the log
+ and data files.
</para>
</warning>
</listitem>
@@ -127,8 +129,8 @@
corresponding data file. Transactional tables are crash safe and
data is written into the <literal>Maria</literal> log. For more
information on the log, see <xref linkend="se-maria-log"/>. Data
- from the log is then written to the data files as the statement
- completes.
+ which had already been written to the log is then apply to the
+ data and index files as the statement completes.
</para>
</listitem>
@@ -154,19 +156,19 @@
<listitem>
<para>
<literal>Maria</literal> provides a new row format,
- <literal>PAGE</literal> on transactional tables. For more
- information, see <xref linkend="se-maria-tableoptions"/>.
- Existing <literal>MyISAM</literal> row formats are also
- supported on non-transactional tables.
+ <literal>PAGE</literal>. For more information, see
+ <xref linkend="se-maria-tableoptions"/>. Existing
+ <literal>MyISAM</literal> row formats are also supported on
+ non-transactional tables.
</para>
</listitem>
<listitem>
<para>
- <literal>Maria</literal> supports atomic and crash-safe
- operations over many statements by enclosing statements within
- <literal>LOCK TABLES</literal> and <literal>UNLOCK
- TABLES</literal> statements.
+ <literal>Maria</literal> supports crash-safe operations over
+ many statements by enclosing statements within <literal>LOCK
+ TABLES</literal> and <literal>UNLOCK TABLES</literal>
+ statements.
</para>
<note>
@@ -308,10 +310,9 @@
<para>
Sets the size of each of the <literal>Maria</literal> log
- files. When the log reaches this figure, the log file is
- closed, a new log file (with a new sequential log file number)
- is created, and the <filename>maria_log_control</filename>
- file is updated.
+ files. When the log reaches this figure, a new log file (with
+ a new sequential log file number) is created, and the
+ <filename>maria_log_control</filename> file is updated.
</para>
<para>
@@ -404,9 +405,8 @@
<para>
The number of hits that a hot block in the page cache has to
be untouched until it is considered old enough to be
- downgraded to a warm block. The specifies the percentage ratio
- of the number of hits to the total number of blocks in the
- page cache.
+ downgraded to a warm block. Lower values cause demotion to
+ happen more quickly.
</para>
<para>
@@ -422,8 +422,9 @@
<para>
Sets the size of the buffer used for data and index pages to
<literal>Maria</literal> tables. You should increase this
- value to improve performance on index reads and writes,
- ideally to the maximum figure supported by your environment.
+ value to improve performance on data and index reads and
+ writes, ideally to the maximum figure supported by your
+ environment.
</para>
<para>
@@ -557,13 +558,13 @@
<para>
<literal>Maria</literal> tables can be either transactional or
non-transactional. For <literal>Maria</literal> versions less
- than 2.0, <literal>TRANSACTIONAL</literal> means crash-safe
- and atomic. Full transaction support will only be available
- with <literal>Maria</literal> 2.0 and later.
+ than 2.0, <literal>TRANSACTIONAL</literal> means crash-safe.
+ Full transaction support will only be available with
+ <literal>Maria</literal> 2.0 and later.
</para>
<para>
- Transactional tables are recorded in the
+ Changes to transactional tables are recorded in the
<literal>Maria</literal> log and use slightly more space per
row than non-transactional tables. By default all tables are
transactional (i.e. <literal>TRANSACTIONAL=1</literal> is
@@ -721,11 +722,12 @@
</para>
<para>
- For tables using the transactional format, statements are recorded
- in the log file, and data is transferred from the transaction log
- to the index and data files. There is no fixed point when the
- application of data from the log to the data and index files
- occurs; it happens in the background during normal execution.
+ For tables using the transactional format, statements that change
+ data (DML statements) are recorded in the log file and these
+ changes are also ultimately written to the data and index files. .
+ There is no fixed point when the application of data written to
+ the log is also written to the data and index files. The process
+ happens continuously in the background during normal execution.
Although the data and index files and the transaction log may be
out of sync, all of the information is always available. In the
event of a crash, the recovery process will replay and apply the
@@ -780,8 +782,8 @@
<listitem>
<para>
<literal>free</literal> — the log file and any
- statements related to it have been completed and the log file
- is no longer active.
+ statements related to it have been completed and safely
+ committed to disk, and the log file is no longer active.
</para>
</listitem>
@@ -817,10 +819,9 @@
</programlisting>
<para>
- Log files remain 'in use' until the changes have been written to
- the data and index files and the information has been synchronized
- on disk with a checkpoint. Log files that no longer have
- transactions or outstanding events are marked 'free':
+ Log files that no longer have transactions or outstanding events
+ where the data has been safely committed on disk are marked
+ 'free':
</para>
<programlisting>mysql> SHOW ENGINE MARIA LOGS;
@@ -852,9 +853,9 @@
<para>
In <literal>at_flush</literal> mode, the log files are only
deleted when you execute the <literal>FLUSH LOGS</literal>
- statement. Issuing this statement will delete the logs that are no
- longer 'in use' without affecting logs with outstanding
- transactions or events.
+ statement. Issuing this statement will delete the logs that have
+ the 'free' status, and therefore will not affect logs with
+ outstanding transactions or events.
</para>
<programlisting>mysql> SHOW ENGINE MARIA LOGS;
@@ -911,7 +912,29 @@
</para>
<para>
- In the event of a crash or other failure of
+ The basic operation of the recovery process is in two main stages:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Replay the contents of the log and update the data and index
+ information.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Roll back any statements that had not completed, or where the
+ transactions not been not been committed.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ More specifically, in the event of a crash or other failure of
<command>mysqld</command>, the following takes place during the
next invocation of <command>mysqld</command>:
</para>
@@ -1360,7 +1383,7 @@
<listitem>
<para>
- Index number requires one extra byte per index page.
+ Index requires one extra byte per index page.
</para>
</listitem>
@@ -1460,9 +1483,11 @@
This section contains all known fatal bugs in the
<literal>Maria</literal> storage engine for the last source or
binary release. Minor bugs, extensions and feature requests and
- bugs, found since this release can be find in the MySQL bugs
+ bugs, found since this release can be found in the MySQL bugs
databases at:
<ulink url="http://bugs.mysql.com/">http://bugs.mysql.com/</ulink>.
+ When reporting a bug, make sure you select the
+ <literal>Maria</literal> category for the bug.
</para>
<note>
@@ -1481,8 +1506,10 @@
<para>
If you have found a bug that is not listed here, please add it to
- http://bugs.mysql.com/ so that we can either fix it for next
- release or in the worst case add it here for others to know!
+ <ulink url="http://bugs.mysql.com/">http://bugs.mysql.com/</ulink>
+ so that we can either fix it for next release or in the worst case
+ add it here for others to know! When reporting a bug, make sure
+ you select the <literal>Maria</literal> category for the bug.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9820 - trunk/refman-5.1-maria | mcbrown | 13 Feb |
