svn commit - mysqldoc@docsrva: r4680 - trunk/refman-common

[mcbrown]

Author: mcbrown
Date: 2007-01-29 18:44:46 +0100 (Mon, 29 Jan 2007)
New Revision: 4680

Log:
Updating C/MXJ for 5.0.4 (thanks Eric!)



Modified:
   trunk/refman-common/connector-mxj.xml


Modified: trunk/refman-common/connector-mxj.xml
===================================================================
--- trunk/refman-common/connector-mxj.xml	2007-01-29 17:36:18 UTC (rev 4679)
+++ trunk/refman-common/connector-mxj.xml	2007-01-29 17:44:46 UTC (rev 4680)
Changed blocks: 9, Lines Added: 161, Lines Deleted: 20; 8585 bytes

@@ -74,11 +74,33 @@
         <listitem>
           <para>
             Connector/MXJ 5.x, currently in beta status, includes
-            <literal>mysqld</literal> version 5.0.22 and includes
-            binaries for Linux x86, Mac OS X PPC, Windows XP/NT/2000 x86
-            and Solaris SPARC. Connector/MXJ 5.x requires the
-            Connector/J 5.x package.
+            <literal>mysqld</literal> version 5.x and includes binaries
+            for Linux x86, Mac OS X PPC, Windows XP/NT/2000 x86 and
+            Solaris SPARC. Connector/MXJ 5.x requires the Connector/J
+            5.x package.
           </para>
+
+          <para>
+            The exact version of <literal>mysqld</literal> included
+            depends on the version of Connector/MXJ
+          </para>
+
+          <orderedlist>
+
+            <listitem>
+              <para>
+                Connector/MXJ v5.0.3 included MySQL v5.0.22
+              </para>
+            </listitem>
+
+            <listitem>
+              <para>
+                Connector/MXJ v5.0.4 includes MySQL v5.0.27 (Community)
+                or MySQL v5.0.32 (Enterprise)
+              </para>
+            </listitem>
+
+          </orderedlist>
         </listitem>
 
         <listitem>

@@ -307,7 +329,7 @@
       </para>
 
       <para>
-        To install the files:
+        To install the files, for a Connector/MXJ 5.0.4 installation:
       </para>
 
       <orderedlist>

@@ -332,10 +354,7 @@
           <para>
             For best results, you should update your global
             <literal>CLASSPATH</literal> variable with the location of
-            the Connector/MXJ JAR
-            (<filename>connextor-mxj.jar</filename>). You will also need
-            to add the AspectJ Runtime, located in
-            <filename>lib/aspectjrt.jar</filename>.
+            the required <literal>jar</literal> files.
           </para>
 
           <para>

@@ -354,6 +373,79 @@
 
       </orderedlist>
 
+      <para>
+        For Connector/MXJ 5.0.4 and later you need the following JAR
+        files in your <literal>CLASSPATH</literal>
+      </para>
+
+      <orderedlist>
+
+        <listitem>
+          <para>
+            <filename>connector-mxj.jar</filename> &mdash; contains the
+            main Connector/MXJ classes.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <filename>connector-mxj-db-files.jar</filename> &mdash;
+            contains the embedded <literal>mysqld</literal> and database
+            files.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <filename>aspectjrt.jar</filename> &mdash; the AspectJ
+            runtime library, located in
+            <filename>lib/aspectjrt.jar</filename> in the Connector/MXJ
+            package.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <filename>connector-j.jar</filename> &mdash; Connector/J,
+            see <xref
+              linkend="connector-j"/>.
+          </para>
+        </listitem>
+
+      </orderedlist>
+
+      <para>
+        For Connector/MXJ 5.0.3 and earlier, you need the following JAR
+        files:
+      </para>
+
+      <orderedlist>
+
+        <listitem>
+          <para>
+            <filename>connector-mxj.jar</filename>
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <filename>aspectjrt.jar</filename> &mdash; the AspectJ
+            runtime library, located in
+            <filename>lib/aspectjrt.jar</filename> in the Connector/MXJ
+            package.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            <filename>connector-j.jar</filename> &mdash; Connector/J,
+            see <xref
+              linkend="connector-j"/>.
+          </para>
+        </listitem>
+
+      </orderedlist>
+
     </section>
 
     <section id="connector-mxj-install-quickstart">

