You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2011/04/29 17:28:47 UTC

svn commit: r1097840 - in /db/derby/docs/trunk/src/tuning: ctundepth14326.dita ctunoptimz42065.dita ctunperf98197.dita ctunstats52657.dita ctuntransform13966.dita ctuntransform867201.dita

Author: chaase3
Date: Fri Apr 29 15:28:46 2011
New Revision: 1097840

URL: http://svn.apache.org/viewvc?rev=1097840&view=rev
Log:
DERBY-5184  Tables in documentation need introductions and formatting fixes

Modifications to 6 Tuning Guide topics.

Patches: DERBY-5184-tun.diff

Modified:
    db/derby/docs/trunk/src/tuning/ctundepth14326.dita
    db/derby/docs/trunk/src/tuning/ctunoptimz42065.dita
    db/derby/docs/trunk/src/tuning/ctunperf98197.dita
    db/derby/docs/trunk/src/tuning/ctunstats52657.dita
    db/derby/docs/trunk/src/tuning/ctuntransform13966.dita
    db/derby/docs/trunk/src/tuning/ctuntransform867201.dita

Modified: db/derby/docs/trunk/src/tuning/ctundepth14326.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctundepth14326.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctundepth14326.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctundepth14326.dita Fri Apr 29 15:28:46 2011
@@ -44,26 +44,17 @@ loads additional classes.</p></li>
 by starting them in separate threads while other tasks are occurring.</p>
 <p>In addition, if you are using <i>PreparedStatements</i>, prepare them in
 a separate thread in the background while other tasks are occurring.</p>
-<table>
-<tgroup cols="1" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="100*"/>
-<tbody>
-<row>
-<entry colname="1"> <p><b>Tuning tips for multi-user systems</b>   <ul>
+<section><title>Tuning tips for multi-user systems</title>
+<ul>
 <li>For concurrency, use row-level locking and the READ_COMMITTED isolation
 level.</li>
 <li>For read-only applications, use table-level locking and the READ_COMMITTED
 isolation level.</li>
 <li>Boot databases at startup to minimize the impact of connecting.</li>
-</ul></p></entry>
-</row>
-</tbody>
-</tgroup>
-</table>
-<table>
-<tgroup cols="1" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="100*"/>
-<tbody>
-<row>
-<entry colname="1"> <p><b>Tuning tips for single-user systems</b>   <ul>
+</ul>
+</section>
+<section><title>Tuning tips for single-user systems</title>
+<ul>
 <li><ph conref="../conrefs.dita#prod/productshortname"></ph> boots when you
 first load the embedded JDBC driver (<i>org.apache.derby.</i><i>jdbc.EmbeddedDriver</i>).
 Load this driver during the least time-sensitive portion of your program,
@@ -72,10 +63,7 @@ frameworks, the driver is loaded automat
 <li>Boot the database at connection (the default behavior), not at startup.
 Connect in a background thread if possible.</li>
 <li>Turn off row-level locking and use READ_COMMITTED isolation level.</li>
-</ul></p></entry>
-</row>
-</tbody>
-</tgroup>
-</table>
+</ul>
+</section>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/tuning/ctunoptimz42065.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunoptimz42065.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunoptimz42065.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunoptimz42065.dita Fri Apr 29 15:28:46 2011
@@ -53,103 +53,107 @@ decision. </p>
 any table locks because it would have had to wait, the next lock escalation
 attempt is delayed until the number of held locks has increased by some significant
 amount, for example from 5000 to 6000.</p>
-<p>Here are some examples assuming the escalation threshold is 5000:  
-<ul>
-<li>Single table holding the majority of the locks  
-<table pgwide="0" frame="all">
+<p>Here are some examples, assuming the escalation threshold is 5000.</p> 
+<p>In the following table, a single database table holds the majority of the
+locks.</p>
+<table frame="all">
+<title>Single table holding the majority of the locks</title>
 <tgroup cols="3" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="29*"/>
-<colspec colnum="2" colname="2" colwidth="47*"/>
-<colspec colnum="3" colname="3" colwidth="24*"/>
+<colspec colname="1" colnum="1" colwidth="29*"/>
+<colspec colname="2" colnum="2" colwidth="47*"/>
+<colspec colname="3" colnum="3" colwidth="24*"/>
 <thead>
-<row>
+<row valign="bottom">
 <entry colname="1">Table</entry>
-<entry colname="2">Number of row locks</entry>
+<entry colname="2">Number of Row Locks</entry>
 <entry colname="3">Promote?</entry></row>
 </thead>
 <tbody>
 <row>
 <entry colname="1"><i>Hotels</i></entry>
 <entry colname="2">4853</entry>
-<entry colname="3">yes</entry></row>
+<entry colname="3">Yes</entry></row>
 <row>
 <entry colname="1"><i>Countries</i></entry>
 <entry colname="2">3</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>Cities</i></entry>
 <entry colname="2">12</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 </tbody>
 </tgroup>
