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/22 19:40:18 UTC
svn commit: r433708 - in /db/derby/docs/trunk/src/devguide:
cdevdvlp30653.dita cdevstandards805975.dita cdevstandardsxml.dita
derbydev.ditamap
Author: jta
Date: Tue Aug 22 10:40:17 2006
New Revision: 433708
URL: http://svn.apache.org/viewvc?rev=433708&view=rev
Log:
DERBY-1655 (partial): Add documentation for XML functionality to the Developers
Guide.
Committed patch derby1655_devguide2.diff by Laura Stewart <sc...@gmail.com>.
Added:
db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita (with props)
Modified:
db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita
db/derby/docs/trunk/src/devguide/cdevstandards805975.dita
db/derby/docs/trunk/src/devguide/derbydev.ditamap
Modified: db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita?rev=433708&r1=433707&r2=433708&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita Tue Aug 22 10:40:17 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-
+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -19,31 +19,28 @@
limitations under the License.
-->
<concept id="cdevdvlp30653" xml:lang="en-us">
-<title>Database limitations</title>
+<title><ph conref="devconrefs.dita#prod/productshortname"></ph> database limitations</title>
<shortdesc><ph conref="devconrefs.dita#prod/productshortname"></ph> databases
have a few limitations.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>Limitations<indexterm>in current version</indexterm></indexterm>
-<indexterm>Indexes<indexterm>limitations of</indexterm><indexterm>not supported
-for CLOB, BLOB, and LONG VARCHAR data types</indexterm></indexterm></keywords>
+<keywords><indexterm>limitations<indexterm>Derby databases</indexterm></indexterm>
+<indexterm>indexes<indexterm>limitations</indexterm></indexterm></keywords>
</metadata></prolog>
<conbody>
-<ul>
-<li><i>Indexes are not supported for columns defined on CLOB, BLOB, and LONG
-VARCHAR data types.</i> <p>If the length of the key columns in an index
-is larger than half the page size of the index, creating an index on those
-key columns for the table fails. For existing indexes, an insert of new rows
-for which the key columns are larger than half of the index page size causes
-the insert to fail.</p> <p>It is generally not recommended to create indexes
-on long columns. It is best to create indexes on small columns that provide
-a quick look-up to larger, unwieldy data in the row. You might not see performance
-improvements if you index long columns. For information about indexes, see <cite><ph
-conref="devconrefs.dita#pub/cittuning"></ph></cite>. </p></li>
-<li><i>The system shuts down if the database log cannot allocate more disk
-space.</i> <p>A "LogFull" error or some sort of <codeph><i>IOException</i></codeph> will
-occur in the <i>derby.log </i> if the system runs out of space. If the system
-has no more disk space to append to the <i>derby.log</i>, you might not see
-the error messages.</p></li>
-</ul>
+<section><title>Indexes</title><p>Indexes are not supported for columns defined
+on CLOB, BLOB, LONG VARCHAR, and XML data types.</p><p>If the length of the
+key columns in an index is larger than half the page size of the index, creating
+an index on those key columns for the table fails. For existing indexes, an
+insert of new rows for which the key columns are larger than half of the index
+page size causes the insert to fail.</p><p>Avoid creating indexes on long
+columns. Create indexes on small columns that provide a quick look-up to larger,
+unwieldy data in the row. You might not see performance improvements if you
+index long columns. For information about indexes, see <cite><ph conref="devconrefs.dita#pub/cittuning"></ph></cite>. </p></section>
+<section><title>System shutdowns</title><p>The system shuts down if the database
+log cannot allocate more disk space.</p><p>A "LogFull" error or some sort
+of <codeph>IOException</codeph> occurs in the <filepath>derby.log</filepath> file
+when the system runs out of space. If the system has no more disk space to
+append to the <filepath>derby.log</filepath> file, you might not see the error
+messages.</p></section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/devguide/cdevstandards805975.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevstandards805975.dita?rev=433708&r1=433707&r2=433708&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevstandards805975.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevstandards805975.dita Tue Aug 22 10:40:17 2006
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-
+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -19,10 +19,13 @@
limitations under the License.
-->
<concept id="cdevstandards805975" xml:lang="en-us">
-<title>CLOB, and BLOB</title>
+<title>CLOB and BLOB</title>
<shortdesc><ph conref="devconrefs.dita#prod/productshortname"></ph> supports
the standard CLOB and BLOB data types. BLOB and CLOB values are limited to
a maximum of 2,147,483,647 characters.</shortdesc>
-<prolog></prolog>
+<prolog><metadata>
+<keywords><indexterm>data types<indexterm>CLOB</indexterm></indexterm><indexterm>data
+types<indexterm>BLOB</indexterm></indexterm></keywords>
+</metadata></prolog>
<conbody></conbody>
</concept>
Added: db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita?rev=433708&view=auto
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita (added)
+++ db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita Tue Aug 22 10:40:17 2006
@@ -0,0 +1,68 @@
+<?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
+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.
+-->
+<concept id="cdevstandardsxml" xml:lang="en-us">
+<title>XML data types and operators</title>
+<shortdesc><ph conref="devconrefs.dita#prod/productshortname"></ph> supports
+the XML data type and a set of operators that work with the XML data type.
+The XML data type and operators are based on a small subset of the SQL/XML
+specification. </shortdesc>
+<prolog><metadata>
+<keywords><indexterm>SQL standards<indexterm>XML data types and operators</indexterm></indexterm>
+<indexterm>XML data types<indexterm>SQL standard</indexterm></indexterm><indexterm>XML
+data types<indexterm>limitations</indexterm></indexterm></keywords>
+</metadata></prolog>
+<conbody>
+<p>The XML data type and operators are defined only in the SQL layer.</p>
+<p>There is no JDBC-side support for XML data types. It is not possible to
+bind directly into an XML value or to retrieve an XML value directly from
+a result set. Instead, you must bind and retrieve the XML data as Java strings
+or character streams by explicitly specifying the appropriate XML operator
+as part of the SQL statements:<ul>
+<li>Use the XMLPARSE operator for binding data into XML values.</li>
+<li>Use the XMLSERIALIZE operator to retrieve XML values from a result set.</li>
+</ul> Additionally, there is no JDBC metadata support for the XML data type.</p>
+<p>The XML data type is not allowed in any of the clauses or operations that
+are described in the section on <xref href="cdevstandards806001.dita#cdevstandards806001">expressions
+on LONG data types</xref>.</p>
+<p>For the XML operators to work properly, <ph conref="devconrefs.dita#prod/productshortname"></ph> requires
+that a JAXP parser, such as Apache Xerces, and Apache Xalan are included in
+the Java classpath. If either the parser or Xalan are missing from the classpath, <ph
+conref="devconrefs.dita#prod/productshortname"></ph> disallows any XML-related
+operations. </p>
+<p>To see a list of the versions of the JAXP implementation and of Apache
+Xalan that have been tested with <ph conref="devconrefs.dita#prod/productshortname"></ph> XML
+support, see to the <ph conref="devconrefs.dita#prod/productshortname"></ph> release
+notes. The release notes are available from the Apache Derby Downloads page.</p>
+<note>Most Java virtual machines (JVMs) that are version 1.4 or later have
+a JAXP parser embedded in the JVM. If you are using one of these JVMs, you
+do not need to add any other JAXP classes to your classpath. Additionally,
+if the JVM that you are using includes an embedded version of Xalan, you should
+confirm that the version of Xalan satisfies the minimum requirements for <ph
+conref="devconrefs.dita#prod/productshortname"></ph>. For example, if your
+JVM is Sun JDK 1.4.2, you must override the version of Xalan in the JVM with
+a newer version. Use Java's Endorsed Standards Override Mechanisms described
+at <xref href="http://java.sun.com/j2se/1.4.2/docs/guide/standards/" scope="external">http://java.sun.com/j2se/1.4.2/docs/guide/standards/</xref> to
+override the version of Xalan. <p>If the JVM that you are using does not have
+a JAXP parser or a version of Xalan, you can add external versions of those
+classes in your classpath and <ph conref="devconrefs.dita#prod/productshortname"></ph> will
+pick up those classes.</p></note>
+</conbody>
+</concept>
Propchange: db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/devguide/derbydev.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/derbydev.ditamap?rev=433708&r1=433707&r2=433708&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/derbydev.ditamap (original)
+++ db/derby/docs/trunk/src/devguide/derbydev.ditamap Tue Aug 22 10:40:17 2006
@@ -1817,7 +1817,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1840,7 +1840,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1862,7 +1862,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1883,7 +1883,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1903,7 +1903,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1921,7 +1921,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1937,7 +1937,7 @@
</topicref>
<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1963,7 +1963,7 @@
</topicref>
</relcell>
<relcell>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
</topicref>
<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
@@ -1971,7 +1971,7 @@
</relrow>
<relrow>
<relcell>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB and BLOB"></topicref>
</relcell>
<relcell>
<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
@@ -1997,6 +1997,13 @@
<topicref href="cdevdvlp40724.dita" navtitle="The database directory"></topicref>
</relcell>
</relrow>
+<relrow>
+<relcell>
+<topicref href="cdevstandardsxml.dita" navtitle="XML data types and operators">
+</topicref>
+</relcell>
+<relcell></relcell>
+</relrow>
</reltable>
<topicref href="rdevcopyright.dita" navtitle="Copyright"></topicref>
<topicref href="cdevdgpref29520.dita" navtitle="About this guide">
@@ -2435,24 +2442,26 @@
<topicref href="cdevin38113.dita" navtitle="Messages libraries"></topicref>
</topicref>
<topicref href="cdevstandards806118.dita" navtitle="Derby and standards">
-<topicref href="cdevstandards805644.dita" navtitle="Dynamic SQL"></topicref>
+<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
+<topicref href="cdevstandards805768.dita" navtitle="Calling functions and procedures">
+</topicref>
+<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
<topicref href="cdevstandards805664.dita" navtitle="Cursors"></topicref>
+<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
+</topicref>
+<topicref href="cdevstandards805644.dita" navtitle="Dynamic SQL"></topicref>
+<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
+</topicref>
<topicref href="cdevstandards805690.dita" navtitle="Information schema"></topicref>
+<topicref href="cdevstandards805893.dita" navtitle="NOT NULL characteristic">
+</topicref>
<topicref href="cdevstandards805716.dita" navtitle="Transactions"></topicref>
<topicref href="cdevstandards805742.dita" navtitle="Stored routines and PSM">
</topicref>
-<topicref href="cdevstandards805768.dita" navtitle="Calling functions and procedures">
-</topicref>
<topicref href="cdevstandards805841.dita" navtitle="Unique constraints and nulls">
</topicref>
-<topicref href="cdevstandards805893.dita" navtitle="NOT NULL characteristic">
-</topicref>
-<topicref href="cdevstandards805949.dita" navtitle="DECIMAL max precision">
-</topicref>
-<topicref href="cdevstandards805975.dita" navtitle="CLOB, and BLOB"></topicref>
-<topicref href="cdevstandards806001.dita" navtitle="Expressions on LONGs">
+<topicref href="cdevstandardsxml.dita" navtitle="XML data types and operators">
</topicref>
-<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
</topicref>
<topicref href="rdevtrademderby.dita" navtitle="Trademarks"></topicref>
</map>