Author: scotsmatrix
Date: Wed Jun  6 08:33:04 2007
New Revision: 544867

URL: http://svn.apache.org/viewvc?view=rev&rev=544867
Log:
DERBY-1964: Documented the changes to SYSCS_UTIL.SYSCS_COMPRESS_TABLE. Patch derby1964_4.diff contributed by me.

Modified:
    db/derby/docs/trunk/src/adminguide/cadminspace21579.dita
    db/derby/docs/trunk/src/ref/rrefaltertablecompress.dita
    db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita
    db/derby/docs/trunk/src/ref/rrefjta16677.dita
    db/derby/docs/trunk/src/ref/rrefjta18596.dita
    db/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita
    db/derby/docs/trunk/src/tuning/ctunstats57373.dita
    db/derby/docs/trunk/src/tuning/rtuntransform582.dita
    db/derby/docs/trunk/src/tuning/tuningderby.ditamap

Modified: db/derby/docs/trunk/src/adminguide/cadminspace21579.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminspace21579.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminspace21579.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminspace21579.dita Wed Jun  6 08:33:04 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
  "../dtd/concept.dtd">
 <!-- 
@@ -23,7 +24,8 @@
 or index (sometimes called a <i>conglomerate</i>) can contain unused space
 after large amounts of data have been deleted or updated.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>Compressing tables and indexes</indexterm></keywords>
+<keywords><indexterm>Compressing tables and indexes</indexterm><indexterm>conglomerate<indexterm>description</indexterm></indexterm>
+</keywords>
 </metadata></prolog>
 <conbody>
 <p>This happens because, by default, <ph conref="../conrefs.dita#prod/productshortname"></ph> does
@@ -36,7 +38,7 @@
 of unused space, use either the SYSCS_UTIL.SYSCS_COMPRESS_TABLE or SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE
 procedure to reclaim that space. SYSCS_COMPRESS_TABLE is guaranteed to recover
 the maximum amount of free space, at the cost of temporarily creating new
-tables and indexes before the statement in committed. SYSCS_INPLACE_COMPRESS
+tables and indexes before the statement is committed. SYSCS_INPLACE_COMPRESS
 attempts to reclaim space within the same table, but cannot guarantee it will
 recover all available space. The difference between the two procedures is
 that unlike SYSCS_COMPRESS_TABLE, the SYSCS_INPLACE_COMPRESS procedure uses
@@ -50,7 +52,7 @@
 will run in non-sequential mode. In sequential mode,<ph conref="../conrefs.dita#prod/productshortname"></ph> compresses
 the table and indexes sequentially, one at a time. Sequential compression
 uses less memory and disk space but is slower. To force the operation to run
-in sequential mode, substitute a non-zero smallint value for the third argument.
+in sequential mode, substitute a non-zero SMALLINT value for the third argument.
 The following example shows how to force the procedure to run in sequential
 mode:</p><codeblock>call SYSCS_UTIL.SYSCS_COMPRESS_TABLE('APP', 'FLIGHTAVAILABILITY', 1);</codeblock></example>
 <section>For more information about this command, see the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>.</section>

Modified: db/derby/docs/trunk/src/ref/rrefaltertablecompress.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefaltertablecompress.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefaltertablecompress.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefaltertablecompress.dita Wed Jun  6 08:33:04 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 
@@ -31,7 +32,9 @@
 not return unused space to the operating system. For example, once a page
 has been allocated to a table or index, it is not automatically returned to
 the operating system until the table or index is destroyed. <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> allows
-you to return unused space to the operating system.</p></section>
+you to return unused space to the operating system.</p><p>The <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
+procedure updates statistics on all indexes as part of the index rebuilding
+process.</p></section>
 <section><title>Syntax</title> <codeblock><b>SYSCS_UTIL.SYSCS_COMPRESS_TABLE (IN SCHEMANAME VARCHAR(128), 
 IN TABLENAME VARCHAR(128), IN SEQUENTIAL SMALLINT)</b></codeblock> <dl><dlentry>
 <dt>SCHEMANAME</dt>
@@ -73,13 +76,12 @@
 <section><p><codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> cannot release
 any permanent disk space back to the operating system until a COMMIT is issued.
 This means that the space occupied by both the base table and its indexes
