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 ch...@apache.org on 2014/06/17 21:37:42 UTC
svn commit: r1603273 - /db/derby/docs/trunk/src/ref/
Author: chaase3
Date: Tue Jun 17 19:37:41 2014
New Revision: 1603273
URL: http://svn.apache.org/r1603273
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 50 Reference Manual topics.
Patch: DERBY-6379-ref-jdbc.diff
Modified:
db/derby/docs/trunk/src/ref/crefjavbclobnot.dita
db/derby/docs/trunk/src/ref/crefjavccns.dita
db/derby/docs/trunk/src/ref/crefjavgcasyn.dita
db/derby/docs/trunk/src/ref/crefjavstateautogen.dita
db/derby/docs/trunk/src/ref/crefjdbc12657.dita
db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita
db/derby/docs/trunk/src/ref/rrefdmdfns1.dita
db/derby/docs/trunk/src/ref/rrefdmrs.dita
db/derby/docs/trunk/src/ref/rrefjavcallstatout.dita
db/derby/docs/trunk/src/ref/rrefjavciro.dita
db/derby/docs/trunk/src/ref/rrefjavcsro.dita
db/derby/docs/trunk/src/ref/rrefjavcsti.dita
db/derby/docs/trunk/src/ref/rrefjavsqlprst.dita
db/derby/docs/trunk/src/ref/rrefjavsqlrssc.dita
db/derby/docs/trunk/src/ref/rrefjdbc1020262.dita
db/derby/docs/trunk/src/ref/rrefjdbc10889.dita
db/derby/docs/trunk/src/ref/rrefjdbc12124.dita
db/derby/docs/trunk/src/ref/rrefjdbc15905.dita
db/derby/docs/trunk/src/ref/rrefjdbc16643.dita
db/derby/docs/trunk/src/ref/rrefjdbc20377.dita
db/derby/docs/trunk/src/ref/rrefjdbc20485.dita
db/derby/docs/trunk/src/ref/rrefjdbc23502.dita
db/derby/docs/trunk/src/ref/rrefjdbc27433.dita
db/derby/docs/trunk/src/ref/rrefjdbc27734.dita
db/derby/docs/trunk/src/ref/rrefjdbc28456.dita
db/derby/docs/trunk/src/ref/rrefjdbc29874.dita
db/derby/docs/trunk/src/ref/rrefjdbc30469.dita
db/derby/docs/trunk/src/ref/rrefjdbc32052.dita
db/derby/docs/trunk/src/ref/rrefjdbc34565.dita
db/derby/docs/trunk/src/ref/rrefjdbc34954.dita
db/derby/docs/trunk/src/ref/rrefjdbc37244.dita
db/derby/docs/trunk/src/ref/rrefjdbc37352.dita
db/derby/docs/trunk/src/ref/rrefjdbc38274.dita
db/derby/docs/trunk/src/ref/rrefjdbc40794.dita
db/derby/docs/trunk/src/ref/rrefjdbc41784.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_1connection.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_1summary.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_2databasemetadata.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_2sqltype.dita
db/derby/docs/trunk/src/ref/rrefjdbc4_2summary.dita
db/derby/docs/trunk/src/ref/rrefjdbc70824.dita
db/derby/docs/trunk/src/ref/rrefjdbc75719.dita
db/derby/docs/trunk/src/ref/rrefjdbc88908.dita
db/derby/docs/trunk/src/ref/rrefjdbc96386.dita
db/derby/docs/trunk/src/ref/rrefjdbcescapedate.dita
db/derby/docs/trunk/src/ref/rrefjdbcjavasqlsavepoint.dita
db/derby/docs/trunk/src/ref/rrefjdbclimit.dita
db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita
db/derby/docs/trunk/src/ref/rrefso2.dita
Modified: db/derby/docs/trunk/src/ref/crefjavbclobnot.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjavbclobnot.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjavbclobnot.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjavbclobnot.dita Tue Jun 17 19:37:41 2014
@@ -20,15 +20,17 @@ limitations under the License.
"../dtd/concept.dtd">
<concept id="crefjavbclobnot" xml:lang="en-us">
<title>Notes on mapping of java.sql.Blob and java.sql.Clob interfaces</title>
+<shortdesc>The usual <ph conref="../conrefs.dita#prod/productshortname"></ph>
+locking mechanisms (shared locks) prevent other transactions from updating or
+deleting the database item to which the <i>java.sql.Blob</i> or
+<i>java.sql.Clob</i> object is a pointer.</shortdesc>
<conbody>
-<p>The usual <ph conref="../conrefs.dita#prod/productshortname"></ph> locking
-mechanisms (shared locks) prevent other transactions from updating or deleting
-the database item to which the <i>java.sql.Blob</i> or <i>java.sql.Clob</i> object
-is a pointer. However, in some cases, <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-instantaneous lock mechanisms could allow a period of time in which the column
-underlying the <i>java.sql.Blob</i> or <i>java.sql.Clob</i> is unprotected.
-A subsequent call to <i>getBlob/getClob</i>, or to a <i>java.sql.Blob</i>/<i>java.sql.Clob</i>method,
-could cause undefined behavior.</p>
+<p>However, in some cases,
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s instantaneous lock
+mechanisms could allow a period of time in which the column underlying the
+<i>java.sql.Blob</i> or <i>java.sql.Clob</i> is unprotected. A subsequent call
+to <i>getBlob/getClob</i>, or to a <i>java.sql.Blob</i>/<i>java.sql.Clob</i>
+method, could cause undefined behavior.</p>
<p>Furthermore, there is nothing to prevent the transaction that holds the <i>java.sql.Blob</i>/<i>java.sql.Clob</i> (as
opposed to another transaction) from updating the underlying row. (The same
problem exists with the <i>getXXXStream</i> methods.) Program applications
Modified: db/derby/docs/trunk/src/ref/crefjavccns.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjavccns.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjavccns.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjavccns.dita Tue Jun 17 19:37:41 2014
@@ -20,11 +20,10 @@ limitations under the License.
"../dtd/concept.dtd">
<concept id="crefjavccns" xml:lang="en-us">
<title>Connection functionality not supported</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> does not use
+catalog names. In addition, the following optional methods raise "Feature not
+supported" exceptions.</shortdesc>
<conbody>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> does not use catalog
-names. In addition, the following optional methods raise "Feature not
-supported" exceptions:
-</p>
<ul>
<li><i>createArrayOf( java.lang.String, java.lang.Object[] )</i></li>
<li><i>createNClob( )</i></li>
Modified: db/derby/docs/trunk/src/ref/crefjavgcasyn.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjavgcasyn.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjavgcasyn.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjavgcasyn.dita Tue Jun 17 19:37:41 2014
@@ -20,10 +20,11 @@ limitations under the License.
"../dtd/concept.dtd">
<concept id="crefjavgcasyn" xml:lang="en-us">
<title>Additional SQL syntax</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> also
+supports the following SQL standard syntax to obtain a reference to the current
+connection in a database-side JDBC routine.</shortdesc>
<conbody>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> also supports
-the following SQL standard syntax to obtain a reference to the current connection
-in a database-side JDBC routine: <codeblock><b>jdbc:default:connection</b></codeblock></p>
+<codeblock><b>jdbc:default:connection</b></codeblock>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/ref/crefjavstateautogen.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjavstateautogen.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjavstateautogen.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjavstateautogen.dita Tue Jun 17 19:37:41 2014
@@ -20,20 +20,21 @@ limitations under the License.
-->
<concept id="crefjavstateautogen" xml:lang="en-us">
<title>Autogenerated keys</title>
+<shortdesc>JDBC's auto-generated keys feature provides a way to retrieve values
+from columns that are part of an index or have a default value
+assigned.</shortdesc>
<prolog><metadata>
<keywords><indexterm>autogenerated keys</indexterm></keywords>
</metadata></prolog>
<conbody>
-<p>JDBC's auto-generated keys feature provides a way to retrieve values
-from columns that are part of an index or have a default value assigned. <ph
-conref="../conrefs.dita#prod/productshortname"></ph> supports the auto-increment
-feature, which allows users to create columns in tables for which the database
-system automatically assigns increasing integer values. Users can call the
-method <i>Statement.getGeneratedKeys</i> to retrieve the value of such a column.
-This method returns a <i>ResultSet</i> object with a column for the
-automatically generated key. The
-<ph conref="../conrefs.dita#prod/productshortname"></ph> implementation of
-<i>Statement.getGeneratedKeys</i> returns meaningful results only if the last
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports the
+auto-increment feature, which allows users to create columns in tables for which
+the database system automatically assigns increasing integer values. Users can
+call the method <i>Statement.getGeneratedKeys</i> to retrieve the value of such
+a column. This method returns a <i>ResultSet</i> object with a column for the
+automatically generated key.</p>
+<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> implementation
+of <i>Statement.getGeneratedKeys</i> returns meaningful results only if the last
statement was a single-row insert statement. If it was a multi-row insert,
<i>Statement.getGeneratedKeys</i> will return a result set with only a single
row, even though it should return one row for each inserted row.</p>
Modified: db/derby/docs/trunk/src/ref/crefjdbc12657.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjdbc12657.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjdbc12657.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjdbc12657.dita Tue Jun 17 19:37:41 2014
@@ -20,22 +20,23 @@ limitations under the License.
-->
<concept id="crefjdbc12657" xml:lang="en-us">
<title>JDBC reference</title>
-<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> comes
-with a built-in JDBC driver. </shortdesc>
+<shortdesc>This section provides reference information about
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of the
+Java Database Connectivity (JDBC) API and documents the way it conforms to the
+JDBC APIs.</shortdesc>
<prolog><metadata>
<keywords><indexterm>JDBC API<indexterm>Derby implementation of</indexterm></indexterm>
</keywords>
</metadata></prolog>
<conbody>
-<p>That makes the JDBC API the only API for working with <ph conref="../conrefs.dita#prod/productshortname"></ph> databases.
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> comes with a
+built-in JDBC driver. That makes the JDBC API the only API for working with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> databases.
The driver is a native-protocol fully Java technology-enabled driver (Type 4
of the types described under "JDBC Architecture" in <xref format="html"
href="http://www.oracle.com/technetwork/java/overview-141217.html"
scope="external">http://www.oracle.com/technetwork/java/overview-141217.html</xref>).
</p>
-<p>This section provides reference information about
-<ph conref="../conrefs.dita#prod/productshortname"></ph>'s implementation of the
-JDBC API and documents the way it conforms to the JDBC APIs.</p>
<p>See the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite> for
task-oriented instructions on working with the driver.</p>
<p>This JDBC driver implements the standard JDBC interfaces.
Modified: db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcrsrgpc1.dita Tue Jun 17 19:37:41 2014
@@ -19,10 +19,11 @@ limitations under the License.
-->
<reference id="rrefcrsrgpc1" xml:lang="en-us">
<title>Columns in the ResultSets returned by getFunctionColumns and getProcedureColumns</title>
+<shortdesc>Columns in the <i>ResultSet</i>s returned by
+<i>getFunctionColumns</i> and <i>getProcedureColumns</i> are as described by the
+API.</shortdesc>
<refbody>
-<section><p>Columns in the <i>ResultSet</i>s returned by
-<i>getFunctionColumns</i> and <i>getProcedureColumns</i> are
-as described by the API.</p>
+<section>
<p>The following table shows
<ph conref="../conrefs.dita#prod/productshortname"></ph>-specific details for
some specific columns returned by <i>getFunctionColumns</i>.</p>
Modified: db/derby/docs/trunk/src/ref/rrefdmdfns1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdmdfns1.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdmdfns1.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdmdfns1.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,9 @@ limitations under the License.
-->
<reference id="rrefdmdfns1" xml:lang="en-us">
<title>java.sql.DatabaseMetaData.getBestRowIdentifier method</title>
+<shortdesc>The <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
+looks for identifiers in a specific order. This order might not return a unique
+row.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.DatabaseMetaData.getBestRowIdentifier method</indexterm>
<indexterm>methods<indexterm>java.sql.DatabaseMetaData.getBestRowIdentifier</indexterm></indexterm>
@@ -28,9 +31,6 @@ limitations under the License.
<refbody>
<section>
<p>The <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
-looks for identifiers in a specific order. This order might not return a unique
-row.</p>
-<p>The <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
looks for identifiers in the following order: <ul>
<li>A primary key on the table</li>
<li>A unique constraint or unique index on the table</li>
Modified: db/derby/docs/trunk/src/ref/rrefdmrs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdmrs.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdmrs.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdmrs.dita Tue Jun 17 19:37:41 2014
@@ -20,9 +20,9 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefdmrs" xml:lang="en-us">
<title>DatabaseMetaData result sets</title>
+<shortdesc><i>DatabaseMetaData</i> result sets do not close the result sets of
+other statements, even when auto-commit is set to true.</shortdesc>
<refbody>
-<section><p><i>DatabaseMetaData</i> result sets do not close the result sets
-of other statements, even when auto-commit is set to true. </p></section>
<section><p><i>DatabaseMetaData</i> result sets are closed if a user performs
any other action on a JDBC object that causes an automatic <i>commit</i> to
occur. If you need the <i>DatabaseMetaData</i> result sets to be accessible
Modified: db/derby/docs/trunk/src/ref/rrefjavcallstatout.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavcallstatout.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavcallstatout.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavcallstatout.dita Tue Jun 17 19:37:41 2014
@@ -20,19 +20,22 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjavcallstatout" xml:lang="en-us">
<title>CallableStatements and OUT Parameters <ph></ph></title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> supports OUT
+parameters and CALL statements that return values, as in the following
+example.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.CallableStatement<indexterm>and OUT parameters</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports
-OUT parameters and CALL statements that return values, as in the following
-example: <codeblock expanse="column"><b>CallableStatement cs = conn.prepareCall(
+<section><p>
+<codeblock expanse="column"><b>CallableStatement cs = conn.prepareCall(
"? = CALL getDriverType(cast (? as INT))"
cs.registerOutParameter(1, Types.INTEGER);
cs.setInt(2, 35);
-cs.executeUpdate();</b></codeblock> <note>Using a CALL statement with a procedure
-that returns a value is only supported with the <i>? =</i> syntax.</note></p></section>
+cs.executeUpdate();</b></codeblock> <note>Using a CALL statement with a
+procedure that returns a value is only supported with the <codeph>? =</codeph>
+syntax.</note></p></section>
<section><p>Register the output type of the parameter before executing the
call.</p></section>
</refbody>
Modified: db/derby/docs/trunk/src/ref/rrefjavciro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavciro.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavciro.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavciro.dita Tue Jun 17 19:37:41 2014
@@ -20,16 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjavciro" xml:lang="en-us">
<title>java.sql.Connection.isReadOnly method</title>
+<shortdesc>If you connect to a read-only database, the appropriate
+<i>isReadOnly DatabaseMetaData</i> value is returned.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Connection.isReadOnly method</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>If you connect to a read-only database, the appropriate <i>isReadOnly
-DatabaseMetaData</i> value is returned. For example, <i>Connections</i> set
-to read-only using the <i>setReadOnly</i> method, <i>Connections</i> for which
-the user has been defined as a <i>readOnlyAccess</i> user (with one of the <ph
-conref="../conrefs.dita#prod/productshortname"></ph> properties), and <i>Connections</i> to
-databases on read-only media return true.</p></section>
+<section><p>For example, <i>Connections</i> set to read-only using the
+<i>setReadOnly</i> method, <i>Connections</i> for which the user has been
+defined as a <i>readOnlyAccess</i> user (with one of the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> properties), and
+<i>Connections</i> to databases on read-only media return true.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefjavcsro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavcsro.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavcsro.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavcsro.dita Tue Jun 17 19:37:41 2014
@@ -20,12 +20,14 @@ limitations under the License.
-->
<reference id="rrefjavcsro" xml:lang="en-us">
<title>java.sql.Connection.setReadOnly method</title>
+<shortdesc>The <i>java.sql.Connection.setReadOnly</i> method is
+supported.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Connection.setReadOnly method</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><i>java.sql.Connection.setReadOnly</i> is supported.</p><p>See
-the section "Differences using the Connection.setReadOnly method" in
-the <ph conref="../conrefs.dita#pub/citadmin"></ph> for more information.</p></section>
+<section><p>See the section "Differences using the Connection.setReadOnly
+method" in the <ph conref="../conrefs.dita#pub/citadmin"></ph> for more
+information.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefjavcsti.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavcsti.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavcsti.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavcsti.dita Tue Jun 17 19:37:41 2014
@@ -20,15 +20,18 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjavcsti" xml:lang="en-us">
<title>java.sql.Connection.setTransactionIsolation method</title>
+<shortdesc>The transaction isolation levels
+<i>java.sql.Connection.TRANSACTION_SERIALIZABLE</i>,
+<i>java.sql.Connection.TRANSACTION_REPEATABLE_READ</i>,
+<i>java.sql.Connection.TRANSACTION_READ_COMMITTED</i>, and
+<i>java.sql.Connection.TRANSACTION_READ_UNCOMMITTED</i> are available from a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Connection.setTransactionIsolation method</indexterm>
<indexterm>Isolation levels<indexterm>setting via JDBC</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p><i>java.sql.Connection.TRANSACTION_SERIALIZABLE</i>, <i>java.sql.Connection.TRANSACTION_REPEATABLE_READ</i>,
- <i>java.sql.Connection.TRANSACTION_READ_COMMITTED, and </i><i>java.sql.Connection.TRANSACTION_READ_UNCOMMITTED</i> transaction
-isolations are available from a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p></section>
<section><p><i>TRANSACTION_READ_COMMITTED</i> is the default isolation level.</p></section>
<section><p>Changing the current isolation for the connection with <i>setTransactionIsolation</i> commits
the current transaction and begins a new transaction.
Modified: db/derby/docs/trunk/src/ref/rrefjavsqlprst.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavsqlprst.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavsqlprst.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavsqlprst.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefjavsqlprst" xml:lang="en-us">
<title>Prepared statements and streaming columns </title>
+<shortdesc>The <i>setXXXStream</i> methods request stream data between the
+application and the database.</shortdesc>
<prolog><metadata>
<keywords><indexterm>setXXXStream requests</indexterm><indexterm>Streaming
columns<indexterm>as IN parameters to prepared statement</indexterm></indexterm>
@@ -29,8 +31,6 @@ columns<indexterm>as IN parameters to pr
</keywords>
</metadata></prolog>
<refbody>
-<section><p><i>setXXXStream</i> requests stream data between the application
-and the database.</p></section>
<section><p>JDBC allows an IN parameter to be set to a Java input stream for
passing in large amounts of data in smaller chunks. When the statement is
run, the JDBC driver makes repeated calls to this input stream.
Modified: db/derby/docs/trunk/src/ref/rrefjavsqlrssc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjavsqlrssc.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjavsqlrssc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjavsqlrssc.dita Tue Jun 17 19:37:41 2014
@@ -20,18 +20,21 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjavsqlrssc" xml:lang="en-us">
<title>ResultSets and streaming columns </title>
+<shortdesc>If the underlying object is itself an <i>OutputStream</i> class,
+<i>getBinaryStream</i> returns the object directly.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>getXXXStream requests</indexterm><indexterm>Streaming
-columns<indexterm>retrieving from ResultSets using getXXXStream methods</indexterm></indexterm>
-</keywords>
+<keywords><indexterm>getXXXStream requests</indexterm>
+<indexterm>Streaming columns<indexterm>retrieving from ResultSets using getXXXStream methods</indexterm></indexterm>
+<indexterm>getAsciiStream</indexterm>
+<indexterm>getCharacterStream</indexterm>
+<indexterm>getBinaryStream</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>If the underlying object is itself an <i>OutputStream</i> class, <i>getBinaryStream</i> returns
-the object directly.</p></section>
-<section><p><indexterm>getAsciiStream</indexterm><indexterm>getCharacterStream</indexterm><indexterm>getBinaryStream</indexterm>To
-get a field from the <i>ResultSet</i> using streaming columns, you can use
-the <i>getXXXStream</i> methods if the type supports it. See <xref href="rrefjavsqlprst.dita#rrefjavsqlprst/jdbc25312"></xref> for
-a list of types that support the various streams. (See also <xref href="rrefjdbc20377.dita#rrefjdbc20377/jdbc31241"></xref>.)</p></section>
+<section><p>To get a field from the <i>ResultSet</i> using streaming columns,
+you can use the <i>getXXXStream</i> methods if the type supports it. See
+<xref href="rrefjavsqlprst.dita#rrefjavsqlprst/jdbc25312"></xref> for a list of
+types that support the various streams. (See also
+<xref href="rrefjdbc20377.dita#rrefjdbc20377/jdbc31241"></xref>.)</p></section>
<section><p>You can retrieve data from one of the supported data type columns
as a stream, whether or not it was stored as a stream.</p></section>
<section><p>The following code fragment shows how a user can retrieve a LONG VARCHAR
Modified: db/derby/docs/trunk/src/ref/rrefjdbc1020262.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc1020262.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc1020262.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc1020262.dita Tue Jun 17 19:37:41 2014
@@ -20,38 +20,22 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc1020262" xml:lang="en-us">
<title>JDBC escape syntax </title>
+<shortdesc>JDBC provides a way of smoothing out some of the differences in the
+ways different DBMS vendors implement SQL. This is called escape
+syntax.</shortdesc>
<prolog><metadata>
<keywords><indexterm>JDBC escape syntax</indexterm><indexterm>Escape syntax
(JDBC)</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>JDBC provides a way of smoothing out some of the differences in
-the way different DBMS vendors implement SQL. This is called escape syntax.
-Escape syntax signals that the JDBC driver, which is provided by a particular
-vendor, scans for any escape syntax and converts it into the code that the
-particular database understands. This makes escape syntax DBMS-independent.</p></section>
+<section><p>Escape syntax signals that the JDBC driver, which is provided by a
+particular vendor, scans for any escape syntax and converts it into the code
+that the particular database understands. This makes escape syntax
+DBMS-independent.</p></section>
<section><p>A JDBC escape clause begins and ends with curly braces. A keyword
always follows the opening curly brace:</p></section>
<example> <codeblock><b>{ <b><i>keyword</i></b> }</b></codeblock></example>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports
-the following JDBC escape keywords, which are case-insensitive: <ul>
-<li><i><xref href="rrefjdbc70824.dita#rrefjdbc70824"></xref></i> <p>The escape keyword
-for use in <i>CallableStatements</i>.</p></li>
-<li><i><xref href="rrefjdbc28456.dita#rrefjdbc28456"></xref></i> <p>The keyword
-for specifying escape characters for LIKE clauses.</p></li>
-<li><i><xref href="rrefjdbclimit.dita#rrefjdbclimit"></xref></i> <p>The
-escape keywords for specifying limit/offset clauses.</p></li>
-<li><i><xref href="rrefjdbc88908.dita#rrefjdbc88908"></xref></i> <p>The escape keyword
-for scalar functions.</p></li>
-<li><i><xref href="rrefjdbc37244.dita#rrefjdbc37244"></xref></i> <p>The escape keyword
-for outer joins.</p></li>
-<li><i><xref href="rrefjdbc12124.dita#rrefjdbc12124"></xref></i> <p>The escape keyword
-for time formats.</p></li>
-<li><i><xref href="rrefjdbcescapedate.dita#rrefjdbcescapedate"></xref></i> <p>The escape keyword
-for date formats.</p></li>
-<li><i><xref href="rrefjdbc41784.dita#rrefjdbc41784"></xref></i> <p>The escape keyword
-for timestamp formats.</p></li>
-</ul></p></section>
+<section><p>The JDBC escape keywords are case-insensitive.</p></section>
<section><p>Other JDBC escape keywords are not supported. <note><ph conref="../conrefs.dita#prod/productshortname"></ph> returns
the SQL unchanged in the <i>Connection.nativeSQL</i> call, since the escape
syntax is native to SQL. In addition, it is unnecessary to call <i>Statement.setEscapeProcessing</i> for
Modified: db/derby/docs/trunk/src/ref/rrefjdbc10889.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc10889.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc10889.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc10889.dita Tue Jun 17 19:37:41 2014
@@ -20,20 +20,24 @@ limitations under the License.
-->
<reference id="rrefjdbc10889" xml:lang="en-us">
<title>Attributes of the Derby database connection URL </title>
+<shortdesc>You can supply an optional list of attributes to a database
+connection URL.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Database connection URL<indexterm>attributes</indexterm></indexterm>
<indexterm>Database connection URL<indexterm>Properties object</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>You can supply an optional list of attributes to a database connection
-URL. <ph conref="../conrefs.dita#prod/productshortname"></ph> translates these
-attributes into properties, so you can also set attributes in a <i>Properties</i> object
-passed to <i>DriverManager.getConnection</i>. (You cannot set those attributes
-as system properties, only in an object passed to the <i>DriverManager.getConnection</i> method.)
-If you specify any attributes both on the connection URL and in a
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> translates
+these attributes into properties, so you can also set attributes in a
+<i>Properties</i> object passed to <i>DriverManager.getConnection</i>. (You
+cannot set those attributes as system properties, only in an object passed to
+the <i>DriverManager.getConnection</i> method.)</p>
+<p>If you specify any attributes both on the connection URL and in a
<i>Properties</i> object, the attributes on the connection URL override the
-attributes in the <i>Properties</i> object.</p></section>
+attributes in the <i>Properties</i> object.</p>
+</section>
<section><p>These attributes are specific to <ph conref="../conrefs.dita#prod/productshortname"></ph> and
are listed in <xref href="rrefattrib24612.dita#rrefattrib24612"></xref>.</p></section>
<section><p>Attribute name/value pairs are converted into properties and added
Modified: db/derby/docs/trunk/src/ref/rrefjdbc12124.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc12124.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc12124.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc12124.dita Tue Jun 17 19:37:41 2014
@@ -19,16 +19,18 @@ limitations under the License.
-->
<reference id="rrefjdbc12124" xml:lang="en-us">
<title>JDBC escape syntax for time formats</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
+the JDBC escape syntax for time formats as equivalent to the correct SQL syntax
+for times.</shortdesc>
<prolog><metadata>
<keywords><indexterm>t (JDBC escape keyword)</indexterm><indexterm>{t (JDBC
escape syntax)</indexterm><indexterm>JDBC escape syntax for</indexterm><indexterm>Time
formats</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
-the JDBC escape syntax for time as equivalent to the correct SQL syntax for
-times. <ph conref="../conrefs.dita#prod/productshortname"></ph> also supports
-the ISO format of 8 characters (6 digits, and 2 decimal points).</p></section>
+<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> also
+supports the ISO format of 8 characters (6 digits, and 2 decimal
+points).</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>{ t '<i>hh</i>:<i>mm</i>:<i>ss</i>' }</b></codeblock> </refsyn>
<section><title>Equivalent to</title><codeblock><b>TIME('<i>hh</i>:<i>mm</i>:<i>ss</i>')</b></codeblock> </section>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc15905.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc15905.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc15905.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc15905.dita Tue Jun 17 19:37:41 2014
@@ -20,13 +20,13 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc15905" xml:lang="en-us">
<title>java.sql.DatabaseMetaData interface</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> implements
+the <i>java.sql.DatabaseMetaData</i> interface.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.DatabaseMetaData interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>This section discusses <i>java.sql.DatabaseMetaData</i>
-functionality in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-</p>
+<section>
<p>For methods that take a catalog parameter, always specify <i>null</i> for
this parameter, since <ph conref="../conrefs.dita#prod/productshortname"></ph>
does not support catalogs. Similarly, methods that return a catalog in the
Modified: db/derby/docs/trunk/src/ref/rrefjdbc16643.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc16643.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc16643.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc16643.dita Tue Jun 17 19:37:41 2014
@@ -20,20 +20,23 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc16643" xml:lang="en-us">
<title>java.sql.SQLException class</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> supplies
+values for the <i>getMessage</i>, <i>getSQLState</i>, and <i>getErrorCode</i>
+calls of <i>SQLException</i>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.SQLException class</indexterm><indexterm>chaining exceptions</indexterm>
<indexterm>SQLExceptions</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> supplies
-values for the <i>getMessage()</i>, <i>getSQLState()</i>, and <i>getErrorCode()</i> calls
-of <i>SQLExceptions</i>. In addition, <ph conref="../conrefs.dita#prod/productshortname"></ph> sometimes
-returns multiple <i>SQLExceptions</i> using the <i>nextException</i> chain.
-The first exception is always the most severe exception, with SQL-92 Standard
-exceptions preceding those that are specific to <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-For information on processing <i>SQLExceptions</i>, see "Working with <ph
-conref="../conrefs.dita#prod/productshortname"></ph> SQLExceptions in an application"
-in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
+<section><p>In addition,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> sometimes returns
+multiple <i>SQLExceptions</i> using the <i>nextException</i> chain. The first
+exception is always the most severe exception, with SQL-92 Standard exceptions
+preceding those that are specific to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<p>For information on processing <i>SQLExceptions</i>, see "Working with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> SQLExceptions in an
+application" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
<p>Exceptions raised by <ph conref="../conrefs.dita#prod/productshortname"></ph>
will generally be one of the refined subclasses of <i>SQLException</i>. These
refined exceptions are raised under the conditions described by their respective
Modified: db/derby/docs/trunk/src/ref/rrefjdbc20377.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc20377.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc20377.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc20377.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefjdbc20377" xml:lang="en-us">
<title>Mapping of java.sql.Types to SQL types</title>
+<shortdesc>In <ph conref="../conrefs.dita#prod/productshortname"></ph>, the
+<i>java.sql.Types</i> are mapped to SQL data types.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Types<indexterm>mapped to SQL types</indexterm></indexterm>
<indexterm>SQL types<indexterm>mapped to java.sql.Types</indexterm></indexterm>
@@ -31,10 +33,8 @@ data type</indexterm></indexterm></keywo
</metadata></prolog>
<refbody>
<section>
-<p>In <ph conref="../conrefs.dita#prod/productshortname"></ph>, the
-<i>java.sql.Types</i> are mapped to SQL data types.</p>
-<p>The following table shows the mapping of <i>java.sql.Types</i> to
-SQL types.</p>
+<p>The following table shows the mapping of <i>java.sql.Types</i> to SQL
+types.</p>
<table frame="all" id="jdbc31241"><title>Mapping of <i>java.sql.Types</i>
to SQL types</title>
<desc>This table lists the <i>java.sql.Types</i> and shows how they map to SQL types.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc20485.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc20485.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc20485.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc20485.dita Tue Jun 17 19:37:41 2014
@@ -20,13 +20,12 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc20485" xml:lang="en-us">
<title>java.sql.CallableStatement interface</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> supports
+all methods of <i>CallableStatement</i> except <i>setBlob</i>, <i>getBlob</i>,
+<i>setClob</i>, and <i>getClob</i>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.CallableStatement interface</indexterm></keywords>
</metadata></prolog>
-<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports
-all methods of <i>CallableStatement</i> except <i>setBlob</i>, <i>getBlob</i>,
-<i>setClob</i>, and <i>getClob</i>.</p></section>
-</refbody>
+<refbody></refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc23502.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc23502.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc23502.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc23502.dita Tue Jun 17 19:37:41 2014
@@ -20,16 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc23502" xml:lang="en-us">
<title>java.sql.ResultSet interface</title>
+<shortdesc>A positioned update or delete issued against a cursor being accessed
+through a <i>ResultSet</i> object modifies or deletes the current row of the
+<i>ResultSet</i> object.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>java.sql.ResultSet interface</indexterm></keywords>
+<keywords><indexterm>java.sql.ResultSet interface</indexterm>
+<indexterm>Cursors<indexterm>pre-fetching affecting</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>A positioned update or delete issued against a cursor being accessed
-through a <i>ResultSet</i> object modifies or deletes the current row of the <i>ResultSet</i> object.</p></section>
<section><p>Some intermediate protocols might pre-fetch rows. This causes
positioned updates and deletes to operate against the row the underlying cursor
-is on, and not the current row of the <i>ResultSet</i>.<indexterm>Cursors<indexterm>pre-fetching
-affecting</indexterm></indexterm></p></section>
+is on, and not the current row of the <i>ResultSet</i>.</p></section>
<section><p>JDBC does not define the sort of rounding to use for <i>ResultSet.getBigDecimal</i>. <ph
conref="../conrefs.dita#prod/productshortname"></ph> uses <i>java.math.BigDecimal.ROUND_HALF_DOWN</i>.</p></section>
<section>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc27433.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc27433.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc27433.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc27433.dita Tue Jun 17 19:37:41 2014
@@ -21,13 +21,13 @@ limitations under the License.
<reference id="rrefjdbc27433" xml:lang="en-us">
<title><ph conref="../conrefs.dita#prod/productshortname"></ph> database
connection URL syntax</title>
+<shortdesc>A <ph conref="../conrefs.dita#prod/productshortname"></ph> database
+connection URL consists of the basic database connection URL followed by an
+optional subsubprotocol and optional attributes.</shortdesc>
<prolog><metadata>
<keywords><indexterm>database connection URL</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>A <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-connection URL consists of the basic database connection URL followed by an
-optional subsubprotocol and optional attributes.</p></section>
<section><p>The following section provides reference information on the
connection URL syntax for applications with embedded databases. For information
on the connection URL syntax for accessing the Network Server, see "Accessing
Modified: db/derby/docs/trunk/src/ref/rrefjdbc27734.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc27734.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc27734.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc27734.dita Tue Jun 17 19:37:41 2014
@@ -20,19 +20,22 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc27734" xml:lang="en-us">
<title>java.sql.Connection interface</title>
+<shortdesc>A
+<ph conref="../conrefs.dita#prod/productshortname"></ph> <i>Connection</i>
+object is not garbage-collected until all other JDBC objects created from that
+connection are closed or are themselves garbage-collected.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>java.sql.Connection interface</indexterm><indexterm>Connections<indexterm>session-severity
-exceptions closing</indexterm><indexterm>system-severity exceptions closing</indexterm></indexterm>
+<keywords><indexterm>java.sql.Connection interface</indexterm>
+<indexterm>Connections<indexterm>session-severity exceptions closing</indexterm></indexterm>
+<indexterm>Connections<indexterm>system-severity exceptions closing</indexterm></indexterm>
+<indexterm>Connections<indexterm>garbage collection of</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>A <ph conref="../conrefs.dita#prod/productshortname"></ph> <i>Connection</i> object
-is not garbage-collected until all other JDBC objects created from that connection
-are closed or are themselves garbage-collected. Once the connection
-is closed, no further JDBC requests can be made against objects created from
-the connection. Do not explicitly close the <i>Connection</i> object until
-you no longer need it for executing statements.<indexterm>Connections<indexterm>garbage
-collection of</indexterm></indexterm></p></section>
+<section><p>Once the connection is closed, no further JDBC requests can be made
+against objects created from the connection. Do not explicitly close the
+<i>Connection</i> object until you no longer need it for executing
+statements.</p></section>
<section>
<p>The <i>Connection</i> interface extends <i>AutoCloseable</i> in JDK 7 and
after. If you declare a connection in a <i>try</i>-with-resources statement and
Modified: db/derby/docs/trunk/src/ref/rrefjdbc28456.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc28456.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc28456.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc28456.dita Tue Jun 17 19:37:41 2014
@@ -20,16 +20,16 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc28456" xml:lang="en-us">
<title>JDBC escape syntax for LIKE clauses</title>
+<shortdesc>The percent sign (<codeph>%</codeph>) and underscore
+(<codeph>_</codeph>) are metacharacters within SQL LIKE clauses. JDBC provides
+syntax to force these characters to be interpreted literally.</shortdesc>
<prolog><metadata>
<keywords><indexterm>escape (JDBC escape keyword)</indexterm><indexterm>Escape
character for LIKE clauses</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The percent sign (<codeph>%</codeph>) and underscore
-(<codeph>_</codeph>) are metacharacters
-within SQL LIKE clauses. JDBC provides syntax to force these characters to
-be interpreted literally. The JDBC clause immediately following a LIKE expression
-allows you to specify an escape character:</p></section>
+<section><p>The JDBC clause immediately following a LIKE expression allows you
+to specify an escape character.</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>WHERE <i>characterExpression</i> [ NOT ] LIKE
<i>characterExpressionWithWildCard</i>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc29874.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc29874.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc29874.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc29874.dita Tue Jun 17 19:37:41 2014
@@ -20,14 +20,14 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc29874" xml:lang="en-us">
<title>java.sql.PreparedStatement interface</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides all
+the required JDBC type conversions and additionally allows use of the individual
+<i>setXXX</i> methods for each type as if a <i>setObject(Value,
+JDBCTypeCode)</i> invocation were made.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.PreparedStatement interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-all the required JDBC type conversions and additionally allows use of
-the individual <i>setXXX</i> methods for each type as if a <i>setObject(Value,
-JDBCTypeCode)</i> invocation were made. </p></section>
<section><p>This means that <i>setString</i> can be used for any built-in
target type.</p></section>
<section><p>The <i>setCursorName</i> method can be used on a <i>PreparedStatement</i> prior
Modified: db/derby/docs/trunk/src/ref/rrefjdbc30469.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc30469.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc30469.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc30469.dita Tue Jun 17 19:37:41 2014
@@ -20,17 +20,19 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc30469" xml:lang="en-us">
<title>java.sql.SQLWarning class</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> can generate
+a warning in certain circumstances. A warning is generated if, for example, you
+try to connect to a database with the <i>create</i> attribute set to <i>true</i>
+if the database already exists.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.SQLWarning class</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> can generate
-a warning in certain circumstances. A warning is generated if, for example,
-you try to connect to a database with the <i>create</i> attribute set to <i>true</i> if
-the database already exists. Aggregates like sum() also raise a warning if
-NULL values are encountered during the evaluation.</p></section>
-<section><p>All other informational messages are written to the <ph conref="../conrefs.dita#prod/productshortname"></ph> system's <i>derby.log</i
-> file.</p></section>
+<section><p>Aggregates like SUM also raise a warning if NULL values are
+encountered during the evaluation.</p></section>
+<section><p>All other informational messages are written to the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system's
+<i>derby.log</i> file.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc32052.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc32052.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc32052.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc32052.dita Tue Jun 17 19:37:41 2014
@@ -19,20 +19,21 @@ limitations under the License.
-->
<reference id="rrefjdbc32052" xml:lang="en-us">
<title>java.sql.Driver interface</title>
+<shortdesc>The class that loads
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s local JDBC driver is
+the class <i>org.apache.derby.jdbc.EmbeddedDriver</i>. The class that loads
+<ph conref="../conrefs.dita#prod/productshortname"></ph>'s network client driver
+is the class <i>org.apache.derby.jdbc.ClientDriver</i>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Driver interface</indexterm>
<indexterm>JDBC driver<indexterm>loading</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The class that loads <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-local JDBC driver is the class <i>org.apache.derby.jdbc.EmbeddedDriver</i>.
-The class that loads <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
-network client driver is the class <i>org.apache.derby.jdbc.ClientDriver</i>.
-Usually, you will not need to create an instance of one of these classes,
-because the driver class is loaded and registered automatically when the
-<i>java.sql.DriverManager</i> class is initialized. That typically happens on
-the first call to a <i>DriverManager</i> method such as
+<section><p>Usually, you will not need to create an instance of one of these
+classes, because the driver class is loaded and registered automatically when
+the <i>java.sql.DriverManager</i> class is initialized. That typically happens
+on the first call to a <i>DriverManager</i> method such as
<i>DriverManager.getConnection</i>. This section describes a few exceptions to
this rule.</p>
<p>With the embedded driver, if your application shuts down
Modified: db/derby/docs/trunk/src/ref/rrefjdbc34565.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc34565.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc34565.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc34565.dita Tue Jun 17 19:37:41 2014
@@ -20,16 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc34565" xml:lang="en-us">
<title>java.sql.DriverManager.getConnection method</title>
+<shortdesc>A Java application that uses the JDBC API establishes a connection to
+a database by obtaining a <i>Connection</i> object. The standard way to obtain a
+<i>Connection</i> object is to call the method
+<i>DriverManager.getConnection</i>, which takes a <i>String</i> that contains a
+database connection URL.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.DriverManager.getConnection method</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>A Java application using the JDBC API establishes a connection
-to a database by obtaining a <i>Connection</i> object. The standard way to
-obtain a <i>Connection</i> object is to call the method <i>DriverManager.getConnection</i>,
-which takes a String containing a database connection URL. A JDBC database
-connection URL (uniform resource locator) provides a way of identifying a
-database.</p></section>
+<section><p>A JDBC database connection URL (uniform resource locator) provides a
+way of identifying a database.</p></section>
<section><p><i>DriverManager.getConnection</i> can take one argument besides
a database connection URL, a <i>Properties</i> object. You can use the <i>Properties</i> object
to set database connection URL attributes. If you specify any attributes both on
Modified: db/derby/docs/trunk/src/ref/rrefjdbc34954.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc34954.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc34954.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc34954.dita Tue Jun 17 19:37:41 2014
@@ -20,12 +20,12 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc34954" xml:lang="en-us">
<title>java.sql.Driver.getPropertyInfo method</title>
+<shortdesc>To get the <i>DriverPropertyInfo</i> object, request the JDBC driver
+from the driver manager.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Driver.getPropertyInfo method</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>To get the <i>DriverPropertyInfo</i> object, request the JDBC
-driver from the driver manager:</p></section>
<example> <codeblock><b>java.sql.DriverManager.getDriver("jdbc:derby:").
getPropertyInfo(<b><i>URL</i></b>, <b><i>Prop</i></b>)</b></codeblock></example>
<section><p>Do not request it from <i>org.apache.derby.jdbc.EmbeddedDriver</i>,
Modified: db/derby/docs/trunk/src/ref/rrefjdbc37244.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc37244.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc37244.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc37244.dita Tue Jun 17 19:37:41 2014
@@ -20,16 +20,18 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc37244" xml:lang="en-us">
<title>JDBC escape syntax for outer joins</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
+the JDBC escape syntax for outer joins (and all join operations) as equivalent
+to the correct SQL syntax for outer joins or the appropriate join
+operation.</shortdesc>
<prolog><metadata>
<keywords><indexterm>oj (JDBC escape keyword)</indexterm><indexterm>{oj (JDBC
escape syntax)</indexterm><indexterm>Outer joins<indexterm>JDBC escape syntax
for</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
-the JDBC escape syntax for outer joins (and all join operations) as equivalent
-to the correct SQL syntax for outer joins or the appropriate join operation.</p> <p>For
-information about join operations, see <xref href="rrefsqlj29840.dita#rrefsqlj29840"></xref>.</p></section>
+<section><p>For information about join operations, see
+<xref href="rrefsqlj29840.dita"/>.</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>{ oj <i><xref href="rrefsqlj29840.dita#rrefsqlj29840">joinOperation</xref></i> [ <i><xref
href="rrefsqlj29840.dita#rrefsqlj29840">joinOperation</xref></i> ]* }</b></codeblock> </refsyn>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc37352.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc37352.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc37352.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc37352.dita Tue Jun 17 19:37:41 2014
@@ -21,6 +21,8 @@ limitations under the License.
<reference id="rrefjdbc37352" xml:lang="en-us">
<title>Syntax of database connection URLs for applications with embedded
databases</title>
+<shortdesc>For applications with embedded databases, the syntax of the database
+connection URL is as follows.</shortdesc>
<prolog><metadata>
<keywords><indexterm>database connection URL<indexterm>syntax in embedded
mode</indexterm></indexterm>
@@ -30,9 +32,9 @@ syntax</indexterm></indexterm>
from</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>For applications with embedded databases, the syntax of the database
-connection URL is</p>
+<section>
<codeblock><b>jdbc:derby:[<b><i>subsubprotocol:</i></b>][<i>databaseName</i>][;<b><i>attributes</i></b>]*</b></codeblock>
+<p>This syntax has the following components.</p>
<ul>
<li><codeph>jdbc:derby:</codeph>
<p>In JDBC terminology, <codeph>derby</codeph> is the <i>subprotocol</i> for
Modified: db/derby/docs/trunk/src/ref/rrefjdbc38274.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc38274.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc38274.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc38274.dita Tue Jun 17 19:37:41 2014
@@ -19,14 +19,15 @@ limitations under the License.
-->
<reference id="rrefjdbc38274" xml:lang="en-us">
<title>java.sql.ResultSetMetaData interface</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> does not
+track the source or updatability of columns in <i>ResultSets</i>, and so always
+returns the constants shown for the methods listed in the following
+table.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.ResultSetMetaData interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not track the source or updatability of columns in <i>ResultSets</i>, and
-so always returns the constants shown for the methods listed in the
-following table.</p>
+<section>
<table frame="all">
<title>Implementation notes on <i>ResultSetMetadata</i> methods</title>
<desc>This table lists the implementation-specific return type for three <i>ResultSetMetadata</i> methods.</desc>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc40794.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc40794.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc40794.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc40794.dita Tue Jun 17 19:37:41 2014
@@ -19,14 +19,15 @@ limitations under the License.
-->
<reference id="rrefjdbc40794" xml:lang="en-us">
<title>java.sql.Statement interface</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> does not
+implement the <i>setEscapeProcessing</i> method of <i>java.sql.Statement</i>.
+In addition, the <i>cancel</i> method raises a "Feature not supported"
+exception.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Statement interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not implement the <i>setEscapeProcessing</i> method of <i>java.sql.Statement</i>.
-In addition, the <i>cancel</i> method raises a "Feature not supported"
-exception.</p>
+<section>
<p>The following table describes features of <i>Statement</i> methods that are
specific to <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<table frame="all">
Modified: db/derby/docs/trunk/src/ref/rrefjdbc41784.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc41784.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc41784.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc41784.dita Tue Jun 17 19:37:41 2014
@@ -20,15 +20,16 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc41784" xml:lang="en-us">
<title>JDBC escape syntax for timestamp formats</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
+the JDBC escape syntax for timestamp formats as equivalent to the correct SQL
+syntax for timestamps.</shortdesc>
<prolog><metadata>
<keywords><indexterm>ts (JDBC escape keyword)</indexterm><indexterm>{ts (JDBC
escape syntax)</indexterm><indexterm>Timestamp formats<indexterm>JDBC escape
syntax for</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
-the JDBC escape syntax for timestamp as equivalent to the correct SQL syntax
-for timestamps. <ph conref="../conrefs.dita#prod/productshortname"></ph> also
+<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> also
supports the ISO format of 23 characters (17 digits, 3 dashes, and 3 decimal
points).</p></section>
<refsyn><title>Syntax</title>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_1connection.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_1connection.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_1connection.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_1connection.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_1connection" xml:lang="en-us">
<title>java.sql.Connection interface: JDBC 4.1 features</title>
+<shortdesc>JDBC 4.1 adds new features to the <i>Connection</i>
+interface.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>Connection interface</indexterm>
@@ -28,9 +30,6 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>
-JDBC 4.1 adds new features to the <i>Connection</i> interface:
-</p>
<ul>
<li><b>Aborting connections</b> - The <i>abort(Executor)</i> method aborts
a running connection. Outstanding transactional work is rolled back, and the
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_1summary.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_1summary.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_1summary.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_1summary.dita Tue Jun 17 19:37:41 2014
@@ -20,17 +20,16 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_1summary" xml:lang="en-us">
<title>Features supported on JDBC 4.1 and above</title>
+<shortdesc>JDBC 4.1 added some functionality to the core API. This section
+documents the JDBC 4.1 features supported by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>JDBC 4.1</indexterm>
-<indexterm>JDBC 4.2</indexterm>
</keywords>
</metadata></prolog>
<refbody>
<section>
-<p>JDBC 4.1 added some functionality to the core API. This section
-documents the JDBC 4.1 features supported by
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<p>For information on features supported by all releases of JDBC 4, see
<xref href="crefjdbc12657.dita#crefjdbc12657"></xref>. For information
about features supported only by JDBC 4.2, see
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_2compactprofiles.dita Tue Jun 17 19:37:41 2014
@@ -19,15 +19,16 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_2compactprofiles" xml:lang="en-us">
<title>JDBC support for Java SE 8 Compact Profiles</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
+support for Compact Profiles on the Java SE 8 platform by means of a group of
+JDBC DataSource classes.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Compact Profiles<indexterm>JDBC support</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-support for Compact Profiles on the Java SE 8 platform by means of a
-group of JDBC DataSource classes. These DataSource classes cannot be used in
-applications that use the Java Naming and Directory Interface (JNDI) API.
-Otherwise, they are just like the versions for the full Java SE platform.</p>
+<section><p>These DataSource classes cannot be used in applications that use the
+Java Naming and Directory Interface (JNDI) API. Otherwise, they are just like
+the versions for the full Java SE platform.</p>
<p>Applications using Java SE 8 Compact Profile 2 <i>must</i> use these classes.
Applications using Java SE 8 Compact Profile 3 can use the ordinary DataSource
classes. (Compact Profile 1 does not provide any JDBC support, so
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_2databasemetadata.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_2databasemetadata.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_2databasemetadata.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_2databasemetadata.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_2databasemetadata" xml:lang="en-us">
<title>java.sql.DatabaseMetaData interface: JDBC 4.2 features</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> implements
+all of the new metadata methods added by JDBC 4.2.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>JDBC 4.2<indexterm>DatabaseMetaData interface</indexterm></indexterm>
@@ -27,16 +29,11 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>
-<ph conref="../conrefs.dita#prod/productshortname"></ph> implements all of the
-new metadata methods added by JDBC 4.2.
-</p>
<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> implementation
-of the <i>getMaxLogicalLOBSize()</i> method returns zero (0). For details on
-the meaningful limits on
-<ph conref="../conrefs.dita#prod/productshortname"></ph>'s BLOB and CLOB
-datatypes, see <xref href="rrefblob.dita#rrefblob"></xref> and
-<xref href="rrefclob.dita#rrefclob"></xref>.
+of the <i>getMaxLogicalLOBSize</i> method returns zero (0). For details on the
+meaningful limits on <ph conref="../conrefs.dita#prod/productshortname"></ph>'s
+BLOB and CLOB datatypes, see <xref href="rrefblob.dita"/> and
+<xref href="rrefclob.dita"/>.
</p>
</section>
</refbody>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_2sqltype.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_2sqltype.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_2sqltype.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_2sqltype.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,10 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_2sqltype" xml:lang="en-us">
<title>java.sql.SQLType interface</title>
+<shortdesc>JDBC 4.2 introduces a new data type identifier,
+<i>java.sql.SQLType</i>, to help databases describe data types which do not
+appear in the ANSI/ISO SQL Standard. Databases which provide non-standard types
+can provide their own implementations of <i>SQLType</i>.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>JDBC 4.2<indexterm>SQLType interface</indexterm></indexterm>
@@ -28,12 +32,8 @@ limitations under the License.
<refbody>
<section>
<p>
-JDBC 4.2 introduces a new data type identifier, <i>java.sql.SQLType</i>, to help
-databases describe data types which do not appear in the ANSI/ISO SQL Standard.
-Databases which provide non-standard types can provide their own
-implementations of <i>SQLType</i>. JDBC 4.2 also supplies its own
-implementation, <i>java.sql.JDBCType</i>, which provides an enum for each of the
-type identifiers in <i>java.sql.Types</i>.
+JDBC 4.2 also supplies its own implementation, <i>java.sql.JDBCType</i>, which
+provides an enum for each of the type identifiers in <i>java.sql.Types</i>.
</p><p>
<ph conref="../conrefs.dita#prod/productshortname"></ph> does not expose any
datatypes which are not represented by <i>JDBCType</i> enums. Therefore,
Modified: db/derby/docs/trunk/src/ref/rrefjdbc4_2summary.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc4_2summary.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc4_2summary.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc4_2summary.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,9 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc4_2summary" xml:lang="en-us">
<title>JDBC 4.2-only features</title>
+<shortdesc>JDBC 4.2 adds some functionality to the core API. This section
+documents the JDBC 4.2 features supported by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>JDBC 4.2</indexterm>
@@ -27,9 +30,6 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>JDBC 4.2 adds some functionality to the core API. This section
-documents the JDBC 4.2 features supported by
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
<p>For information on features supported by all versions of JDBC 4, see
<xref href="crefjdbc12657.dita#crefjdbc12657"></xref>. For information
on features supported by both JDBC 4.1 and JDBC 4.2, see
Modified: db/derby/docs/trunk/src/ref/rrefjdbc70824.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc70824.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc70824.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc70824.dita Tue Jun 17 19:37:41 2014
@@ -20,13 +20,14 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc70824" xml:lang="en-us">
<title>JDBC escape keyword for call statements</title>
+<shortdesc>This escape syntax is supported for a <i>java.sql.Statement</i> and
+a <i>java.sql.PreparedStatement </i>in addition to a
+<i>CallableStatement</i>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>call (JDBC escape keyword)</indexterm><indexterm>{call
(JDBC escape syntax)</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>This syntax is supported for a <i>java.sql.Statement</i> and
-a <i>java.sql.PreparedStatement </i>in addition to a <i>CallableStatement</i>.</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>{ call <i>statement</i> }</b></codeblock> </refsyn>
<example><title>Example</title>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc75719.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc75719.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc75719.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc75719.dita Tue Jun 17 19:37:41 2014
@@ -20,14 +20,14 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbc75719" xml:lang="en-us">
<title>CallableStatements and INOUT parameters </title>
+<shortdesc>INOUT parameters map to an <i>array</i> of the parameter type in the
+Java programming language. (The method must take an array as its parameter.)
+This conforms to the recommendations of the SQL standard.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.CallableStatement<indexterm>and INOUT parameters</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>INOUT parameters map to an <i>array</i> of the parameter type
-in the Java programming language. (The method must take an array as its parameter.) This conforms to
-the recommendations of the SQL standard.</p></section>
<section><p>Given the following example: <codeblock expanse="column"><b>CallableStatement call = conn.prepareCall(
"{CALL doubleMyInt(?)}");
<ph>// for inout parameters, it is good practice to
Modified: db/derby/docs/trunk/src/ref/rrefjdbc88908.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc88908.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc88908.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc88908.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefjdbc88908" xml:lang="en-us">
<title>JDBC escape syntax for fn keyword</title>
+<shortdesc>You can specify functions in JDBC escape syntax by using the
+<codeph>fn</codeph> keyword.</shortdesc>
<prolog><metadata>
<keywords><indexterm>fn<indexterm>JDBC escape keyword</indexterm></indexterm>
<indexterm>JDBC<indexterm>escape keyword</indexterm></indexterm>
@@ -66,8 +68,6 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>You can specify functions in JDBC escape syntax by using the
-<codeph>fn</codeph> keyword.</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>{ fn <i>functionCall</i> }</b></codeblock>
<p>where <i>functionCall</i> is the name of one of the scalar functions listed
Modified: db/derby/docs/trunk/src/ref/rrefjdbc96386.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc96386.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc96386.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc96386.dita Tue Jun 17 19:37:41 2014
@@ -19,16 +19,17 @@ limitations under the License.
-->
<reference id="rrefjdbc96386" xml:lang="en-us">
<title>Mapping of java.sql.Blob and java.sql.Clob interfaces</title>
+<shortdesc>In the JDBC API, <i>java.sql.Blob</i> is the mapping for the SQL BLOB
+(binary large object) type; <i>java.sql.Clob</i> is the mapping for the SQL CLOB
+(character large object) type. BLOB and CLOB objects are collectively referred
+to as LOBs (large objects).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>java.sql.Blob interface</indexterm><indexterm>java.sql.Clob interface</indexterm>
+<keywords><indexterm>java.sql.Blob interface</indexterm>
+<indexterm>java.sql.Clob interface</indexterm>
<indexterm>BLOB data type</indexterm><indexterm>CLOB data type</indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>In the JDBC API, <i>java.sql.Blob</i> is the mapping for the SQL BLOB
-(binary large object) type; <i>java.sql.Clob</i> is the mapping for the SQL
-CLOB (character large object) type. BLOB and CLOB objects are collectively
-referred to as LOBs (large objects).</p></section>
<section><p>The <ph conref="../conrefs.dita#prod/productshortname"></ph>
implementation of the <i>java.sql.Blob</i> and <i>java.sql.Clob</i> interfaces
is LOCATOR-based, meaning that the implementation provides a logical pointer to
Modified: db/derby/docs/trunk/src/ref/rrefjdbcescapedate.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbcescapedate.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbcescapedate.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbcescapedate.dita Tue Jun 17 19:37:41 2014
@@ -19,15 +19,15 @@ limitations under the License.
-->
<reference id="rrefjdbcescapedate" xml:lang="en-us">
<title>JDBC escape syntax for date formats</title>
+<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
+the JDBC escape syntax for date formats as equivalent to the correct SQL syntax
+for dates.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Date formats<indexterm>JDBC escape syntax for</indexterm></indexterm>
<indexterm>d (JDBC escape keyword)</indexterm><indexterm>{d (JDBC escape syntax)</indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section> <p><ph conref="../conrefs.dita#prod/productshortname"></ph> interprets
-the JDBC escape syntax for dates as equivalent to the correct SQL syntax for
-dates.</p></section>
<refsyn><title>Syntax</title>
<codeblock><b>{ d '<i>yyyy</i>-<i>mm</i>-<i>dd</i>' }</b></codeblock> </refsyn>
<section><title>Equivalent to</title>
Modified: db/derby/docs/trunk/src/ref/rrefjdbcjavasqlsavepoint.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbcjavasqlsavepoint.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbcjavasqlsavepoint.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbcjavasqlsavepoint.dita Tue Jun 17 19:37:41 2014
@@ -20,17 +20,18 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbcjavasqlsavepoint" xml:lang="en-us">
<title>java.sql.Savepoint interface</title>
+<shortdesc>The <i>Savepoint</i> interface contains methods to set, release, or
+roll back a transaction to designated savepoints. Once a savepoint has been set,
+the transaction can be rolled back to that savepoint without affecting preceding
+work.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Savepoint</indexterm><indexterm>Savepoints (JDBC)</indexterm>
<indexterm>Savepoints<indexterm>setting and rollong back</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <i>Savepoint</i> interface contains
-methods to set, release, or roll back a transaction to designated savepoints.
-Once a savepoint has been set, the transaction can be rolled back to that
-savepoint without affecting preceding work. Savepoints provide finer-grained
-control of transactions by marking intermediate points within a transaction.</p>
+<section><p>Savepoints provide finer-grained control of transactions by marking
+intermediate points within a transaction.</p>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> does not support
savepoints within a trigger.</p>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> does not release
Modified: db/derby/docs/trunk/src/ref/rrefjdbclimit.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbclimit.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbclimit.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbclimit.dita Tue Jun 17 19:37:41 2014
@@ -20,6 +20,8 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefjdbclimit" xml:lang="en-us">
<title>JDBC escape syntax for limit/offset clauses</title>
+<shortdesc>The LIMIT escape clause can occur in a query at the point where an
+OFFSET/FETCH FIRST clause can appear.</shortdesc>
<prolog><metadata>
<keywords><indexterm>LIMIT (JDBC escape keyword)</indexterm>
<indexterm>OFFSET (JDBC escape keyword)</indexterm>
@@ -27,10 +29,8 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>The LIMIT escape clause can occur in a query at the point where an
-OFFSET/FETCH FIRST clause can appear. See
-<xref href="rrefsqljoffsetfetch.dita#rrefsqljoffsetfetch"></xref> for more
-information.</p>
+<p>See <xref href="rrefsqljoffsetfetch.dita#rrefsqljoffsetfetch"></xref> for
+more information.</p>
</section>
<refsyn><title>Syntax</title>
<codeblock><b>{ LIMIT <i>rowCount</i> [ OFFSET <i>startRow</i> ] }</b></codeblock>
Modified: db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita Tue Jun 17 19:37:41 2014
@@ -20,19 +20,23 @@ limitations under the License.
-->
<reference id="rrefjdbcrefsqlxml" xml:lang="en-us">
<title>java.sql.SQLXML interface</title>
+<shortdesc>The <i>java.sql.SQLXML</i> interface is the mapping for the SQL XML
+data type. However, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+defines the XML data type and operators only in the SQL layer. There is no
+JDBC-side support for the XML data type and operators.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.SQLXML interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>The <i>java.sql.SQLXML</i> interface is the mapping for the SQL XML data
-type. However, <ph conref="../conrefs.dita#prod/productshortname"></ph> defines
-the XML data type and operators only in the SQL layer. There is no JDBC-side
-support for the XML data type and operators.</p><p>You cannot instantiate a
-<i>java.sql.SQLXML</i> object in <ph conref="../conrefs.dita#prod/productshortname"></ph>,
-or bind directly into an XML value or retrieve an XML value directly from
-a result set. You must bind and retrieve the XML data as Java strings or
-character streams by explicitly specifying the XML operators, XMLPARSE and
-XMLSERIALIZE, as part of your SQL queries. </p><p>Additionally, <ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not provide JDBC metadata support for the XML data type.</p></section>
+<section><p>You cannot instantiate a <i>java.sql.SQLXML</i> object in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, or bind directly into
+an XML value or retrieve an XML value directly from a result set. You must bind
+and retrieve the XML data as Java strings or character streams by explicitly
+specifying the XML operators, <xref href="rreffuncxmlparse.dita">XMLPARSE</xref>
+and <xref href="rreffuncxmlserialize.dita">XMLSERIALIZE</xref>, as part of your
+SQL queries.</p>
+<p>Additionally, <ph conref="../conrefs.dita#prod/productshortname"></ph> does
+not provide JDBC metadata support for the
+<xref href="rrefsqljtypexml.dita">XML data type</xref>.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefso2.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefso2.dita?rev=1603273&r1=1603272&r2=1603273&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefso2.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefso2.dita Tue Jun 17 19:37:41 2014
@@ -20,20 +20,20 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefso2" xml:lang="en-us">
<title>ResultSet objects </title>
+<shortdesc>An error that occurs when a SELECT statement is first executed
+prevents a <i>ResultSet</i> object from being opened on it. The same error does
+not close the <i>ResultSet</i> if it occurs after the <i>ResultSet</i> has been
+opened.</shortdesc>
<prolog><metadata>
<keywords><indexterm>ResultSets<indexterm>errors in statement affecting creation
of</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>An error that occurs when a SELECT statement is first executed
-prevents a <i>ResultSet</i> object from being opened on it. The same error
-does not close the <i>ResultSet</i> if it occurs after the <i>ResultSet</i> has
-been opened.</p></section>
-<section><p>For example, a divide-by-zero error that happens while the <i>executeQuery</i> method
-is called on a <i>java.sql.Statement</i> or <i>java.sql.PreparedStatement</i> throws
-an exception and returns no result set at all, while if the same error happens
-while the <i>next</i> method is called on a <i>ResultSet</i> object, it does
-not cause the result set to be closed.</p></section>
+<section><p>For example, a divide-by-zero error that happens while the
+<i>executeQuery</i> method is called on a <i>java.sql.Statement</i> or
+<i>java.sql.PreparedStatement</i> throws an exception and returns no result set
+at all, while if the same error happens while the <i>next</i> method is called
+on a <i>ResultSet</i> object, it does not cause the result set to be closed.</p></section>
<section><p>Errors can happen when a <i>ResultSet</i> is first being created
if the system partially executes the query before the first row is fetched.
This can happen on any query that uses more than one table and on queries