@@ -439,6 +531,13 @@
             <filename>connector-mxj.jar</filename> to the
             <literal>CLASSPATH</literal>.
           </para>
+
+          <para>
+            If you are using Connector/MXJ v5.0.4 or later you will also
+            need to add the
+            <literal>connector-mxj-db-files.jar</literal> file to your
+            <literal>CLASSPATH</literal>.
+          </para>
         </listitem>
 
         <listitem>

@@ -477,12 +576,20 @@
             <filename>$JBOSS_HOME/server/default/lib</filename>
             directory.
           </para>
+
+          <para>
+            If you are using Connector/MXJ v5.0.4 or later you will also
+            need to copy the
+            <literal>connector-mxj-db-files.jar</literal> file to
+            <filename>$JBOSS_HOME/server/default/lib</filename>.
+          </para>
         </listitem>
 
         <listitem>
           <para>
             Download Connector/J and copy the
-           
<filename>mysql-connector-java-<replaceable>5.0.4</replaceable>-bin.jar</filename>
file to the
+           
<filename>mysql-connector-java-<replaceable>5.0.4</replaceable>-bin.jar</filename>
+            file to the
             <filename>$JBOSS_HOME/server/default/lib</filename>
             directory.
           </para>

@@ -1246,7 +1353,9 @@
         If you want to create a custom Connector/MXJ package that
         includes a specific <literal>mysqld</literal> version or
         platform then you must extract and rebuild the
-        <filename>connector-mxj.jar</filename> file.
+        <filename>connector-mxj.jar</filename> (Connector/MXJ v5.0.3 or
+        earlier) or <filename>connector-mxj-db-files.jar</filename>
+        (Connector/MXJ v5.0.4 or later) file.
       </para>
 
       <para>

@@ -1264,20 +1373,32 @@
 META-INF/
 TestDb.class
 com/
-kill.exe
-</programlisting>
+kill.exe</programlisting>
 
       <para>
-        The MySQL version directory, <literal>5-0-22</literal> in the
-        above example, contains all of the files used to create an
-        instance of MySQL when Connector/MXJ is executed. All of the
-        files in this directory are required for each version of MySQL
-        that you want to embed. Note as well the format of the version
-        number, which uses hyphens instead of periods to separate the
-        version number components.
+        If you are using Connector/MXJ v5.0.4 or later, you should
+        unpack the <filename>connector-mxj-db-files.jar</filename>:
       </para>
 
+<programlisting>shell&gt; mkdir custom-mxj
+shell&gt; cd custom-mxj
+shell&gt; jar -xf connector-mxj-db-files.jar
+shell&gt; ls
+5-0-27/                         
+META-INF/                       
+connector-mxj.properties</programlisting>
+
       <para>
+        The MySQL version directory, <literal>5-0-22</literal> or
+        <literal>5-0-27</literal> in the above examples, contains all of
+        the files used to create an instance of MySQL when Connector/MXJ
+        is executed. All of the files in this directory are required for
+        each version of MySQL that you want to embed. Note as well the
+        format of the version number, which uses hyphens instead of
+        periods to separate the version number components.
+      </para>
+
+      <para>
         Within the version specific directory are the platform specific
         directories, and archives of the <filename>data</filename> and
         <filename>share</filename> directory required by MySQL for the

@@ -1346,11 +1467,31 @@
 shell&gt; jar -cf ../connector-mxj.jar *</programlisting>
 
       <para>
+        For Connector/MXJ v5.0.4 and later, you should repackage to the
+        <filename>connector-mxj-db-files.jar</filename>:
+      </para>
+
+<programlisting>shell&gt; cd custom-mxj
+shell&gt; jar -cf ../connector-mxj-db-files.jar *</programlisting>
+
+      <para>
         You should test this package using the steps outlined in
         <xref
           linkend="connector-mxj-install-quickstart"/>.
       </para>
 
+      <note>
+        <para>
+          Because the <filename>connector-mxj-db-files.jar</filename>
+          file is separate from the main Connector/MXJ classes you can
+          distribute different
+          <filename>connector-mxj-db-files.jar</filename> files to
+          different hotsts or for different projects without having to
+          create a completely new main
+          <filename>connector-mxj.jar</filename> file for each one.
+        </para>
+      </note>
+
     </section>
 
     <section id="connector-mxj-usagenotes-customdb">