-cannot be released back to the operating system until a COMMIT is issued.
-(Only the disk space that is temporarily claimed by an external sort can be
-returned to the operating system prior to a COMMIT.) We recommended you issue
-the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> procedure in auto-commit
-mode.   <note>This procedure acquires an exclusive table lock on the table
-being compressed. All statement plans dependent on the table or its indexes
-are invalidated. For information on identifying unused space, see the <cite><ph
-conref="../conrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
+cannot be released. Only the disk space that is temporarily claimed by an
+external sort can be returned to the operating system prior to a COMMIT. <note
+type="tip">We recommend that you issue the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
+procedure in the auto-commit mode. </note></p><note>This procedure acquires
+an exclusive table lock on the table being compressed. All statement plans
+dependent on the table or its indexes are invalidated. For information on
+identifying unused space, see the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>.</note></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita Wed Jun  6 08:33:04 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 

Modified: db/derby/docs/trunk/src/ref/rrefjta16677.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjta16677.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjta16677.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjta16677.dita Wed Jun  6 08:33:04 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 

Modified: db/derby/docs/trunk/src/ref/rrefjta18596.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjta18596.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjta18596.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjta18596.dita Wed Jun  6 08:33:04 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 

Modified: db/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita Wed Jun  6 08:33:04 2007
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 
@@ -99,10 +100,10 @@
 cs.setShort(4, (short) 0);
 cs.setShort(5, (short) 1);
 cs.execute();</codeblock></p></section>
-<section><p>It is recommended that the SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE
-procedure be issued in autocommit mode.<note>This procedure acquires an exclusive
-table lock on the table being compressed. All statement plans dependent on
-the table or its indexes are invalidated. For information on identifying unused
-space, see the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
+<section><p><note type="tip">We recommend that you issue the <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> system
+procedure in the auto-commit mode. </note><note>This procedure acquires an
+exclusive table lock on the table being compressed. All statement plans dependent
+on the table or its indexes are invalidated. For information on identifying
+unused space, see the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/tuning/ctunstats57373.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunstats57373.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunstats57373.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunstats57373.dita Wed Jun  6 08:33:04 2007
@@ -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,27 +18,28 @@
 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 xml:lang="en-us" id="ctunstats57373">
+<concept id="ctunstats57373" xml:lang="en-us">
 <title>When cardinality statistics are automatically updated</title>
-<prolog>
-</prolog>
+<prolog><metadata>
+<keywords><indexterm>cardinality statistics<indexterm>automatic updates</indexterm></indexterm>
+<indexterm>statistics<indexterm>cardinality, automatic updates</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
 <conbody>
 <p>For the following operations that you perform on a table, <ph conref="../conrefs.dita#prod/productshortname"></ph> automatically
-creates statistics. Those operations are:  
-<ul>
-<li>(new index only) When you create a new index on an existing non-empty
-table.</li>
-<li>(new backing indexes only) When you add a primary key, unique, or foreign
-key constraint to an existing non-empty table.</li>
-</ul></p>
-<p>For other operations, <ph conref="../conrefs.dita#prod/productshortname"></ph> automatically updates statistics for
-the table and all indexes on the table if they are already exist. Those operations
-are:  
-<ul>
-<li>(all indexes) When you execute SYSCS_UTIL.SYSCS_COMPRESS_TABLE.</li>
-<li>(index only) When you drop a column that is part of a table's index;
-the statistics for the affected index are dropped, and statistics for the
-other indexes on the table are updated.</li>
+creates new statistics or updates existing statistics:   <ul>
+<li>When you create a new index on an existing non-empty table. Statistics
+are automatically created for only the new index.</li>
+<li>When you add a primary key, unique, or foreign key constraint to an existing
+non-empty table. If there is no existing index that can be used for the new
+key or constraint, <ph conref="../conrefs.dita#prod/productshortname"></ph> automatically
+creates statistics for only the new indexes.</li>
+<li>When you run the SYSCS_UTIL.SYSCS_COMPRESS_TABLE system procedure. Statistics
+are created automatically for all indexes if the statistics do not already
+exist.</li>
+<li>When you drop a column that is part of a table's index, the statistics
+for the affected index are dropped. Statistics are automatically updated for
+the other indexes on the table.</li>
 </ul></p>
-</conbody></concept>
+</conbody>
+</concept>

Modified: db/derby/docs/trunk/src/tuning/rtuntransform582.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/rtuntransform582.dita?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/tuning/rtuntransform582.dita (original)
+++ db/derby/docs/trunk/src/tuning/rtuntransform582.dita Wed Jun  6 08:33:04 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 

Modified: db/derby/docs/trunk/src/tuning/tuningderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/tuningderby.ditamap?view=diff&rev=544867&r1=544866&r2=544867
==============================================================================
--- db/derby/docs/trunk/src/tuning/tuningderby.ditamap (original)
+++ db/derby/docs/trunk/src/tuning/tuningderby.ditamap Wed Jun  6 08:33:04 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2006, v.4002-->
+
 <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
  "../dtd/map.dtd">
 <!--