You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by rh...@apache.org on 2006/07/25 16:59:46 UTC

svn commit: r425410 - in /db/derby/docs/trunk/src/devguide: cdevconcepts24927.dita cdevdvlp40170.dita cdevdvlp40653.dita cdevresman89722.dita cdevresman92946.dita rdevprocsqle.dita rdevresman79556.dita tdevdvlp38381.dita

Author: rhillegas
Date: Tue Jul 25 07:59:45 2006
New Revision: 425410

URL: http://svn.apache.org/viewvc?rev=425410&view=rev
Log:
DERBY-1271: Commit derby-1271_devGuide_v01.diff, the JDBC4-related changes to the Developer's Guide.

Modified:
    db/derby/docs/trunk/src/devguide/cdevconcepts24927.dita
    db/derby/docs/trunk/src/devguide/cdevdvlp40170.dita
    db/derby/docs/trunk/src/devguide/cdevdvlp40653.dita
    db/derby/docs/trunk/src/devguide/cdevresman89722.dita
    db/derby/docs/trunk/src/devguide/cdevresman92946.dita
    db/derby/docs/trunk/src/devguide/rdevprocsqle.dita
    db/derby/docs/trunk/src/devguide/rdevresman79556.dita
    db/derby/docs/trunk/src/devguide/tdevdvlp38381.dita

Modified: db/derby/docs/trunk/src/devguide/cdevconcepts24927.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevconcepts24927.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevconcepts24927.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevconcepts24927.dita Tue Jul 25 07:59:45 2006
@@ -19,7 +19,11 @@
 -->
 <concept id="cdevconcepts24927" xml:lang="en-us">
 <title>Working with Derby SQLExceptions in an application</title>
-<shortdesc>JDBC generates exceptions of the type <i>java.sql.SQLException</i>.
+<shortdesc>JDBC generates exceptions of the type
+<i>java.sql.SQLException</i>.
+If your application runs on JDK 1.6 or higher, the exceptions
+will be the refined subtypes of <i>java.sql.SQLException</i>
+introduced by JDBC4.
 To see the exceptions generated by <ph conref="devconrefs.dita#prod/productshortname"></ph>,
 retrieve and process the <codeph><i>SQLExceptions</i></codeph> in a catch
 block.</shortdesc>

Modified: db/derby/docs/trunk/src/devguide/cdevdvlp40170.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp40170.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp40170.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp40170.dita Tue Jul 25 07:59:45 2006
@@ -25,8 +25,12 @@
 <keywords><indexterm>JDBC driver (embedded)</indexterm></keywords>
 </metadata></prolog>
 <conbody>
-<p>In a Java application, you typically load the driver with the static <codeph><i>Class.forName</i></codeph> method
-or with the <codeph><i>jdbc.drivers</i></codeph> system property.</p>
+<p>In a Java application running on JDK 1.5 or lower,
+you typically load the driver with the static <codeph><i>Class.forName</i></codeph> method
+or with the <codeph><i>jdbc.drivers</i></codeph> system property. If
+your application runs on JDK 1.6 or higher, then you do not need to
+explicitly load the EmbeddedDriver. In that environment, the driver
+loads automatically.</p>
 <p>For detailed information about loading the <ph conref="devconrefs.dita#prod/productshortname"></ph> JDBC
 driver, see <i>"java.sql.Driver"</i> in the <cite><ph conref="devconrefs.dita#pub/citref"></ph></cite>.</p>
 </conbody>

Modified: db/derby/docs/trunk/src/devguide/cdevdvlp40653.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp40653.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp40653.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp40653.dita Tue Jul 25 07:59:45 2006
@@ -21,7 +21,8 @@
 <title>Derby JDBC driver</title>
 <shortdesc><ph conref="devconrefs.dita#prod/productshortname"></ph> consists
 of both the database engine and an embedded JDBC driver. Applications use