-</table></li>
-<li>Two tables holding the majority of the locks  
-<table pgwide="0" frame="all">
+</table>
+<p>In the following table, two database tables hold the majority of the
+locks.</p>
+<table frame="all">
+<title>Two tables holding the majority of the locks</title>
 <tgroup cols="3" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="29*"/>
-<colspec colnum="2" colname="2" colwidth="47*"/>
-<colspec colnum="3" colname="3" colwidth="24*"/>
+<colspec colname="1" colnum="1" colwidth="29*"/>
+<colspec colname="2" colnum="2" colwidth="47*"/>
+<colspec colname="3" colnum="3" colwidth="24*"/>
 <thead>
-<row>
+<row valign="bottom">
 <entry colname="1">Table</entry>
-<entry colname="2">Number of row locks</entry>
+<entry colname="2">Number of Row Locks</entry>
 <entry colname="3">Promote?</entry></row>
 </thead>
 <tbody>
 <row>
 <entry colname="1"><i>Hotels</i></entry>
 <entry colname="2">2349</entry>
-<entry colname="3">yes</entry></row>
+<entry colname="3">Yes</entry></row>
 <row>
 <entry colname="1"><i>Countries</i></entry>
 <entry colname="2">3 </entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>Cities</i></entry>
 <entry colname="2">1800</entry>
-<entry colname="3">yes</entry></row>
+<entry colname="3">Yes</entry></row>
 </tbody>
 </tgroup>
-</table></li>
-<li>Many tables holding a small number of locks  
-<table pgwide="0" frame="all">
+</table>
+<p>In the following table, many database tables hold a small number of
+locks.</p>
+<table frame="all">
+<title>Many tables holding a small number of locks</title>
 <tgroup cols="3" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="27*"/>
-<colspec colnum="2" colname="2" colwidth="48*"/>
-<colspec colnum="3" colname="3" colwidth="25*"/>
+<colspec colname="1" colnum="1" colwidth="27*"/>
+<colspec colname="2" colnum="2" colwidth="48*"/>
+<colspec colname="3" colnum="3" colwidth="25*"/>
 <thead>
-<row>
+<row valign="bottom">
 <entry colname="1">Table</entry>
-<entry colname="2">Number of row locks</entry>
+<entry colname="2">Number of Row Locks</entry>
 <entry colname="3">Promote?</entry></row>
 </thead>
 <tbody>
 <row>
 <entry colname="1"><i>table001</i></entry>
 <entry colname="2">279</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>table002</i></entry>
 <entry colname="2">142</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>table003</i></entry>
 <entry colname="2">356</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>table004</i></entry>
 <entry colname="2">79</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>table194</i></entry>
 <entry colname="2">384</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 <row>
 <entry colname="1"><i>table195</i></entry>
 <entry colname="2">416</entry>
-<entry colname="3">no</entry></row>
+<entry colname="3">No</entry></row>
 </tbody>
 </tgroup>
-</table></li>
-</ul></p>
+</table>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tuning/ctunperf98197.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunperf98197.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunperf98197.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunperf98197.dita Fri Apr 29 15:28:46 2011
@@ -34,16 +34,18 @@ and so on.  (<i>java.sql.ResultSet </i>a
 and <i>java .sql.PreparedStatement</i> and <i>java.sql.CallableStatement</i> provide <i>setXXX</i> methods.)
 This permissiveness is convenient but expensive in terms of performance.</p>
 <p>The following table shows the recommended <i>getXXX</i> methods for given <i>java.sql</i> (JDBC)
-types, and their corresponding SQL types.   <table frame="all" id="ctunperf31241">
-<title>Mapping of java.sql.Types to SQL types</title>
-<tgroup cols="3" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="36*"/>
-<colspec colname="2" colnum="2" colwidth="30*"/><colspec colname="3" colnum="3"
-colwidth="34*"/>
+types, and their corresponding SQL types.</p>
+<table frame="all">
+<title>Mapping of <i>java.sql.Types</i> to SQL types</title>
+<tgroup cols="3" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="36*"/>
+<colspec colname="2" colnum="2" colwidth="30*"/>
+<colspec colname="3" colnum="3" colwidth="34*"/>
 <thead>
-<row>
-<entry colname="1">Recommended <b><i>getXXX</i></b> Method</entry>
-<entry colname="2"><b><i>java.sql.Types</i></b></entry>
-<entry colname="3">SQL types</entry>
+<row valign="bottom">
+<entry colname="1">Recommended <i>getXXX</i> Method</entry>
+<entry colname="2"><i>java.sql.Types</i></entry>
+<entry colname="3">SQL Types</entry>
 </row>
 </thead>
 <tbody>
@@ -103,7 +105,7 @@ colwidth="34*"/>
 <entry colname="3">LONG VARCHAR FOR BIT DATA</entry>
 </row>
 <row>
-<entry colname="1"><i>getAsciiStream, getUnicodeStream</i></entry>
+<entry colname="1"><i>getAsciiStream</i>, <i>getUnicodeStream</i></entry>
 <entry colname="2">LONGVARCHAR</entry>
 <entry colname="3">LONG VARCHAR</entry>
 </row>
