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 jt...@apache.org on 2006/08/25 19:22:14 UTC
svn commit: r436862 [1/2] - /db/derby/docs/trunk/src/ref/
Author: jta
Date: Fri Aug 25 10:22:11 2006
New Revision: 436862
URL: http://svn.apache.org/viewvc?rev=436862&view=rev
Log:
DERBY-1655 : Added XML documentation to the Reference Manual.
Committed patch derby1655_ref6.diff by Laura Stewart <sc...@gmail.com>.
Added:
db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita (with props)
db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita (with props)
db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita (with props)
db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita (with props)
db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita (with props)
db/derby/docs/trunk/src/ref/rreflimitsxml.dita (with props)
db/derby/docs/trunk/src/ref/rrefsqljtypexml.dita (with props)
Modified:
db/derby/docs/trunk/src/ref/crefjdbc12657.dita
db/derby/docs/trunk/src/ref/refderby.ditamap
db/derby/docs/trunk/src/ref/rrefbuiltchar.dita
db/derby/docs/trunk/src/ref/rrefcreatefunctionstatement.dita
db/derby/docs/trunk/src/ref/rrefcreateprocedurestatement.dita
db/derby/docs/trunk/src/ref/rrefdatefunc.dita
db/derby/docs/trunk/src/ref/rrefdayfunc.dita
db/derby/docs/trunk/src/ref/rrefdeclaretemptable.dita
db/derby/docs/trunk/src/ref/rrefexcept71493.dita
db/derby/docs/trunk/src/ref/rrefhourfunc.dita
db/derby/docs/trunk/src/ref/rrefjdbc20377.dita
db/derby/docs/trunk/src/ref/rrefminutefunc.dita
db/derby/docs/trunk/src/ref/rrefmonthfunc.dita
db/derby/docs/trunk/src/ref/rrefsecondfunc.dita
db/derby/docs/trunk/src/ref/rrefsqlj33562.dita
db/derby/docs/trunk/src/ref/rrefsqlj58560.dita
db/derby/docs/trunk/src/ref/rreftimefunc.dita
db/derby/docs/trunk/src/ref/rreftimestampfunc.dita
Modified: db/derby/docs/trunk/src/ref/crefjdbc12657.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefjdbc12657.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefjdbc12657.dita (original)
+++ db/derby/docs/trunk/src/ref/crefjdbc12657.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,21 +18,19 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
- "../dtd/concept.dtd">
<concept id="crefjdbc12657" xml:lang="en-us">
<title>JDBC Reference</title>
+<shortdesc><ph conref="refconrefs.dita#prod/productshortname"></ph> comes
+with a built-in JDBC driver. </shortdesc>
<prolog><metadata>
<keywords><indexterm>JDBC API<indexterm>Derby implementation of</indexterm></indexterm>
</keywords>
</metadata></prolog>
<conbody>
-<p><ph conref="refconrefs.dita#prod/productshortname"></ph> comes with a built-in
-JDBC driver. That makes the JDBC API the only API for working with <ph conref="refconrefs.dita#prod/productshortname"></ph> databases.
+<p>That makes the JDBC API the only API for working with <ph conref="refconrefs.dita#prod/productshortname"></ph> databases.
The driver is a native protocol all-Java driver (type number four of types
defined by Sun).</p>
-<p>This chapter provides reference information about <ph conref="refconrefs.dita#prod/productshortname"></ph>'s
+<p>This section provides reference information about <ph conref="refconrefs.dita#prod/productshortname"></ph>'s
implementation of the JDBC API and documents the way it conforms to the JDBC
2.0, 3.0, and 4.0 APIs.</p>
<p>See the <cite><ph conref="refconrefs.dita#pub/citdevelop"></ph></cite> for
@@ -64,8 +65,6 @@
and supplies all the required JDBC interfaces. Unimplemented aspects of the
JDBC driver return an <i>SQLException</i> with a message stating "Feature
not implemented" and an <i>SQLState</i> of XJZZZ. These unimplemented parts
-are for features not supported by <ph conref="refconrefs.dita#prod/productshortname"></ph>.
-</p>
+are for features not supported by <ph conref="refconrefs.dita#prod/productshortname"></ph>. </p>
</conbody>
</concept>
-
Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Fri Aug 25 10:22:11 2006
@@ -243,6 +243,11 @@
<topicref href="rrefsqlj29930.dita" navtitle="UCASE or UPPER"></topicref>
<topicref href="rrefsqlj42476.dita" navtitle="USER"></topicref>
<topicref href="rrefbuiltvarchar.dita" navtitle="VARCHAR"></topicref>
+<topicref href="rreffuncxmlexists.dita" navtitle="XMLEXISTS operator"></topicref>
+<topicref href="rreffuncxmlparse.dita" navtitle="XMLPARSE operator"></topicref>
+<topicref href="rreffuncxmlquery.dita" navtitle="XMLQUERY operator"></topicref>
+<topicref href="rreffuncxmlserialize.dita" navtitle="XMLSERIALIZE operator">
+</topicref>
<topicref href="rrefyearfunc.dita" navtitle="YEAR"></topicref>
</topicref>
<topicref collection-type="family" href="crefsqlbuiltinsystemfunctions.dita"
@@ -326,6 +331,7 @@
<topicref href="rrefsqlj27620.dita" navtitle="TIMESTAMP"></topicref>
<topicref href="rrefsqlj41207.dita" navtitle="VARCHAR"></topicref>
<topicref href="rrefsqlj32714.dita" navtitle="VARCHAR FOR BIT DATA"></topicref>
+<topicref href="rrefsqljtypexml.dita" navtitle="XML data type"></topicref>
</topicref>
<topicref collection-type="family" href="rrefsqlj19433.dita" navtitle="SQL expressions">
<topicref collection-type="family" href="rrefsqlj1080779.dita" navtitle="Expression precedence">
@@ -408,24 +414,25 @@
<topicref collection-type="family" href="rrefjdbc40794.dita" navtitle="java.sql.Statement ">
<topicref href="rrefso2.dita" navtitle="ResultSet objects "></topicref>
</topicref>
-<topicref collection-type="family" href="rrefjdbc29874.dita" navtitle="java.sql.PreparedStatement ">
-<topicref href="rrefjavsqlprst.dita" navtitle="Prepared statements and streaming columns ">
-</topicref>
-</topicref>
<topicref collection-type="family" href="rrefjdbc20485.dita" navtitle="java.sql.CallableStatement ">
<topicref href="rrefjavcallstatout.dita" navtitle="CallableStatements and OUT Parameters ">
</topicref>
<topicref href="rrefjdbc75719.dita" navtitle="CallableStatements and INOUT Parameters ">
</topicref>
</topicref>
+<topicref href="rrefjdbc16643.dita" navtitle="java.sql.SQLException "></topicref>
+<topicref collection-type="family" href="rrefjdbc29874.dita" navtitle="java.sql.PreparedStatement ">
+<topicref href="rrefjavsqlprst.dita" navtitle="Prepared statements and streaming columns ">
+</topicref>
+</topicref>
<topicref collection-type="family" href="rrefjdbc23502.dita" navtitle="java.sql.ResultSet ">
<topicref href="rrefjavsqlrssc.dita" navtitle="ResultSets and streaming columns ">
</topicref>
</topicref>
<topicref href="rrefjdbc38274.dita" navtitle="java.sql.ResultSetMetaData ">
</topicref>
-<topicref href="rrefjdbc16643.dita" navtitle="java.sql.SQLException "></topicref>
<topicref href="rrefjdbc30469.dita" navtitle="java.sql.SQLWarning "></topicref>
+<topicref href="rrefjdbcrefsqlxml.dita" navtitle="java.sql.SQLXML"></topicref>
<topicref href="rrefjdbc20377.dita" navtitle="Mapping of java.sql.Types to SQL types">
</topicref>
<topicref collection-type="family" href="rrefjdbc96386.dita" navtitle="java.sql.Blob and java.sql.Clob">
@@ -547,14 +554,15 @@
</topicref>
<topicref href="rrefsqlj75638.dita" navtitle="Supported territories "></topicref>
<topicref collection-type="family" href="rreflimits.dita" navtitle="Derby limitations">
-<topicref href="rrefidlengthlimits.dita" navtitle="Limitations on identifier length ">
+<topicref href="rrefdbmlimits.dita" navtitle="Limitations for database manager values">
</topicref>
-<topicref href="rrefnumericlimits.dita" navtitle="Numeric limitations"></topicref>
-<topicref href="rrefstringlimits.dita" navtitle="String limitations"></topicref>
<topicref href="rrefdttlimits.dita" navtitle="DATE, TIME, and TIMESTAMP limitations">
</topicref>
-<topicref href="rrefdbmlimits.dita" navtitle="Limitations for database manager values">
+<topicref href="rrefidlengthlimits.dita" navtitle="Limitations on identifier length ">
</topicref>
+<topicref href="rrefnumericlimits.dita" navtitle="Numeric limitations"></topicref>
+<topicref href="rrefstringlimits.dita" navtitle="String limitations"></topicref>
+<topicref href="rreflimitsxml.dita" navtitle="XML limitations"></topicref>
</topicref>
<topicref href="rreftrademderby.dita" navtitle="Trademarks"></topicref>
</map>
Modified: db/derby/docs/trunk/src/ref/rrefbuiltchar.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbuiltchar.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbuiltchar.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbuiltchar.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,27 +18,26 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefbuiltchar" xml:lang="en-us">
<title>CHAR</title>
+<shortdesc>The CHAR function returns a fixed-length character string representation.</shortdesc>
<prolog><metadata>
<keywords><indexterm>CHAR function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>The CHAR function returns a fixed-length character string representation
-of: <ul>
-<li>a character string, if the first argument is any type of character string.</li>
-<li>a datetime value, if the first argument is a date, time, or timestamp.</li>
-<li>a decimal number, if the first argument is a decimal number.</li>
-<li>a double-precision floating-point number, if the first argument is a DOUBLE
+<section>The representations are: <ul>
+<li>A character string, if the first argument is any type of character string.</li>
+<li>A datetime value, if the first argument is a date, time, or timestamp.</li>
+<li>A decimal number, if the first argument is a decimal number.</li>
+<li>A double-precision floating-point number, if the first argument is a DOUBLE
or REAL. </li>
-<li>an integer number, if the first argument is a SMALLINT, INTEGER, or BIGINT.</li>
+<li>An integer number, if the first argument is a SMALLINT, INTEGER, or BIGINT.</li>
</ul>The first argument must be of a built-in data type. The result of the
-function is a fixed-length character string. If the first argument can be
-null, the result can be null. If the first argument is null, the result is
-the null value.</section>
+CHAR function is a fixed-length character string. If the first argument can
+be null, the result can be null. If the first argument is null, the result
+is the null value. The first argument cannot be an XML value. To convert
+an XML value to a CHAR of a specified length, you must use the SQL/XML serialization
+operator XMLSERIALIZE.</section>
<section><title>Character to character syntax</title> <codeblock><b>CHAR (<i>CharacterExpression</i> [, <i>integer</i>] ) </b></codeblock> <dl>
<dlentry>
<dt>CharacterExpression</dt>
@@ -102,4 +104,3 @@
four blanks).</p> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefcreatefunctionstatement.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcreatefunctionstatement.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcreatefunctionstatement.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcreatefunctionstatement.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -38,9 +39,9 @@
SYS.</p></example>
<example id="rrefcrprofunctionparameter"><title>FunctionParameter</title><codeblock><b>[ parameter-Name ] <i>DataType</i></b></codeblock></example>
<section><p>PararameterName must be unique within a function.</p><p>The syntax
-of <i>DataType</i> is described in <xref href="crefsqlj31068.dita#crefsqlj31068"></xref>.</p><note>Long
-data-types such as LONG VARCHAR, LONG VARCHAR FOR BIT DATA, CLOB, and BLOB
-are not allowed as parameters in a CREATE FUNCTION statement.</note></section>
+of <i>DataType</i> is described in <xref href="crefsqlj31068.dita#crefsqlj31068"></xref>.</p><note>Data-types
+such as BLOB, CLOB, LONG VARCHAR, LONG VARCHAR FOR BIT DATA, and XML are not
+allowed as parameters in a CREATE FUNCTION statement.</note></section>
<example id="rrefcrprofunctionelement"> <title>FunctionElement</title><codeblock><b> {
| LANGUAGE { JAVA }
| EXTERNAL NAME <i>string</i>
Modified: db/derby/docs/trunk/src/ref/rrefcreateprocedurestatement.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcreateprocedurestatement.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcreateprocedurestatement.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcreateprocedurestatement.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -38,9 +39,9 @@
></b></codeblock></example>
<section><p>The default value for a parameter is IN. ParameterName must be
unique within a procedure.</p><p>The syntax of <i>DataType</i> is described
-in <xref href="crefsqlj31068.dita#crefsqlj31068"></xref>.</p><note>Long data-types
-such as LONG VARCHAR, LONG VARCHAR FOR BIT DATA, CLOB, and BLOB are not allowed
-as parameters in a CREATE PROCEDURE statement.</note></section>
+in <xref href="crefsqlj31068.dita#crefsqlj31068"></xref>.</p><note>Data-types
+such as BLOB, CLOB, LONG VARCHAR, LONG VARCHAR FOR BIT DATA, and XML are not
+allowed as parameters in a CREATE PROCEDURE statement.</note></section>
<example id="rrefcrproprocedureelement"> <title>ProcedureElement</title><codeblock><b> {
| [ DYNAMIC ] RESULT SETS <i><xref href="rrefsqlj10696.dita#rrefsqlj10696">INTEGER</xref></i>
| LANGUAGE { JAVA }
Modified: db/derby/docs/trunk/src/ref/rrefdatefunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdatefunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdatefunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdatefunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,24 +18,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefdatefunc" xml:lang="en-us">
<title>DATE</title>
+<shortdesc>The DATE function returns a date from a value.</shortdesc>
<prolog><metadata>
<keywords><indexterm>DATE function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The DATE function returns a date from a value. The argument
-must be a date, timestamp, a positive number less than or equal to 3,652,059,
-a valid string representation of a date or timestamp, or a string of length
-7 that is not a CLOB or LONG VARCHAR. If the argument is a string of length
-7, it must represent a valid date in the form yyyynnn, where yyyy are digits
-denoting a year, and nnn are digits between 001 and 366, denoting a day of
-that year. The result of the function is a date. If the argument can be null,
-the result can be null; if the argument is null, the result is the null value. </p> <p>The
-other rules depend on the data type of the argument specified: <ul>
+<section> <p>The argument must be a date, timestamp, a positive number less
+than or equal to 3,652,059, a valid string representation of a date or timestamp,
+or a string of length 7 that is not a CLOB, LONG VARCHAR, or XML value. If
+the argument is a string of length 7, it must represent a valid date in the
+form yyyynnn, where yyyy are digits denoting a year, and nnn are digits between
+001 and 366, denoting a day of that year. The result of the function is a
+date. If the argument can be null, the result can be null; if the argument
+is null, the result is the null value. </p> <p>The other rules depend on the
+data type of the argument specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
a date or timestamp: The result is the date part of the value.</li>
<li>If the argument is a number: The result is the date that is n-1 days after
@@ -44,4 +45,3 @@
<example> <p>This example results in an internal representation of '1988-12-25'.</p> <codeblock><b>VALUES DATE('1988-12-25')</b></codeblock> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefdayfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdayfunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdayfunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdayfunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,23 +18,19 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
-<reference xml:lang="en-us" id="rrefdayfunc">
+<reference id="rrefdayfunc" xml:lang="en-us">
<title>DAY</title>
+<shortdesc>The DAY function returns the day part of a value.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>DAY function</indexterm>
-</keywords>
-</metadata>
-</prolog><refbody>
-<section>
-<p>The DAY function returns the day part of a value. The argument
-must be a date, timestamp, or a valid character string representation of a
-date or timestamp that is neither a CLOB nor a LONG VARCHAR. The result of
-the function is a large integer. If the argument can be null, the result can
-be null; if the argument is null, the result is the null value.</p>
-<p>The
-other rules depend on the data type of the argument specified:
-<ul>
+<keywords><indexterm>DAY function</indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The argument must be a date, timestamp, or a valid character
+string representation of a date or timestamp that is not a CLOB, LONG VARCHAR,
+or XML value. The result of the function is a large integer. If the argument
+can be null, the result can be null; if the argument is null, the result is
+the null value.</p> <p>The other rules depend on the data type of the argument
+specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
a date or timestamp: The result is the day part of the value, which is an
integer between 1 and 31. </li>
@@ -39,10 +38,8 @@
the day part of the value, which is an integer between -99 and 99. A nonzero
result has the same sign as the argument.</li>
</ul></p></section>
-<refsyn><title>Syntax</title>
-<codeblock><b>DAY ( <i>expression</i> )</b></codeblock>
-</refsyn>
-<example>
-<codeblock><b>values day('2005-08-02');</b></codeblock>
-<p>The resulting value is 2.</p>
-</example></refbody></reference>
+<refsyn><title>Syntax</title> <codeblock><b>DAY ( <i>expression</i> )</b></codeblock> </refsyn>
+<example> <codeblock><b>values day('2006-08-02');</b></codeblock> <p>The resulting
+value is 2.</p> </example>
+</refbody>
+</reference>
Modified: db/derby/docs/trunk/src/ref/rrefdeclaretemptable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdeclaretemptable.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdeclaretemptable.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdeclaretemptable.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -19,22 +20,23 @@
-->
<reference id="rrefdeclaretemptable" xml:lang="en-us">
<title>DECLARE GLOBAL TEMPORARY TABLE statement</title>
+<shortdesc>The DECLARE GLOBAL TEMPORARY TABLE statement defines a temporary
+table for the current connection. </shortdesc>
<prolog><metadata>
<keywords><indexterm>DECLARE GLOBAL TEMPORARY TABLE statement</indexterm>
-<indexterm>Tables<indexterm>Temporary</indexterm></indexterm></keywords>
+<indexterm>tables<indexterm>temporary</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>The DECLARE GLOBAL TEMPORARY TABLE statement defines a temporary
-table for the current connection. These tables do not reside in the system
-catalogs and are not persistent. Temporary tables exist only during the connection
-that declared them and cannot be referenced outside of that connection. When
-the connection closes, the rows of the table are deleted, and the in-memory
-description of the temporary table is dropped.</p></section>
+<section><p>These tables do not reside in the system catalogs and are not
+persistent. Temporary tables exist only during the connection that declared
+them and cannot be referenced outside of that connection. When the connection
+closes, the rows of the table are deleted, and the in-memory description of
+the temporary table is dropped.</p></section>
<section><p>Temporary tables are useful when: <ul>
-<li>the table structure is not known before using an application.</li>
-<li>other users do not need the same table structure.</li>
-<li>data in the temporary table is needed while using the application.</li>
-<li>the table can be declared and dropped without holding the locks on the
+<li>The table structure is not known before using an application.</li>
+<li>Other users do not need the same table structure.</li>
+<li>Data in the temporary table is needed while using the application.</li>
+<li>The table can be declared and dropped without holding the locks on the
system catalog.</li>
</ul></p></section>
<section><title>Syntax</title> <codeblock><b>DECLARE GLOBAL TEMPORARY TABLE <i><xref
@@ -112,15 +114,15 @@
-- This select statement is referencing the "myapp.t1" physical
-- table since the table was not qualified by SESSION.
-</codeblock> <p>Note that temporary tables can only be declared in the SESSION
-schema. You should never declare a physical schema with the SESSION name.</p> <p>The
+</codeblock> <note>Temporary tables can be declared only in the SESSION schema.
+You should never declare a physical schema with the SESSION name.</note><p>The
following is a list of DB2 UDB DECLARE GLOBAL TEMPORARY TABLE functions that
are not supported by <ph conref="refconrefs.dita#prod/productshortname"></ph>: <ul>
<li>IDENTITY column-options </li>
<li>IDENTITY attribute in copy-options</li>
<li>AS (fullselect) DEFINITION ONLY</li>
<li>NOT LOGGED ON ROLLBACK PRESERVE ROWS</li>
-<li> IN tablespace-name</li>
+<li>IN tablespace-name</li>
<li>PARTITIONING KEY</li>
<li>WITH REPLACE </li>
</ul> </p></section>
@@ -132,25 +134,26 @@
<li>CREATE VIEW</li>
<li>LOCK</li>
<li>RENAME</li>
-</ul></p> <p>Temporary tables cannot be specified in referential constraints.</p> <p>There
-is no check constraints support for columns.</p> <p>The following data types
+</ul></p><p>Temporary tables cannot be specified in referential constraints.</p><p>There
+is no support for check constraints on columns.</p><p>The following data types
cannot be used with Declared Global Temporary Tables: <ul>
<li>BLOB</li>
<li>CLOB</li>
<li>LONG VARCHAR</li>
-</ul></p> <p>Temporary tables cannot be referenced in a triggered-SQL-statement.</p> <p>If
-a statement performing an insert, update, or delete to the temporary table
-encounters an error, all the rows of the table are deleted.</p></section>
+<li>XML</li>
+</ul></p><p>Temporary tables cannot be referenced in a triggered-SQL-statement.</p><p>If
+a statement that performs an insert, update, or delete to the temporary table
+encounters an error, all the rows of the temporary table are deleted.</p></section>
<section><title>Restrictions Specific to Derby</title> <p><ph conref="refconrefs.dita#prod/productshortname"></ph> does
-not support the following on temporary tables:</p> <ul>
-<li>index support</li>
-<li>synonyms, triggers and views on SESSION schema tables (including physical
+not support the following features on temporary tables:</p> <ul>
+<li>Indexes</li>
+<li>Synonyms, triggers and views on SESSION schema tables (including physical
tables and temporary tables)</li>
<li>LOCK TABLE</li>
-<li>constraints and primary keys</li>
-<li>generated-column-spec</li>
-<li>importing into temporary tables</li>
-</ul> <p>Any statements referencing SESSION schema tables and views will not
-be cached.</p></section>
+<li>Constraints and primary keys</li>
+<li>Generated-column-spec</li>
+<li>Importing into temporary tables</li>
+</ul> <p>Statements that reference SESSION schema tables and views are not
+cached.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefexcept71493.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefexcept71493.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefexcept71493.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefexcept71493.dita Fri Aug 25 10:22:11 2006
@@ -202,6 +202,23 @@
</row>
</tbody>
</tgroup>
+</table><table><title> Class Code 10: XQuery Error</title>
+<tgroup cols="2"><colspec colname="col1" colwidth="129*"/><colspec colname="col2"
+colwidth="673*"/>
+<thead>
+<row>
+<entry colname="col1">SQLSTATE </entry>
+<entry colname="col2">Message Text</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="col1">10000</entry>
+<entry colname="col2">Encountered error while evaluating XML query expression
+for <<i>operatorName</i>> operator; see next exception for details.</entry>
+</row>
+</tbody>
+</tgroup>
</table><table><title> Class Code 21: Cardinality Violation</title>
<tgroup cols="2"><colspec colname="col1" colwidth="129*"/><colspec colname="col2"
colwidth="673*"/>
@@ -234,6 +251,30 @@
for details.</entry>
</row>
<row>
+<entry colname="col1">2200L
+ </entry>
+<entry colname="col2">Values assigned to XML columns must be well-formed DOCUMENT
+nodes.
+
+
+
+
+</entry>
+</row>
+<row>
+<entry colname="col1">2200M</entry>
+<entry colname="col2">Failed to parse XMLPARSE operand; see next exception
+for details.</entry>
+</row>
+<row>
+<entry colname="col1">2200V
+</entry>
+<entry colname="col2">Invalid context item for <operatorName> operator;
+context items must be well-formed DOCUMENT nodes.
+
+</entry>
+</row>
+<row>
<entry colname="col1">22001</entry>
<entry colname="col2">A truncation error was encountered trying to shrink <<i>value</i>>
'<<i>value</i>>' to length <<i>value</i>></entry>
@@ -1610,7 +1651,7 @@
in table '<<i>tableName</i>>'. </entry>
</row>
<row>
-<entry colname="col1"> 42Z25</entry>
+<entry colname="col1">42Z25</entry>
<entry colname="col2">INTERNAL ERROR identity counter. Update was called without
arguments with <codeblock>current value = NULL</codeblock>. </entry>
</row>
@@ -1632,6 +1673,69 @@
<entry colname="col1">42Z53</entry>
<entry colname="col2">INTERNAL ERROR: Do not know what type of activation
to generate for node choice <<i>value</i>>. </entry>
+</row>
+<row>
+<entry colname="col1">42Z70</entry>
+<entry colname="col2">Binding directly to an XML value is not allowed; try
+using XMLPARSE.</entry>
+</row>
+<row>
+<entry colname="col1">42Z71</entry>
+<entry colname="col2">XML values are not allowed in top-level result sets;
+try using XMLSERIALIZE.
+</entry>
+</row>
+<row>
+<entry colname="col1">42Z72</entry>
+<entry colname="col2">XML syntax error; missing keyword(s): ''<keyword>''.</entry>
+</row>
+<row>
+<entry colname="col1">42Z73</entry>
+<entry colname="col2">Invalid target type for XMLSERIALIZE: ''<sqlType>''.
+</entry>
+</row>
+<row>
+<entry colname="col1">42Z74
+</entry>
+<entry colname="col2">XML feature not supported: ''<featureKeyWord>''.
+
+</entry>
+</row>
+<row>
+<entry colname="col1">42Z75</entry>
+<entry colname="col2">XML query expression must be a string literal.</entry>
+</row>
+<row>
+<entry colname="col1">42Z76</entry>
+<entry colname="col2">Multiple XML context items are not allowed.</entry>
+</row>
+<row>
+<entry colname="col1">42Z77</entry>
+<entry colname="col2">Context item must have type ''XML''; ''<sqlType>''
+is not allowed.
+
+
+ </entry>
+</row>
+<row>
+<entry colname="col1">42Z78</entry>
+<entry colname="col2">Failed to locate ''<externalAPIName>' API or implementation
+classes. XML operations are not permitted unless these classes are in your
+classpath.
+
+
+
+ </entry>
+</row>
+<row>
+<entry colname="col1">42Z79</entry>
+<entry colname="col2">Unable to determine the parameter type for XMLPARSE;
+try using a CAST.</entry>
+</row>
+<row>
+<entry colname="col1">42Z7Z</entry>
+<entry colname="col2">Encountered unexpected error while processing XML; see
+next exception for details.</entry>
</row>
<row>
<entry colname="col1">42Z90</entry>
Added: db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either XMLEXISTSress or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rreffuncxmlexists" xml:lang="en-us">
+<title>XMLEXISTS operator</title>
+<shortdesc>XMLEXISTS is an SQL/XML operator that you can use to query XML
+values in SQL.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>XMLEXISTS operator</indexterm><indexterm>operators<indexterm>XMLEXISTS</indexterm></indexterm>
+<indexterm>XML<indexterm>operators, XMLEXISTS</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The XMLEXISTS operator has two arguments, an XML query expression
+and a <ph conref="refconrefs.dita#prod/productshortname"></ph> XML value.</p> </section>
+<refsyn><title>Syntax</title><codeblock><b>XMLEXISTS ( <varname>xquery-string-literal</varname>
+ PASSING BY REF <varname>xml-value-expression</varname> [ BY REF ] )
+</b></codeblock><dl><dlentry>
+<dt><codeph>xquery-string-literal</codeph></dt>
+<dd>Must be specified as a string literal. If this argument is specified as
+a parameter, an expression that is not a literal, or a literal that is not
+a string (for example an integer), <ph conref="refconrefs.dita#prod/productshortname"></ph> returns
+an error. The <codeph>xquery-string-literal</codeph> argument must also be
+an XPath expression that is supported by Apache Xalan. <ph conref="refconrefs.dita#prod/productshortname"></ph> uses
+Apache Xalan to evaluate all XML query expressions. Because Xalan does not
+support full XQuery, neither does <ph conref="refconrefs.dita#prod/productshortname"></ph>.
+ If Xalan is unable to compile or execute the query argument, <ph conref="refconrefs.dita#prod/productshortname"></ph> catches
+the error that is thrown by Xalan and throws the error as a SQLException.
+For more on XPath and XQuery expressions, see the these Web sites: <xref format="html"
+href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</xref> and <xref
+format="html" href="http://www.w3.org/TR/xquery/">http://www.w3.org/TR/xquery/</xref>.</dd>
+</dlentry><dlentry>
+<dt><codeph>xml-value-expression</codeph></dt>
+<dd>Must be an XML data type and must constitute a valid SQL/XML document.
+The <codeph>xml-value-expression</codeph> argument cannot be a parameter.
+ <ph conref="refconrefs.dita#prod/productshortname"></ph> does not perform
+implicit parsing nor casting of XML values, so use of strings or any other
+data type results in an error. If the argument is a sequence that is returned
+by the <ph conref="refconrefs.dita#prod/productshortname"></ph> <xref href="rreffuncxmlquery.dita#rreffuncxmlquery"></xref>,
+the argument is accepted if it is a sequence of exactly one node that is a
+document node. Otherwise <ph conref="refconrefs.dita#prod/productshortname"></ph> returns
+an error.</dd>
+</dlentry><dlentry>
+<dt>BY REF</dt>
+<dd>Optional keywords that describe the only value passing mechanism supported
+by <ph conref="refconrefs.dita#prod/productshortname"></ph>. Since the BY
+REF clause is also the default passing mechanism, the XMLEXISTS operator behaves
+the same whether the keywords are present or not. For more information on
+passing mechanisms, see the SQL/XML specification.</dd>
+</dlentry></dl></refsyn>
+<section><title>Operator results and combining with other operators</title><p>The
+result of the XMLEXISTS operator is a SQL boolean value that is based on the
+results from evaluating the <codeph>xquery-string-literal</codeph> against
+the <codeph>xml-value-expression</codeph>. The XMLEXISTS operator returns:<dl>
+<dlentry>
+<dt>UNKNOWN</dt>
+<dd>When the <codeph>xml-value-expression</codeph> is null.</dd>
+</dlentry><dlentry>
+<dt>TRUE</dt>
+<dd>When the evaluation of the specified query expression against the specified
+xml-value returns a non-empty sequence of nodes or values.</dd>
+</dlentry><dlentry>
+<dt>FALSE</dt>
+<dd>When evaluation of the specified query expression against the specified
+xml-value returns an empty sequence.</dd>
+</dlentry></dl></p><p>The XMLEXISTS operator does not return the actual results
+from the evaluation of the query. You must use the XMLQUERY operator to retrieve
+the actual results.</p><p>Since the result of the XMLEXISTS operator is an
+SQL boolean data type, you can use the XMLEXISTS operator wherever a boolean
+function is allowed. For example, you can use the XMLEXISTS operator as a
+check constraint in a table declaration or as a predicate in a WHERE clause.</p></section>
+<section><title>Examples</title><p>In the <codeph>x_table</codeph> table,
+to determine if the <codeph>xcol</codeph> XML column for each row has an element
+called <codeph>student</codeph> with an <codeph>age</codeph> attribute equal
+to 20, use this statement:<codeblock>SELECT id, XMLEXISTS('<varname>//student[@age=20]</varname>' PASSING BY REF <varname>xcol</varname>)
+ FROM <varname>x_table</varname></codeblock></p><p>In the <codeph>x_table</codeph> table,
+to return the ID for every row whose <codeph>xcol</codeph> XML column is non-null
+and contains the element <codeph>/roster/student</codeph>, use this statement:<codeblock>SELECT id FROM <varname>x_table</varname> WHERE XMLEXISTS('<varname
+>/roster/student</varname>' PASSING BY REF <varname>xcol</varname>)</codeblock></p><p>You
+can create the <codeph>x_table</codeph> table with a check constraint that
+allows an XML value to be inserted into the <codeph>xcol</codeph> XML column.
+The constraint is that the column has at least one <codeph>student</codeph> element
+with an <codeph>age</codeph> attribute with a value that is less than 25.
+To create the table, use this statement:<codeblock>CREATE TABLE <varname>x_table</varname> ( id INT, <varname>xcol</varname> XML CHECK (XMLEXISTS ('<varname
+>//student[@age < 25]</varname>' PASSING BY REF <varname>xcol</varname>)) )</codeblock></p></section>
+<section><title>Usage note</title><p><ph conref="refconrefs.dita#prod/productshortname"></ph> requires
+that a JAXP parser, such as Apache Xerces, and that Apache Xalan are listed
+in the Java classpath for the XML functions to work. If either the JAXP parser
+or Xalan is missing from the classpath, attempts to use the XMLEXISTS operator
+will result in an error.</p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreffuncxmlexists.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either XMLEXISTSress or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rreffuncxmlexists" xml:lang="en-us">
+<title>XMLPARSE operator</title>
+<shortdesc>XMLPARSE is a SQL/XML operator that you use to parse a character
+string expression into a <ph conref="refconrefs.dita#prod/productshortname"></ph> XML
+value.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>XMLPARSE operator</indexterm><indexterm>operators<indexterm>XMLPARSE</indexterm></indexterm>
+<indexterm>XML<indexterm>operators, XMLPARSE</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>You can use the result of this operator temporarily or you can
+store the result permanently in <ph conref="refconrefs.dita#prod/productshortname"></ph> XML
+columns. Whether temporary or permanent, you can use the XML value as an
+input to the other <ph conref="refconrefs.dita#prod/productshortname"></ph> XML
+operators, such as <xref href="rreffuncxmlexists.dita#rreffuncxmlexists">XMLEXISTS</xref> and <xref
+href="rreffuncxmlquery.dita#rreffuncxmlquery">XMLQUERY</xref>.</p> </section>
+<refsyn><title>Syntax</title><codeblock><b>XMLPARSE (DOCUMENT <varname>string-value-expression</varname> PRESERVE WHITESPACE)</b></codeblock><dl>
+<dlentry>
+<dt>DOCUMENT </dt>
+<dd> <p>Required keyword that describes the type of XML input that <ph conref="refconrefs.dita#prod/productshortname"></ph> can
+parse. <ph conref="refconrefs.dita#prod/productshortname"></ph> can only
+parse string expressions that constitute well-formed XML documents. This
+is because <ph conref="refconrefs.dita#prod/productshortname"></ph> uses a
+JAXP parser to parse all string values. The JAXP parser expects the string-value-expression
+to constitute a well-formed XML document. If the string does not constitute
+a well-formed document, JAXP throws an error. <ph conref="refconrefs.dita#prod/productshortname"></ph> catches
+the error and throws the error as a SQLException.</p></dd>
+</dlentry><dlentry>
+<dt><codeph>string-value-expression</codeph></dt>
+<dd>Any expression that evaluates to a SQL character type, such as CHAR, VARCHAR,
+LONG VARCHAR, or CLOB. The <codeph>string-value-expression</codeph> argument
+can also be a parameter. You must use the CAST function when you specify the
+parameter to indicate the type of value that is bound into the parameter. <ph
+conref="refconrefs.dita#prod/productshortname"></ph> must verify that the
+parameter is the correct data type before the value is parsed as an XML document.
+ If a parameter is specified without the CAST function, or if the CAST is
+to a non-character datatype, <ph conref="refconrefs.dita#prod/productshortname"></ph> throws
+an error.</dd>
+</dlentry><dlentry>
+<dt>PRESERVE WHITESPACE</dt>
+<dd>Required keywords that describe how <ph conref="refconrefs.dita#prod/productshortname"></ph> handles
+whitespace between consecutive XML nodes. When the PRESERVE WHITESPACE keywords
+are used, <ph conref="refconrefs.dita#prod/productshortname"></ph> preserves
+whitespace as dictated by the SQL/XML rules for preserving whitespace.</dd>
+</dlentry></dl><p>For more information on what constitutes a well-formed XML
+document, see the following specification: <xref format="html" href="http://www.w3.org/TR/REC-xml/#sec-well-formed">http://www.w3.org/TR/REC-xml/#sec-well-formed </xref
+>.</p><p><note type="restriction">The SQL/XML standard dictates that the argument
+to the XMLPARSE operator can also be a binary string. However, <ph conref="refconrefs.dita#prod/productshortname"></ph> only
+supports character string input for the XMLPARSE operator.</note></p></refsyn>
+<section><title>Examples</title><p>To insert a simple XML document into the <codeph>xcol</codeph> XML
+column in the <codeph>x_table</codeph> table, use the following statement: <codeblock>INSERT INTO <varname>x_table</varname> VALUES
+ (<varname>1</varname>,
+ XMLPARSE(DOCUMENT '
+ <roster>
+ <student age="18">AB</student>
+ <student age="23">BC</student>
+ <student>NOAGE</student>
+ </roster>'
+ PRESERVE WHITESPACE)
+ )
+</codeblock></p><p>To insert a large XML document into the <codeph>xcol</codeph> XML
+column in the <codeph>x_table</codeph> table, from JDBC use the following
+statement: <codeblock>INSERT INTO <varname>x_table</varname> VALUES
+ (<varname>2</varname>,
+ XMLPARSE (DOCUMENT CAST (? AS CLOB) PRESERVE WHITESPACE)
+ )
+</codeblock>You should bind into the statement using the setCharacterStream()
+method, or any other JDBC setXXX method that works for the CAST target type.</p></section>
+<section><title>Usage note</title><p><ph conref="refconrefs.dita#prod/productshortname"></ph> requires
+that a JAXP parser, such as Apache Xerces, and that Apache Xalan are listed
+in the Java classpath for the XML functions to work. If either the JAXP parser
+or Xalan is missing from the classpath, attempts to use the XMLPARSE operator
+will result in an error.</p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreffuncxmlparse.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either XMLEXISTSress or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rreffuncxmlquery" xml:lang="en-us">
+<title>XMLQUERY operator</title>
+<shortdesc>XMLQUERY is a SQL/XML operator that you can use to query XML values
+in SQL.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>XMLQUERY operator</indexterm><indexterm>operators<indexterm>XMLQUERY</indexterm></indexterm>
+<indexterm>XML<indexterm>operators, XMLQUERY</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The XMLQUERY operator has two arguments, an XML query expression
+and a <ph conref="refconrefs.dita#prod/productshortname"></ph> XML value.</p></section>
+<refsyn><title>Syntax</title><codeblock><b>XMLQUERY ( <varname>xquery-string-literal</varname>
+ PASSING BY REF <varname>xml-value-expression</varname>
+ [ RETURNING SEQUENCE [ BY REF ] ]
+ EMPTY ON EMPTY
+ )</b></codeblock><dl><dlentry>
+<dt><codeph>xquery-string-literal</codeph></dt>
+<dd>Must be specified as a string literal. If this argument is specified as
+a parameter, an expression that is not a literal, or a literal that is not
+a string (for example an integer), <ph conref="refconrefs.dita#prod/productshortname"></ph> returns
+an error. The <codeph>xquery-string-literal</codeph> argument must also be
+an XPath expression that is supported by Apache Xalan. <ph conref="refconrefs.dita#prod/productshortname"></ph> uses
+Apache Xalan to evaluate all XML query expressions. Because Xalan does not
+support full XQuery, neither does <ph conref="refconrefs.dita#prod/productshortname"></ph>.
+If Xalan is unable to compile or execute the query argument, <ph conref="refconrefs.dita#prod/productshortname"></ph> catches
+the error that is thrown by Xalan and throws the error as a SQLException.
+For more on XPath and XQuery expressions, see the these Web sites: <xref format="html"
+href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</xref> and <xref
+format="html" href="http://www.w3.org/TR/xquery/">http://www.w3.org/TR/xquery/</xref>.</dd>
+</dlentry><dlentry>
+<dt><codeph>xml-value-expression</codeph></dt>
+<dd>Must be an XML data type and must constitute a valid SQL/XML document.
+The <codeph>xml-value-expression</codeph> argument cannot be a parameter.
+ <ph conref="refconrefs.dita#prod/productshortname"></ph> does not perform
+implicit parsing nor casting of XML values, so use of strings or any other
+data type results in an error. If the argument is a sequence that is returned
+by a <ph conref="refconrefs.dita#prod/productshortname"></ph> XMLQUERY operation,
+the argument is accepted if it is a sequence of exactly one node that is a
+document node. Otherwise <ph conref="refconrefs.dita#prod/productshortname"></ph> returns
+an error.</dd>
+</dlentry><dlentry>
+<dt>BY REF</dt>
+<dd>Optional keywords that describe the only value passing mechanism supported
+by <ph conref="refconrefs.dita#prod/productshortname"></ph>. Since the BY
+REF clause is also the default passing mechanism, the XMLQUERY operator behaves
+the same whether the keywords are present or not. For more information on
+passing mechanisms, see the SQL/XML specification.</dd>
+</dlentry><dlentry>
+<dt>RETURNING SEQUENCE</dt>
+<dd>Optional keywords that describe the only XML type returned by the <ph
+conref="refconrefs.dita#prod/productshortname"></ph> XMLQUERY operator. Since
+the RETURNING SEQUENCE clause is also the default return type, the XMLQUERY
+operator behaves the same whether the keywords are present or not. For more
+information on the different XML return types, see the SQL/XML specification.</dd>
+</dlentry><dlentry>
+<dt>EMPTY ON EMPTY</dt>
+<dd>Required keywords that describe the way in which XMLQUERY handles an empty
+result sequence. The XMLQUERY operator returns an empty sequence exactly as
+the sequence is. The XMLQUERY operator does not convert the empty sequence
+to a null value. When an empty result sequence is serialized, the result
+is an empty string. <ph conref="refconrefs.dita#prod/productshortname"></ph> does
+not consider an empty result sequence to be a well-formed XML document.</dd>
+</dlentry></dl><p>The result of the XMLQUERY operator is another Derby XML
+value. Unlike other XML values, the result might represent an empty sequence
+of XML nodes or values. Atomic values, such as strings, can be part of the
+result sequence. The result of an XMLQUERY operator is not guaranteed to represent
+a valid XML document and it might not be possible to insert the result of
+an XMLQUERY operator into a Derby XML column. To store the result in a Derby
+XML column, the result must be a sequence with exactly one item in the sequence
+and the item must be a well-formed document node. The result can be viewed
+only in serialized form by explicitly using the <xref href="rreffuncxmlserialize.dita#rreffuncxmlserialize"></xref>. </p></refsyn>
+<section><title>Examples</title><p>In the <codeph>x_table</codeph> table,
+to search the XML column <codeph>xcol</codeph> and return the students that
+have an age attribute that is greater than 20, use the following statement:<codeblock>SELECT ID,
+ XMLSERIALIZE(
+ XMLQUERY('<va...@age>20]</varname>' PASSING BY REF <varname>xcol</varname> EMPTY ON EMPTY)
+ AS VARCHAR(50))
+FROM <varname>x_table</varname>
+
+</codeblock>The result set for this query contains a row for every row in <codeph>x_table</codeph>,
+regardless of whether or not the XMLQUERY operator actually returns results.</p><p>In
+the <codeph>x_table</codeph> table, to search the XML column <codeph>xcol</codeph> and
+return the ages for any students named BC, use the following statement:<codeblock>SELECT ID,
+ XMLSERIALIZE(
+ XMLQUERY('<varname>//student[text() = "BC"]/@age</varname>' PASSING BY REF <varname>xcol</varname> EMPTY ON EMPTY)
+ AS VARCHAR(50))
+FROM <varname>x_table</varname>
+WHERE
+ XMLEXISTS('<varname>//student[text() = "BC"]</varname>' PASSING BY REF <varname>xcol</varname>)
+</codeblock> The result set for this query contains a row for only the rows
+in <codeph>x_table</codeph> that has a student name of BC.</p></section>
+<section><title>Usage note</title><p><ph conref="refconrefs.dita#prod/productshortname"></ph> requires
+that a JAXP parser, such as Apache Xerces, and that Apache Xalan are listed
+in the Java classpath for the XML functions to work. If either the JAXP parser
+or Xalan is missing from the classpath, attempts to use the XMLQUERY operator
+will result in an error.</p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreffuncxmlquery.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita (added)
+++ db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either XMLEXISTSress or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rreffuncxmlserialize" xml:lang="en-us">
+<title>XMLSERIALIZE operator</title>
+<shortdesc>XMLSERIALIZE is a SQL/XML operator that you can use to view the
+serialized contents of an XML value in <ph conref="refconrefs.dita#prod/productshortname"></ph>.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>XMLSERIALIZE operator</indexterm><indexterm>operators<indexterm>XMLSERIALIZE</indexterm></indexterm>
+<indexterm>XML<indexterm>operators, XMLSERIALIZE</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p> Using the XMLSERIALIZE operator is the only way that you can
+view serialized contents. </p><note type="attention">Serialization is performed
+based on the SQL/XML serialization rules. These rules, combined with the fact
+that <ph conref="refconrefs.dita#prod/productshortname"></ph> supports only
+a subset of the XMLSERIALIZE syntax, dictate that the results of an XMLSERIALIZE
+operation are not guaranteed to be in-tact copies of the original XML text.
+For example, assume that <codeph>[xString]</codeph> is a textual representation
+of a well-formed XML document. You issue the following statements:<codeblock>INSERT INTO <varname>xTable</varname> (<varname>id</varname>, <varname
+>xcol</varname>)
+ VALUES (3, XMLPARSE(DOCUMENT '<varname>[xString]</varname>' PRESERVE WHITESPACE));
+
+SELECT id, XMLSERIALIZE(<varname>xcol</varname> AS VARCHAR(100))
+ FROM <varname>xTable</varname> WHERE id = 3;
+</codeblock><p>There is no guarantee that the result of the XMLSERIALIZE operator
+will be identical to the original <codeph>[xString]</codeph> representation.
+Certain transformations can occur as part of XMLSERIALIZE processing, and
+those transformations are defined in the SQL/XML specification. In some cases
+the result of XMLSERIALIZE might actually be the same as the original textual
+representation, but that is not guaranteed. </p><p>When an XMLSERIALIZE operator
+is specified as part of the top-level result set for a query, the result can
+be accessed from JDBC by using whatever JDBC getXXX methods are allowed on
+the <codeph>string-data-type</codeph> argument that is included in the XMLSERIALIZE
+syntax. If you attempt to select the contents of an XML value from a top-level
+result set without using the XMLSERIALIZE operator, <ph conref="refconrefs.dita#prod/productshortname"></ph> throws
+an error. <ph conref="refconrefs.dita#prod/productshortname"></ph> does not
+implicitly serialize XML values.</p></note></section>
+<refsyn><title>Syntax</title><codeblock><b>XMLSERIALIZE ( <varname>xml-value-expression</varname> AS <varname>string-data-type</varname> )</b></codeblock
+><dl><dlentry>
+<dt><codeph>xml-value-expression</codeph></dt>
+<dd>Can be any Derby XML value, including an XML result sequence generated
+by the XMLQUERY operator. The <codeph>xml-value-expression</codeph> argument
+cannot be a parameter. <p></p></dd>
+</dlentry><dlentry>
+<dt><codeph>string-data-type</codeph></dt>
+<dd>Must be a SQL character string type, such as CHAR, VARCHAR, LONG VARCHAR,
+or CLOB. If you specify a type that is not a valid character string type, <ph
+conref="refconrefs.dita#prod/productshortname"></ph> throws an error.</dd>
+</dlentry></dl></refsyn>
+<section><title>Examples</title><p>In the <codeph>x_table</codeph> table,
+to display the contents of the <codeph>xcol</codeph> XML column, use this
+statement:<codeblock>SELECT ID,
+ XMLSERIALIZE(
+ <varname>xcol</varname> AS CLOB)
+FROM <varname>x_table</varname></codeblock>To retrieve the results from JDBC,
+you can use the JDBC getCharacterStream() or getString() method.</p><p>To
+display the results of an XMLQUERY operation, use the following statement:<codeblock>SELECT ID,
+ XMLSERIALIZE(
+ XMLQUERY('<va...@age>20]</varname>'
+ PASSING BY REF <varname>xcol</varname> EMPTY ON EMPTY)
+ AS VARCHAR(50))
+FROM <varname>x_table</varname></codeblock></p></section>
+<section><title>Usage note</title><p><ph conref="refconrefs.dita#prod/productshortname"></ph> requires
+that a JAXP parser, such as Apache Xerces, and that Apache Xalan are listed
+in the Java classpath for the XML functions to work. If either the JAXP parser
+or Xalan is missing from the classpath, attempts to use the XMLSERIALIZE operator
+will result in an error</p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreffuncxmlserialize.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefhourfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefhourfunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefhourfunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefhourfunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,24 +18,22 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefhourfunc" xml:lang="en-us">
<title>HOUR</title>
+<shortdesc>The HOUR function returns the hour part of a value.</shortdesc>
<prolog><metadata>
<keywords><indexterm>HOUR function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The HOUR function returns the hour part of a value. The argument
-must be a time, timestamp, or a valid character string representation of a
-time or timestamp that is neither a CLOB nor a LONG VARCHAR. The result of
-the function is a large integer. If the argument can be null, the result can
-be null; if the argument is null, the result is the null value.</p> <p>The
-other rules depend on the data type of the argument specified: <ul>
+<section> <p>The argument must be a time, timestamp, or a valid character
+string representation of a time or timestamp that is not a CLOB, LONG VARCHAR,
+or XML value. The result of the function is a large integer. If the argument
+can be null, the result can be null; if the argument is null, the result is
+the null value.</p> <p>The other rules depend on the data type of the argument
+specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
-a date or timestamp: The result is the hour part of the value,
-which is an integer between 0 and 24. </li>
+a date or timestamp: The result is the hour part of the value, which is an
+integer between 0 and 24. </li>
<li>If the argument is a time duration or timestamp duration: The result is
the hour part of the value, which is an integer between -99 and 99. A nonzero
result has the same sign as the argument.</li>
@@ -43,4 +44,3 @@
WHERE HOUR(STARTING) BETWEEN 12 AND 17</b></codeblock> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefjdbc20377.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc20377.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc20377.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc20377.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,19 +18,20 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefjdbc20377" xml:lang="en-us">
<title>Mapping of java.sql.Types to SQL types</title>
+<shortdesc>In Derby, the java.sql.Types 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>
<indexterm>JDBC types<indexterm>mapped to SQL types</indexterm><indexterm>for
-JDBC and SQL types</indexterm></indexterm><indexterm>Type correspondence</indexterm>
-</keywords>
+JDBC and SQL types</indexterm></indexterm><indexterm>data types<indexterm>JDBC
+types to SQL types</indexterm></indexterm><indexterm>java.sql.Types<indexterm>LONGVARBINARY</indexterm></indexterm>
+<indexterm>java.sql.Types<indexterm>LONGVARCHAR</indexterm></indexterm><indexterm>java.sql.Types<indexterm>FLOAT
+data type</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p><xref href="rrefjdbc20377.dita#rrefjdbc20377/jdbc31241"></xref> shows the mapping of <i>java.sql.Types</i> to
+<section><p>The following table shows the mapping of <i>java.sql.Types</i> to
SQL types. <table frame="all" id="jdbc31241"><title>Mapping of java.sql.Types
to SQL Types</title>
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="30*"/>
@@ -76,8 +80,7 @@
<entry colname="2">DOUBLE PRECISION</entry>
</row>
<row>
-<entry colname="1">FLOAT<indexterm>FLOAT data type<indexterm>java.sql type
-converted to DOUBLE PRECISION when retrieved</indexterm></indexterm></entry>
+<entry colname="1">FLOAT</entry>
<entry colname="2">DOUBLE PRECISION<sup><xref href="rrefjdbc20377.dita#rrefjdbc20377/chdbdbhh">2</xref></sup></entry>
</row>
<row>
@@ -85,11 +88,11 @@
<entry colname="2">INTEGER</entry>
</row>
<row>
-<entry colname="1">LONGVARBINARY<indexterm>LONGVARBINARY</indexterm></entry>
+<entry colname="1">LONGVARBINARY</entry>
<entry colname="2">LONG VARCHAR FOR BIT DATA</entry>
</row>
<row>
-<entry colname="1">LONGVARCHAR<indexterm>LONGVARCHAR</indexterm></entry>
+<entry colname="1">LONGVARCHAR</entry>
<entry colname="2">LONG VARCHAR</entry>
</row>
<row>
@@ -109,6 +112,10 @@
<entry colname="2">SMALLINT</entry>
</row>
<row>
+<entry colname="1">SQLXML<sup><xref href="rrefjdbc20377.dita#rrefjdbc20377/sqlxml">3</xref></sup></entry>
+<entry colname="2">XML</entry>
+</row>
+<row>
<entry colname="1">TIME</entry>
<entry colname="2">TIME</entry>
</row>
@@ -127,12 +134,17 @@
</tbody>
</tgroup>
</table> <note othertype="Notes" type="other"><ol>
-<li id="chdhcccj"><indexterm>Mapping<indexterm>of SQL types to java.sql.Types</indexterm></indexterm>BIT
-is only valid in JDBC 2.0 and earlier environments.</li>
+<li id="chdhcccj">BIT is only valid in JDBC 2.0 and earlier environments.</li>
<li id="chdbdbhh">Values can be passed in using the FLOAT type code; however,
these are stored as DOUBLE PRECISION values, and so always have the type code
DOUBLE when retrieved.</li>
+<li id="sqlxml">SQLXML is only valid in JDBC 4.0 and later environments. SQLXML
+corresponds to the SQL type XML in <ph conref="refconrefs.dita#prod/productshortname"></ph>.
+ However, <ph conref="refconrefs.dita#prod/productshortname"></ph> does not
+recognize the java.sql.Types.SQLXML data type and does not support any JDBC-side
+operations for the XML data type. Support for XML and the related operators
+is implemented only at the SQL layer. See <xref href="rrefsqljtypexml.dita#rrefsqljtypexml">XML
+data types</xref> for more. </li>
</ol> </note></p></section>
</refbody>
</reference>
-
Added: db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rrefjdbcrefsqlxml" xml:lang="en-us">
+<title>java.sql.SQLXML</title>
+<prolog><metadata>
+<keywords><indexterm>java.sql.SQLXML</indexterm></keywords>
+</metadata></prolog>
+<refbody>
+<section><p>In JDBC 4.0, java.sql.SQLXML is the mapping for the SQL XML data
+type. However, <ph conref="refconrefs.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
+java.sql.SQLXML object in <ph conref="refconrefs.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="refconrefs.dita#prod/productshortname"></ph> does
+not provide JDBC metatadata support for the XML data type. </p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefjdbcrefsqlxml.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rreflimitsxml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreflimitsxml.dita?rev=436862&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rreflimitsxml.dita (added)
+++ db/derby/docs/trunk/src/ref/rreflimitsxml.dita Fri Aug 25 10:22:11 2006
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rreflimitsxml" xml:lang="en-us">
+<title>XML limitations</title>
+<prolog><metadata>
+<keywords><indexterm>XML data type<indexterm>limitations</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section><p>The following table lists the limitations on XML data types in <ph
+conref="refconrefs.dita#prod/productshortname"></ph>.</p></section>
+<table frame="all"><title>XML limitations</title>
+<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="colspec0" colwidth="228*"/>
+<colspec colname="colspec1" colwidth="228*"/>
+<thead>
+<row>
+<entry align="left" valign="top">Issue</entry>
+<entry align="left" colname="colspec1" valign="top">Limitation</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="colspec0">Length of XML</entry>
+<entry colname="colspec1">2,147,483,647 characters</entry>
+</row>
+<row>
+<entry colname="colspec0">Use of XML operators</entry>
+<entry colname="colspec1">Requires that the JAXP parser classes, such as Apache
+Xerces, and Apache Xalan classes are in the classpath. Attempts to use XML
+operators without these classes in the classpath results in an error.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rreflimitsxml.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/ref/rrefminutefunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefminutefunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefminutefunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefminutefunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,21 +18,19 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefminutefunc" xml:lang="en-us">
<title>MINUTE</title>
+<shortdesc>The MINUTE function returns the minute part of a value. </shortdesc>
<prolog><metadata>
<keywords><indexterm>MINUTE function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The MINUTE function returns the minute part of a value. The
-argument must be a time, timestamp, or a valid character string representation
-of a time or timestamp that is neither a CLOB nor a LONG VARCHAR. The result
-of the function is a large integer. If the argument can be null, the result
-can be null; if the argument is null, the result is the null value.</p> <p>The
-other rules depend on the data type of the argument specified: <ul>
+<section> <p> The argument must be a time, timestamp, or a valid character
+string representation of a time or timestamp that is not a CLOB, LONG VARCHAR,
+or XML value. The result of the function is a large integer. If the argument
+can be null, the result can be null; if the argument is null, the result is
+the null value.</p> <p>The other rules depend on the data type of the argument
+specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
a date or timestamp: The result is the minute part of the value, which is
an integer between 0 and 59.</li>
@@ -42,4 +43,3 @@
SELECT * FROM table1 WHERE MINUTE(ending) < 60;</b></codeblock> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefmonthfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefmonthfunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefmonthfunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefmonthfunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,21 +18,19 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefmonthfunc" xml:lang="en-us">
<title>MONTH</title>
+<shortdesc>The MONTH function returns the month part of a value.</shortdesc>
<prolog><metadata>
<keywords><indexterm>MONTH function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The MONTH function returns the month part of a value. The argument
-must be a date, timestamp, or a valid character string representation of a
-date or timestamp that is neither a CLOB nor a LONG VARCHAR. The result of
-the function is a large integer. If the argument can be null, the result can
-be null; if the argument is null, the result is the null value. </p> <p>The
-other rules depend on the data type of the argument specified: <ul>
+<section> <p>The argument must be a date, timestamp, or a valid character
+string representation of a date or timestamp that is not a CLOB, LONG VARCHAR,
+or XML value. The result of the function is a large integer. If the argument
+can be null, the result can be null; if the argument is null, the result is
+the null value. </p> <p>The other rules depend on the data type of the argument
+specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
a date or timestamp: The result is the month part of the value, which is
an integer between 1 and 12.</li>
@@ -43,4 +44,3 @@
WHERE MONTH(BIRTHDATE) = 12</b></codeblock> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefsecondfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsecondfunc.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsecondfunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsecondfunc.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,21 +18,19 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefsecondfunc" xml:lang="en-us">
<title>SECOND</title>
+<shortdesc>The SECOND function returns the seconds part of a value.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SECOND function</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The SECOND function returns the seconds part of a value. The
-argument must be a time, timestamp, or a valid character string representation
-of a time or timestamp that is neither a CLOB nor a LONG VARCHAR. The result
-of the function is a large integer. If the argument can be null, the result
-can be null; if the argument is null, the result is the null value.</p> <p>The
-other rules depend on the data type of the argument specified: <ul>
+<section> <p>The argument must be a time, timestamp, or a valid character
+string representation of a time or timestamp that is not a CLOB, LONG VARCHAR,
+or XML value. The result of the function is a large integer. If the argument
+can be null, the result can be null; if the argument is null, the result is
+the null value.</p> <p>The other rules depend on the data type of the argument
+specified: <ul>
<li>If the argument is a date, timestamp, or valid string representation of
a date or timestamp: The result is the seconds part of the value, which is
an integer between 0 and 59.</li>
@@ -43,4 +44,3 @@
the value 30.</p> </example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefsqlj33562.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj33562.dita?rev=436862&r1=436861&r2=436862&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj33562.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj33562.dita Fri Aug 25 10:22:11 2006
@@ -1,4 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,20 +18,17 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefsqlj33562" xml:lang="en-us">
<title>CAST</title>
+<shortdesc>The CAST function converts a value from one data type to another
+and provides a data type to a dynamic parameter (?) or a NULL value.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>CAST function</indexterm><indexterm>Conversions<indexterm>of
-SQL-92 data types using CAST</indexterm></indexterm><indexterm>Conversions<indexterm>using
-CAST function (explicit)</indexterm></indexterm></keywords>
+<keywords><indexterm>CAST function</indexterm><indexterm>conversions<indexterm>SQL-92
+data types using CAST</indexterm></indexterm><indexterm>conversions<indexterm>CAST
+function (explicit)</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>CAST converts a value from one data type to another and provides
-a data type to a dynamic parameter (?) or a NULL value.</p> <p>CAST expressions
-are permitted anywhere expressions are permitted.</p></section>
+<section> <p>CAST expressions are permitted anywhere expressions are permitted.</p></section>
<refsyn><title>Syntax</title> <codeblock><b>CAST ( [ <i>Expression</i> | NULL | ? ]
AS <i>Datatype</i>)</b></codeblock> <p>The data type to which you are
casting an expression is the <i>target type</i>. The data type of the expression
@@ -40,7 +40,7 @@
conversions between data types are valid. The first column on the table lists
the source types, while the first row lists the target types. A "Y" indicates
that the source to the target is a valid conversion.</desc>
-<tgroup cols="19"><colspec colname="colspec0" colwidth="330*"/><colspec colname="col2"
+<tgroup cols="20"><colspec colname="colspec0" colwidth="330*"/><colspec colname="col2"
colwidth="84*"/><colspec colname="col3" colwidth="84*"/><colspec colname="col4"
colwidth="84*"/><colspec colname="col5" colwidth="84*"/><colspec colname="col6"
colwidth="81*"/><colspec colname="colspec1" colwidth="84*"/><colspec colname="colspec9"
@@ -49,7 +49,8 @@
colwidth="84*"/><colspec colname="colspec4" colwidth="87*"/><colspec colname="colspec3"
colwidth="81*"/><colspec colname="colspec2" colwidth="84*"/><colspec colname="colspec10"
colwidth="84*"/><colspec colname="colspec13" colwidth="84*"/><colspec colname="colspec12"
-colwidth="84*"/><colspec colname="colspec11" colwidth="84*"/>
+colwidth="84*"/><colspec colname="colspec11" colwidth="84*"/><colspec colname="COLSPEC14"
+colwidth="84*"/>
<thead>
<row>
<entry colname="colspec0" valign="top">Types</entry>
@@ -206,6 +207,9 @@
A
M
P</lines></entry>
+<entry colname="COLSPEC14" valign="top"> <lines>X
+M
+L</lines></entry>
</row>
</thead>
<tbody>
@@ -229,6 +233,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">INTEGER</entry>
@@ -250,6 +255,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">BIGINT</entry>
@@ -271,6 +277,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">DECIMAL</entry>
@@ -292,6 +299,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">REAL</entry>
@@ -313,6 +321,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">DOUBLE</entry>
@@ -334,6 +343,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">FLOAT</entry>
@@ -355,6 +365,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">CHAR</entry>
@@ -376,6 +387,7 @@
<entry colname="colspec13">Y</entry>
<entry colname="colspec12">Y</entry>
<entry colname="colspec11">Y</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">VARCHAR</entry>
@@ -397,6 +409,7 @@
<entry colname="colspec13">Y</entry>
<entry colname="colspec12">Y</entry>
<entry colname="colspec11">Y</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">LONG VARCHAR</entry>
@@ -418,6 +431,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">CHAR FOR BIT DATA</entry>
@@ -439,6 +453,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">VARCHAR FOR BIT DATA</entry>
@@ -460,6 +475,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">LONG VARCHAR FOR BIT DATA</entry>
@@ -481,6 +497,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">CLOB</entry>
@@ -502,6 +519,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">BLOB</entry>
@@ -523,6 +541,7 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">DATE</entry>
@@ -544,6 +563,7 @@
<entry colname="colspec13">Y</entry>
<entry colname="colspec12">-</entry>
<entry colname="colspec11">Y</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
<entry colname="colspec0">TIME</entry>
@@ -565,9 +585,10 @@
<entry colname="colspec13">-</entry>
<entry colname="colspec12">Y</entry>
<entry colname="colspec11">Y</entry>
+<entry colname="COLSPEC14">-</entry>
</row>
<row>
-<entry colname="colspec0">TIME STAMP</entry>
+<entry colname="colspec0">TIMESTAMP</entry>
<entry colname="col2">-</entry>
<entry colname="col3">-</entry>
<entry colname="col4">-</entry>
@@ -586,10 +607,33 @@
<entry colname="colspec13">Y</entry>
<entry colname="colspec12">Y</entry>
<entry colname="colspec11">Y</entry>
+<entry colname="COLSPEC14">-</entry>
+</row>
+<row>
+<entry colname="colspec0">XML</entry>
+<entry colname="col2">-</entry>
+<entry colname="col3">-</entry>
+<entry colname="col4">-</entry>
+<entry colname="col5">-</entry>
+<entry colname="col6">-</entry>
+<entry colname="colspec1">-</entry>
+<entry colname="colspec9">-</entry>
+<entry colname="colspec8">-</entry>
+<entry colname="colspec7">-</entry>
+<entry colname="colspec6">-</entry>
+<entry colname="colspec5">-</entry>
+<entry colname="colspec4">-</entry>
+<entry colname="colspec3">-</entry>
+<entry colname="colspec2">-</entry>
+<entry colname="colspec10">-</entry>
+<entry colname="colspec13">-</entry>
+<entry colname="colspec12">-</entry>
+<entry colname="colspec11">-</entry>
+<entry colname="COLSPEC14">Y</entry>
</row>
</tbody>
</tgroup>
-</table></p> <p>If a conversion is valid, CASTs are allowed. Size incompatibilities
+</table></p><p>If a conversion is valid, CASTs are allowed. Size incompatibilities
between the source and target types might cause runtime errors.</p> </section>
<section><title>Notes</title> <p>In this discussion, the <ph conref="refconrefs.dita#prod/productshortname"></ph> SQL-92
data types are categorized as follows: <ul>
@@ -598,8 +642,10 @@
<li>approximate numeric (FLOAT, REAL, DOUBLE PRECISION)</li>
</ul></li>
<li><i>string</i> <ul>
-<li>character string (CLOB, CHAR, VARCHAR, <xref href="rrefsqlj15147.dita#rrefsqlj15147">LONG VARCHAR</xref>)</li>
-<li>bit string (BLOB, CHAR FOR BIT DATA, VARCHAR FOR BIT DATA, <xref href="rrefsqlj30118.dita#rrefsqlj30118">LONG VARCHAR FOR BIT DATA</xref>)</li>
+<li>character string (CLOB, CHAR, VARCHAR, <xref href="rrefsqlj15147.dita#rrefsqlj15147">LONG
+VARCHAR</xref>)</li>
+<li>bit string (BLOB, CHAR FOR BIT DATA, VARCHAR FOR BIT DATA, <xref href="rrefsqlj30118.dita#rrefsqlj30118">LONG
+VARCHAR FOR BIT DATA</xref>)</li>
</ul></li>
<li><i>date/time</i> <ul>
<li><xref href="rrefsqlj18730.dita#rrefsqlj18730"></xref></li>
@@ -642,6 +688,8 @@
FROM FLIGHTS
-- cast a SMALLINT to a BIGINT
VALUES CAST (CAST (12 as SMALLINT) as BIGINT)</b></codeblock> </example>
+<section><title>Conversions of XML values</title><p>An XML value cannot be
+converted to a non-XML type. To convert an XML value to a string, you must
+use the SQL/XML serialization operator XMLSERIALIZE.</p> </section>
</refbody>
</reference>
-