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/23 20:57:20 UTC

svn commit: r434125 - in /db/derby/docs/trunk/src/devguide: cdevdvlp30653.dita cdevstandards805975.dita cdevstandardsxml.dita derbydev.ditamap

Author: jta
Date: Wed Aug 23 11:57:19 2006
New Revision: 434125

URL: http://svn.apache.org/viewvc?rev=434125&view=rev
Log:
DERBY-1655: Documentation for XML functionality to the Developers Guide.

Reverted the patch committed in revision 433708 because the addition of
src/devguide/cdevstandardsxml.dita (or perhaps the corresponding modification
to src/devguide/derbydev.ditamap) causes the DITA PDF build to fail.

Removed:
    db/derby/docs/trunk/src/devguide/cdevstandardsxml.dita
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=434125&r1=434124&r2=434125&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp30653.dita Wed Aug 23 11:57:19 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
  "../dtd/concept.dtd">
 <!-- 
@@ -19,28 +19,31 @@
 limitations under the License.
 -->
 <concept id="cdevdvlp30653" xml:lang="en-us">
-<title><ph conref="devconrefs.dita#prod/productshortname"></ph> database limitations</title>
+<title>Database limitations</title>
 <shortdesc><ph conref="devconrefs.dita#prod/productshortname"></ph> databases
 have a few limitations.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>limitations<indexterm>Derby databases</indexterm></indexterm>
-<indexterm>indexes<indexterm>limitations</indexterm></indexterm></keywords>
+<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>
 </metadata></prolog>
 <conbody>
-<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>
+<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>
 </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=434125&r1=434124&r2=434125&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevstandards805975.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevstandards805975.dita Wed Aug 23 11:57:19 2006
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
- 
+
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
  "../dtd/concept.dtd">
 <!-- 
@@ -19,13 +19,10 @@
 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><metadata>
-<keywords><indexterm>data types<indexterm>CLOB</indexterm></indexterm><indexterm>data
-types<indexterm>BLOB</indexterm></indexterm></keywords>
-</metadata></prolog>
+<prolog></prolog>
 <conbody></conbody>
 </concept>

Modified: db/derby/docs/trunk/src/devguide/derbydev.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/derbydev.ditamap?rev=434125&r1=434124&r2=434125&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/derbydev.ditamap (original)
+++ db/derby/docs/trunk/src/devguide/derbydev.ditamap Wed Aug 23 11:57:19 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,13 +1997,6 @@
 <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">
@@ -2442,26 +2435,24 @@
 <topicref href="cdevin38113.dita" navtitle="Messages libraries"></topicref>
 </topicref>
 <topicref href="cdevstandards806118.dita" navtitle="Derby and standards">
-<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="cdevstandards805664.dita" navtitle="Cursors"></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="cdevstandardsxml.dita" navtitle="XML data types and operators">
+<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>
+<topicref href="cdevstandards806027.dita" navtitle="ALTER TABLE"></topicref>
 </topicref>
 <topicref href="rdevtrademderby.dita" navtitle="Trademarks"></topicref>
 </map>