@@ -144,12 +146,12 @@ colwidth="34*"/>
 </row>
 <row>
 <entry colname="1">None supported. You must use XMLSERIALIZE and then the
-corresponding getXXX method.</entry>
+corresponding <i>getXXX</i> method.</entry>
 <entry colname="2">SQLXML</entry>
 <entry colname="3">XML</entry>
 </row>
 </tbody>
 </tgroup>
-</table></p>
+</table>
 </conbody>
 </concept>

Modified: db/derby/docs/trunk/src/tuning/ctunstats52657.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunstats52657.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunstats52657.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunstats52657.dita Fri Apr 29 15:28:46 2011
@@ -28,15 +28,16 @@ limitations under the License.
 <p>In all other cases, <ph conref="../conrefs.dita#prod/productshortname"></ph> uses a fixed number that attempts to describe
 the percentage of rows that will probably be returned; it might not correspond
 to the actual selectivity of the operation in every case. It is an assumption
-hard-wired into the <ph conref="../conrefs.dita#prod/productshortname"></ph> system. These assumptions are shown in <xref href="ctunstats52657.dita#ctunstats52657/rtunstats405"/>.</p>
-<table id="rtunstats405" frame="all">
+hard-wired into the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+system. These assumptions are shown in the following table.</p>
+<table frame="all">
 <title>Selectivity for various operations for index scans
 when search values are unknown in advance and statistics are not used</title>
 <tgroup cols="2" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="83*"/>
-<colspec colnum="2" colname="2" colwidth="17*"/>
+<colspec colname="1" colnum="1" colwidth="83*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
 <thead>
-<row>
+<row valign="bottom">
 <entry colname="1">Operator</entry>
 <entry colname="2">Selectivity</entry></row>
 </thead>

Modified: db/derby/docs/trunk/src/tuning/ctuntransform13966.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctuntransform13966.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctuntransform13966.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctuntransform13966.dita Fri Apr 29 15:28:46 2011
@@ -37,13 +37,7 @@ limitations under the License.
 internally for performance reasons. This appendix describes those transformations.
 Understanding the internal language transformations can help you analyze and
 tune performance. Understanding the internal language transformations is not
-necessary for the general user.  
-<table frame="none">
-<tgroup cols="1" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="100*"/>
-<tbody>
-<row>
-<entry colname="1">
+necessary for the general user.</p>
 <p>This chapter uses some specialized terms. Here are some
 definitions:</p>
 <dl id="i827520">
@@ -80,8 +74,5 @@ costing information.   
 <p>In addition, sargable predicates can be <i>pushed down </i>(see <xref href="ctuntransform36623.dita#ctuntransform36623"/>).</p></dd></dlentry>
 <dlentry><dt id="rtuntransform13785">simple column reference</dt>
 <dd>A reference to a column that is not part of an expression. For example, <i>c1</i> is a simple column reference, but <i>c1+1,</i> <i>max(c1)</i>, and <i>lower(c1)</i> are not.</dd></dlentry>
-</dl></entry></row>
-</tbody>
-</tgroup>
-</table></p>
+</dl>
 </conbody></concept>

Modified: db/derby/docs/trunk/src/tuning/ctuntransform867201.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctuntransform867201.dita?rev=1097840&r1=1097839&r2=1097840&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctuntransform867201.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctuntransform867201.dita Fri Apr 29 15:28:46 2011
@@ -41,15 +41,15 @@ to return at most one row are:  
 transformation is performed, the subquery becomes materializable. In the example,
 if the IN subquery were not transformed, it would be evaluated anew for each
 row.</p>
-<p>The subquery type transformation is shown in <xref href="ctuntransform867201.dita#ctuntransform867201/rtuntransform52953"/>:  
-<table id="rtuntransform52953" frame="all">
-<title>IN or ANY Subquery Transformations for Subqueries
-Returning a Single Row</title>
+<p>The subquery type transformation is shown in the following table.</p>  
+<table frame="all">
+<title>IN or ANY subquery transformations for subqueries
+that return a single row</title>
 <tgroup cols="2" colsep="1" rowsep="1">
-<colspec colnum="1" colname="1" colwidth="50*"/>
-<colspec colnum="2" colname="2" colwidth="50*"/>
+<colspec colname="1" colnum="1" colwidth="50*"/>
+<colspec colname="2" colnum="2" colwidth="50*"/>
 <thead>
-<row>
+<row valign="bottom">
 <entry colname="1">Before Transformation</entry>
 <entry colname="2">After Transformation</entry></row>
 </thead>
@@ -77,5 +77,5 @@ Returning a Single Row</title>
 <entry colname="2"><b><codeph>c1 &lt;= (SELECT ...)</codeph></b></entry></row>
 </tbody>
 </tgroup>
-</table></p>
+</table>
 </conbody></concept>