svn commit - mysqldoc@docsrva: r11619 - in trunk: . dynamic-docs/command-optvars refman-5.1 refman-6.0

[paul.dubois]

Author: paul
Date: 2008-08-28 22:27:51 +0200 (Thu, 28 Aug 2008)
New Revision: 11619

Log:
 r33541@frost:  paul | 2008-08-28 13:40:53 -0500
 mysqlbinlog: List the possible --base64-output option values


Modified:
   trunk/dynamic-docs/command-optvars/mysqlbinlog.xml
   trunk/refman-5.1/programs-admin-util-core.xml
   trunk/refman-6.0/programs-admin-util-core.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:33537
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:32819
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:33541
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:32819


Modified: trunk/dynamic-docs/command-optvars/mysqlbinlog.xml
===================================================================
--- trunk/dynamic-docs/command-optvars/mysqlbinlog.xml	2008-08-28 17:32:50 UTC (rev 11618)
+++ trunk/dynamic-docs/command-optvars/mysqlbinlog.xml	2008-08-28 20:27:51 UTC (rev 11619)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 529 bytes

@@ -386,7 +386,7 @@
     </shortdescription>
 
     <types>
-      <optype class="cmdline" format="--base64-output"/>
+      <optype class="cmdline" format="--base64-output[=value]"/>
       <optype class="mycnf"/>
     </types>
 


Modified: trunk/refman-5.1/programs-admin-util-core.xml
===================================================================
--- trunk/refman-5.1/programs-admin-util-core.xml	2008-08-28 17:32:50 UTC (rev 11618)
+++ trunk/refman-5.1/programs-admin-util-core.xml	2008-08-28 20:27:51 UTC (rev 11619)
Changed blocks: 1, Lines Added: 75, Lines Deleted: 5; 4080 bytes

@@ -3716,15 +3716,85 @@
               <secondary>mysqlbinlog</secondary>
             </indexterm>
 
-            <option>--base64-output</option>
+           
<option>--base64-output[=<replaceable>value</replaceable>]</option>
           </para>
 
           <para>
-            Print all binary log entries using base64 encoding. This is
-            for debugging only. Logs produced using this option should
-            not be applied on production systems. This option was added
-            in MySQL 5.1.5.
+            This option determines when events should be displayed as
+            base 64-encoded <literal>BINLOG</literal> statements. The
+            option has these allowable values (not case sensitive):
           </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <literal>AUTO</literal> ("automatic") or
+                <literal>UNSPEC</literal> ("unspecified") displays
+                BINLOG statements automatically when necessary (that is,
+                for format description events and row events). This is
+                the default if the <option>--base64-output</option>
+                option is not given.
+              </para>
+
+              <para>
+                Automatic <literal>BINLOG</literal> display is the only
+                safe behavior if you intend to use the output of
+                <command>mysqlbinlog</command> to re-execute binary log
+                file contents. The other option values are intended only
+                for debugging or testing purposes because they may
+                produce output that does not include all events in
+                executable form.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>ALWAYS</literal> displays
+                <literal>BINLOG</literal> statements whenever possible.
+                This is the implied value if the option is given as
+                <option>--base64-output</option> without a value.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>NEVER</literal> causes
+                <literal>BINLOG</literal> statements not to be
+                displayed. <command>mysqlbinlog</command> exits with an
+                error if a row event is found that must be displayed
+                using <literal>BINLOG</literal>.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>DECODE-ROWS</literal> specifies to
+                <command>mysqlbinlog</command> that you intend for row
+                events to be decoded and displayed as commented SQL
+                statements by also specifying the
+                <option>--verbose</option> option. Like
+                <literal>NEVER</literal>,
<literal>DECODE-ROWS</literal>
+                suppresses display of <literal>BINLOG</literal>
+                statements, but unlike <literal>NEVER</literal>, it does
+                not exit with an error if a row event is found.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            The <option>--base64-output</option> option was introduced
+            in MySQL 5.1.5, to be given as
+            <option>--base64-output</option> or
+            <option>--skip-base64-output</option> (with the sense of
+            <literal>AUTO</literal> or <literal>NEVER</literal>).
The
+            option values described in the preceding list may be used as
+            of MySQL 5.1.24, with the exception of
+            <literal>UNSPEC</literal> and
+            <literal>DISABLE-ROWS</literal>, which are available as of
+            MySQL 5.1.28.
+          </para>
         </listitem>
 
         <listitem>


Modified: trunk/refman-6.0/programs-admin-util-core.xml
===================================================================
--- trunk/refman-6.0/programs-admin-util-core.xml	2008-08-28 17:32:50 UTC (rev 11618)
+++ trunk/refman-6.0/programs-admin-util-core.xml	2008-08-28 20:27:51 UTC (rev 11619)
Changed blocks: 1, Lines Added: 75, Lines Deleted: 4; 4030 bytes

@@ -3716,14 +3716,85 @@
               <secondary>mysqlbinlog</secondary>
             </indexterm>
 
-            <option>--base64-output</option>
+           
<option>--base64-output[=<replaceable>value</replaceable>]</option>
           </para>
 
           <para>
-            Print all binary log entries using base64 encoding. This is
-            for debugging only. Logs produced using this option should
-            not be applied on production systems.
+            This option determines when events should be displayed as
+            base 64-encoded <literal>BINLOG</literal> statements. The
+            option has these allowable values (not case sensitive):
           </para>
+
+          <itemizedlist>
+
+            <listitem>
+              <para>
+                <literal>AUTO</literal> ("automatic") or
+                <literal>UNSPEC</literal> ("unspecified") displays
+                BINLOG statements automatically when necessary (that is,
+                for format description events and row events). This is
+                the default if the <option>--base64-output</option>
+                option is not given.
+              </para>
+
+              <para>
+                Automatic <literal>BINLOG</literal> display is the only
+                safe behavior if you intend to use the output of
+                <command>mysqlbinlog</command> to re-execute binary log
+                file contents. The other option values are intended only
+                for debugging or testing purposes because they may
+                produce output that does not include all events in
+                executable form.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>ALWAYS</literal> displays
+                <literal>BINLOG</literal> statements whenever possible.
+                This is the implied value if the option is given as
+                <option>--base64-output</option> without a value.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>NEVER</literal> causes
+                <literal>BINLOG</literal> statements not to be
+                displayed. <command>mysqlbinlog</command> exits with an
+                error if a row event is found that must be displayed
+                using <literal>BINLOG</literal>.
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                <literal>DECODE-ROWS</literal> specifies to
+                <command>mysqlbinlog</command> that you intend for row
+                events to be decoded and displayed as commented SQL
+                statements by also specifying the
+                <option>--verbose</option> option. Like
+                <literal>NEVER</literal>,
<literal>DECODE-ROWS</literal>
+                suppresses display of <literal>BINLOG</literal>
+                statements, but unlike <literal>NEVER</literal>, it does
+                not exit with an error if a row event is found.
+              </para>
+            </listitem>
+
+          </itemizedlist>
+
+          <para>
+            Before MySQL 6.0.4, the <option>--base64-output</option>
+            option was boolean, to be given as
+            <option>--base64-output</option> or
+            <option>--skip-base64-output</option> (with the sense of
+            <literal>AUTO</literal> or <literal>NEVER</literal>).
The
+            option values described in the preceding list may be used as
+            of MySQL 6.0.4, with the exception of
+            <literal>UNSPEC</literal> and
+            <literal>DISABLE-ROWS</literal>, which are available as of
+            MySQL 6.0.7.
+          </para>
         </listitem>
 
         <listitem>