-JDBC to interact with a database. Applications must load the driver in order
+JDBC to interact with a database. Applications running on JDK 1.5 or
+earlier, must load the driver in order
 to work with the database.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>JDBC driver<indexterm>description</indexterm></indexterm>
@@ -37,5 +38,9 @@
 <p>For detailed information about loading the <ph conref="devconrefs.dita#prod/productshortname"></ph> JDBC
 driver, see <i>"java.sql.Driver" </i> in the <cite><ph conref="devconrefs.dita#pub/citref"></ph></cite><cite>.</cite><ph> See
 also javadoc for org.apache.derby.util.DriverUtil.</ph></p>
+<p>
+If your application runs on JDK 1.6 or higher, then you do not need to
+explicitly load the EmbeddedDriver. In that environment, the driver loads automatically.
+</p>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/devguide/cdevresman89722.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevresman89722.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevresman89722.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevresman89722.dita Tue Jul 25 07:59:45 2006
@@ -24,7 +24,16 @@
 examples.</shortdesc>
 <prolog></prolog>
 <conbody>
-<codeblock>import org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource;
+<codeblock>
+<b>//
+// Note that if your application runs on JDK 1.6 or higher, you
+// will use the JDBC4 variants of these classes:
+//
+//   org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40
+//   org.apache.derby.jdbc.EmbeddedDataSource40
+//   org.apache.derby.jdbc.EmbeddedXADataSource40
+//</b>
+import org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource;
 import org.apache.derby.jdbc.EmbeddedDataSource;
 import org.apache.derby.jdbc.EmbeddedXADataSource; 
 

Modified: db/derby/docs/trunk/src/devguide/cdevresman92946.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevresman92946.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevresman92946.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevresman92946.dita Tue Jul 25 07:59:45 2006
@@ -35,6 +35,11 @@
 // if create is true, create the database if not already created</b>
 XADataSource makeXADataSource (String dbname, boolean create) 
 {
+    <b>//
+    // If your application runs on JDK 1.6 or higher, then
+    // you will use the JDBC4 variant of this class:
+    // EmbeddedXADataSource40.
+    //</b>
     EmbeddedXADataSource xads = new EmbeddedXADataSource();
 <b>    // use <ph conref="devconrefs.dita#prod/productshortname"></ph> 's setDatabaseName call</b>
     xads.setDatabaseName(dbname);

Modified: db/derby/docs/trunk/src/devguide/rdevprocsqle.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevprocsqle.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevprocsqle.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevprocsqle.dita Tue Jul 25 07:59:45 2006
@@ -46,6 +46,11 @@
         sqle = sqle.getNextException();
     }
 }</codeblock></example>
+<section><p>
+If your application runs on JDK 1.4 or higher, then the <i>SQLException</i>
+may wrap another, triggering exception, like an <i>IOException</i>. To inspect
+this additional, wrapped error, call the <i>SQLException</i>'s <i>getCause</i> method.
+</p></section>
 <section><p>See also "<ph conref="devconrefs.dita#prod/productshortname"></ph> Exception
 Messages and SQL States", in the <cite><ph conref="devconrefs.dita#pub/citref"></ph></cite>.</p></section>
 </refbody>

Modified: db/derby/docs/trunk/src/devguide/rdevresman79556.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevresman79556.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevresman79556.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevresman79556.dita Tue Jul 25 07:59:45 2006
@@ -19,19 +19,39 @@
 -->
 <reference id="rdevresman79556" xml:lang="en-us">
 <title>Classes that pertain to resource managers</title>
-<shortdesc>See the javadoc for each class for more information.</shortdesc>
+<shortdesc>See the javadoc for each class for more
+information.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>EmbeddedDataSource</indexterm><indexterm>EmbeddedConnectionPoolDataSource</indexterm>
-<indexterm>EmbeddedXADataSource</indexterm></keywords>
+<keywords>
+<indexterm>EmbeddedDataSource</indexterm>
+<indexterm>EmbeddedDataSource40</indexterm>
+<indexterm>EmbeddedConnectionPoolDataSource</indexterm>
+<indexterm>EmbeddedConnectionPoolDataSource40</indexterm>
+<indexterm>EmbeddedXADataSource</indexterm>
+<indexterm>EmbeddedXADataSource40</indexterm>
+</keywords>
 </metadata></prolog>
 <refbody>
