List:Commits« Previous MessageNext Message »
From:jon Date:October 8 2006 8:54am
Subject:svn commit - mysqldoc@docsrva: r3574 - in trunk: refman-5.0 refman-5.1
View as plain text  
Author: jstephens
Date: 2006-10-08 08:54:01 +0200 (Sun, 08 Oct 2006)
New Revision: 3574

Log:

Documented XML bugfixes (Bug #20854, Bug #21263)

Also stemming from fix for 21263: Noted previously undocumented --xml
behaviour (and recent changes therein) for mysql and mysqldump w/r/t
NULL (unknown),'NULL' (string), and '' (empty string).

(Thanks to Roland, Bar, and submitter J Barillari)



Modified:
   trunk/refman-5.0/client-utility-programs.xml
   trunk/refman-5.0/news-5.0.xml
   trunk/refman-5.1/client-utility-programs.xml
   trunk/refman-5.1/news-5.1.xml


Modified: trunk/refman-5.0/client-utility-programs.xml
===================================================================
--- trunk/refman-5.0/client-utility-programs.xml	2006-10-08 00:08:12 UTC (rev 3573)
+++ trunk/refman-5.0/client-utility-programs.xml	2006-10-08 06:54:01 UTC (rev 3574)
Changed blocks: 3, Lines Added: 69, Lines Deleted: 1; 4038 bytes

@@ -4650,6 +4650,29 @@
             <para>
               Produce XML output.
             </para>
+            
+            <para>
+              <emphasis role="bold">Note</emphasis>: Prior to MySQL
+              5.0.26, there was no differentiation in the output when
+              using this option between columns containing the
+              <literal>NULL</literal> value and columns containing the
+              string literal <literal>'NULL'</literal>; both were
+              represented as 
+            </para>
+            
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;
+</programlisting>
+            
+            <para>
+              Beginning with MySQL 5.0.26, the output when
+              <option>--xml</option> is used with
+              <command>mysql</command> matches that of
+              <command>mysqldump
<option>--xml</option></command>. See
+              <link linkend="mysqldump-xml-option">the section of the
+                Manual which discusses the <option>--xml</option> option
+                for <command>mysqldump</command></link> for details.
+            </para>
           </listitem>
 
         </itemizedlist>

@@ -11387,7 +11410,7 @@
           </listitem>
 
           <listitem>
-            <para>
+            <para id="mysqldump-xml-option">
               <indexterm>
                 <primary>mysqldump</primary>
                 <secondary>xml option</secondary>

@@ -11404,6 +11427,51 @@
             <para>
               Write dump output as well-formed XML.
             </para>
+            
+            <para>
+              <emphasis role="bold"><literal>NULL</literal>,
+                <literal>'NULL'</literal>, and Empty Values</emphasis>:
+              For some column named
+              <replaceable>column_name</replaceable>, the
+              <literal>NULL</literal> value, an empty string, and the
+              string value <literal>'NULL'</literal> are distinguished
+              from one another in the output generated by this option as
+              follows:
+            </para>
+            
+            <informaltable>
+              <tgroup cols="2">
+                <colspec colwidth="50*"/>
+                <colspec colwidth="50*"/>
+                <tbody>
+                  <row>
+                    <entry><emphasis
role="bold">Value</emphasis>:</entry>
+                    <entry><emphasis role="bold">XML
Representation</emphasis>:</entry>
+                  </row>
+                  <row>
+                    <entry><literal>NULL</literal>
(<emphasis>unknown value</emphasis>)</entry>
+                    <entry><literal>&lt;field
name="<replaceable>column_name</replaceable>" xsi:nil="true"
/&gt;</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>''</literal> (<emphasis>empty
string</emphasis>)</entry>
+                    <entry><literal>&gt;field
name="<replaceable>column_name</replaceable>"&gt;&lt;/field&gt;</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>'NULL'</literal>
(<emphasis>string value</emphasis>)</entry>
+                    <entry><literal>&gt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;</literal></entry>
+                  </row>
+                </tbody>
+              </tgroup>
+              
+            </informaltable>
+            
+            <para>
+              Beginning with MySQL 5.0.26, the output from the
+              <command>mysql</command> client when run using the
+              <option>--xml</option> option also follows these rules.
+              (See <xref linkend="mysql-command-options"/>.)
+            </para>
+            
           </listitem>
 
         </itemizedlist>


Modified: trunk/refman-5.0/news-5.0.xml
===================================================================
--- trunk/refman-5.0/news-5.0.xml	2006-10-08 00:08:12 UTC (rev 3573)
+++ trunk/refman-5.0/news-5.0.xml	2006-10-08 06:54:01 UTC (rev 3574)
Changed blocks: 1, Lines Added: 35, Lines Deleted: 0; 1411 bytes

@@ -305,6 +305,41 @@
     </para>
 
     <itemizedlist>
+      
+      <listitem>
+        <para>
+          The output generated by the server when using the
+          <option>--xml</option> option has changed with regard to null
+          values. It now matches the output from <command>mysqldump
+            <option>--xml</option></command>. That is, a column
+          containing a <literal>NULL</literal> value is now reported as
+        </para>
+        
+<programlisting>
+&lt;field name="<replaceable>column_name</replaceable>" xsi:nil="true"
/&gt;
+</programlisting>
+        
+        <para>
+          whereas a column containing the string value
+          <literal>'NULL'</literal> is reported as
+        </para>
+        
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;
+</programlisting>
+        
+        <para>
+          and a column containing an empty string is reported as
+        </para>
+        
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;&gt;/field&gt;
+</programlisting>
+        
+        <para>
+          (Bug #21263)
+        </para>
+      </listitem>
 
       <listitem>
         <para>


Modified: trunk/refman-5.1/client-utility-programs.xml
===================================================================
--- trunk/refman-5.1/client-utility-programs.xml	2006-10-08 00:08:12 UTC (rev 3573)
+++ trunk/refman-5.1/client-utility-programs.xml	2006-10-08 06:54:01 UTC (rev 3574)
Changed blocks: 3, Lines Added: 68, Lines Deleted: 1; 4025 bytes

@@ -4644,6 +4644,29 @@
             <para>
               Produce XML output.
             </para>
+            
+            <para>
+              <emphasis role="bold">Note</emphasis>: Prior to MySQL
+              5.1.12, there was no differentiation in the output when
+              using this option between columns containing the
+              <literal>NULL</literal> value and columns containing the
+              string literal <literal>'NULL'</literal>; both were
+              represented as 
+            </para>
+            
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;
+</programlisting>
+            
+            <para>
+              Beginning with MySQL 5.1.12, the output when
+              <option>--xml</option> is used with
+              <command>mysql</command> matches that of
+              <command>mysqldump
<option>--xml</option></command>. See
+              <link linkend="mysqldump-xml-option">the section of the
+                Manual which discusses the <option>--xml</option> option
+                for <command>mysqldump</command></link> for details.
+            </para>
           </listitem>
 
         </itemizedlist>

@@ -11324,7 +11347,7 @@
           </listitem>
 
           <listitem>
-            <para>
+            <para id="mysqldump-xml-option">
               <indexterm>
                 <primary>mysqldump</primary>
                 <secondary>xml option</secondary>

@@ -11341,6 +11364,50 @@
             <para>
               Write dump output as well-formed XML.
             </para>
+            
+            <para>
+              <emphasis role="bold"><literal>NULL</literal>,
+                <literal>'NULL'</literal>, and Empty Values</emphasis>:
+              For some column named
+              <replaceable>column_name</replaceable>, the
+              <literal>NULL</literal> value, an empty string, and the
+              string value <literal>'NULL'</literal> are distinguished
+              from one another in the output generated by this option as
+              follows:
+            </para>
+            
+            <informaltable>
+              <tgroup cols="2">
+                <colspec colwidth="50*"/>
+                <colspec colwidth="50*"/>
+                <tbody>
+                  <row>
+                    <entry><emphasis
role="bold">Value</emphasis>:</entry>
+                    <entry><emphasis role="bold">XML
Representation</emphasis>:</entry>
+                  </row>
+                  <row>
+                    <entry><literal>NULL</literal>
(<emphasis>unknown value</emphasis>)</entry>
+                    <entry><literal>&lt;field
name="<replaceable>column_name</replaceable>" xsi:nil="true"
/&gt;</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>''</literal> (<emphasis>empty
string</emphasis>)</entry>
+                    <entry><literal>&gt;field
name="<replaceable>column_name</replaceable>"&gt;&lt;/field&gt;</literal></entry>
+                  </row>
+                  <row>
+                    <entry><literal>'NULL'</literal>
(<emphasis>string value</emphasis>)</entry>
+                    <entry><literal>&gt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;</literal></entry>
+                  </row>
+                </tbody>
+              </tgroup>
+              
+            </informaltable>
+            
+            <para>
+              Beginning with MySQL 5.1.12, the output from the
+              <command>mysql</command> client when run using the
+              <option>--xml</option> option also follows these rules.
+              (See <xref linkend="mysql-command-options"/>.)
+            </para>
           </listitem>
 
         </itemizedlist>


Modified: trunk/refman-5.1/news-5.1.xml
===================================================================
--- trunk/refman-5.1/news-5.1.xml	2006-10-08 00:08:12 UTC (rev 3573)
+++ trunk/refman-5.1/news-5.1.xml	2006-10-08 06:54:01 UTC (rev 3574)
Changed blocks: 2, Lines Added: 51, Lines Deleted: 0; 2217 bytes

@@ -268,6 +268,43 @@
           Cluster to version 5.1.12 or later.
         </para>
       </listitem>
+      
+      
+      
+      <listitem>
+        <para>
+          The output generated by the server when using the
+          <option>--xml</option> option has changed with regard to null
+          values. It now matches the output from <command>mysqldump
+            <option>--xml</option></command>. That is, a column
+          containing a <literal>NULL</literal> value is now reported as
+        </para>
+        
+<programlisting>
+&lt;field name="<replaceable>column_name</replaceable>" xsi:nil="true"
/&gt;
+</programlisting>
+        
+        <para>
+          whereas a column containing the string value
+          <literal>'NULL'</literal> is reported as
+        </para>
+        
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;NULL&lt;/field&gt;
+</programlisting>
+        
+        <para>
+          and a column containing an empty string is reported as
+        </para>
+        
+<programlisting>
+&lt;field
name="<replaceable>column_name</replaceable>"&gt;&gt;/field&gt;
+</programlisting>
+        
+        <para>
+          (Bug #21263)
+        </para>
+      </listitem>
 
       <listitem>
         <para>

@@ -809,6 +846,20 @@
 REPAIR TABLE <replaceable>tbl_name</replaceable> QUICK;
 </programlisting>
       </listitem>
+      
+      <listitem>
+        <para>
+          It was possible to provide the
+          <literal>ExtractValue()</literal> function with input
+          containing <quote>tags</quote> that were not valid XML; for
+          example, it was possible to use tag names beginning with a
+          digit, which are disallowed by the W3C's XML 1.0
+          specification. Such cases caused the function to return
+          <quote>junk</quote> output rather than an error message
+          signalling the user as to the true nature of the problem. (Bug
+          #20854)
+        </para>
+      </listitem>
 
       <listitem>
         <para>


Thread
svn commit - mysqldoc@docsrva: r3574 - in trunk: refman-5.0 refman-5.1jon8 Oct