-<section> <ul>
-<li><i>org.apache.derby.jdbc.EmbeddedDataSource</i><i></i>   <p>Implements <i>javax.sql.DataSource</i> interface,
+<section>
+<p>
+Each of these DataSources has two variants. Use the first variant if
+your application run on JDK 1.5 or lower. Use the second variant (the
+one whose class name ends with "40") if your application runs on JDK
+1.6 or higher.
+</p>
+<ul>
+<li><i>org.apache.derby.jdbc.EmbeddedDataSource</i>
+and <i>org.apache.derby.jdbc.EmbeddedDataSource40</i> 
+<p>Implements <i>javax.sql.DataSource</i> interface,
 which a JNDI server can reference. Typically this is the object that you work
 with as a <codeph><i>DataSource</i></codeph>.</p></li>
-<li><i>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource</i>   <p>Implements <i>javax.sql.ConnectionPoolDataSource</i>.
+<li><i>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource</i>
+and <i>org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40</i>
+<p>Implements <i>javax.sql.ConnectionPoolDataSource</i>.
 A factory for <codeph><i>PooledConnection</i></codeph> objects.</p></li>
-<li><i>org.apache.derby.jdbc.EmbeddedXADataSource</i><i></i>   <p><ph conref="devconrefs.dita#prod/productshortname"></ph>'s
+<li><i>org.apache.derby.jdbc.EmbeddedXADataSource</i>
+and <i>org.apache.derby.jdbc.EmbeddedXADataSource40</i>
+<p><ph conref="devconrefs.dita#prod/productshortname"></ph>'s
 implementation of a <i>javax.sql.XADataSource</i>.</p></li>
 </ul></section>
 </refbody>

Modified: db/derby/docs/trunk/src/devguide/tdevdvlp38381.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/tdevdvlp38381.dita?rev=425410&r1=425409&r2=425410&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/tdevdvlp38381.dita (original)
+++ db/derby/docs/trunk/src/devguide/tdevdvlp38381.dita Tue Jul 25 07:59:45 2006
@@ -33,13 +33,17 @@
 </metadata></prolog>
 <taskbody>
 <context> <p>For example, when using the JBDC driver manager directly within
-Java code, you typically start a JDBC driver in one of two ways:</p><ul>
+Java code, you typically start a JDBC driver in one of these ways:</p><ul>
 <li>Specify the <i>jdbc.drivers</i> system property, which allows users to
-customize the JDBC drivers used by their applications. For example:   <codeblock>java -Djdbc.drivers=org.apache.derby.jdbc.EmbeddedDriver <i>applicationClass</i
-></codeblock></li>
+customize the JDBC drivers used by their applications. For example:   <codeblock>java -Djdbc.drivers=org.apache.derby.jdbc.EmbeddedDriver <i>applicationClass</i>
+</codeblock></li>
 </ul><ul>
 <li>Load the class directly from Java code using the static method <i>Class.forName</i>.
 For example:   <codeblock>Class.forName("org.apache.derby.jdbc.EmbeddedDriver"); </codeblock></li>
+<li>If your application runs on JDK 1.6 or higher, then you do not
+need to explicitlty load the EmbeddedDriver. In that environment, the
+driver loads automatically and the engine starts when your application
+requests its first Connection.</li>
 </ul><p>For more details, see <i>"java.sql.Driver"</i> in the <cite><ph conref="devconrefs.dita#pub/citref"></ph></cite><cite>.</cite></p><p>Once
 the <ph conref="devconrefs.dita#prod/productshortname"></ph> JDBC driver class
 has been loaded, you can connect to any <ph conref="devconrefs.dita#prod/productshortname"></ph> database