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 2005/06/20 20:38:09 UTC
svn commit: r191531 - /incubator/derby/docs/trunk/src/ref/
Author: jta
Date: Mon Jun 20 11:38:07 2005
New Revision: 191531
URL: http://svn.apache.org/viewcvs?rev=191531&view=rev
Log:
DERBY-367 Applied Jeff Levitt's patch that documents
SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE()
Added:
incubator/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita
Modified:
incubator/derby/docs/trunk/src/ref/DitaLink.cat
incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemfunctions.dita
incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemprocedures.dita
incubator/derby/docs/trunk/src/ref/crefsqlj23296.dita
incubator/derby/docs/trunk/src/ref/crefsqlj31068.dita
incubator/derby/docs/trunk/src/ref/crefsqlj34834.dita
incubator/derby/docs/trunk/src/ref/crefsqlj35312.dita
incubator/derby/docs/trunk/src/ref/crefsqlj39374.dita
incubator/derby/docs/trunk/src/ref/crefsqlj41507.dita
incubator/derby/docs/trunk/src/ref/crefsqljrenamestatements.dita
incubator/derby/docs/trunk/src/ref/refderby.ditamap
incubator/derby/docs/trunk/src/ref/rrefaltertablecompress.dita
Modified: incubator/derby/docs/trunk/src/ref/DitaLink.cat
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/DitaLink.cat?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/DitaLink.cat (original)
+++ incubator/derby/docs/trunk/src/ref/DitaLink.cat Mon Jun 20 11:38:07 2005
@@ -1,3 +0,0 @@
-# (v2.0) Dita Link Catalog for: C:/derby/derby335/trunk/src/ref updated: Fri Jun 10 09:46:06 2005
-*MAP0|C:/derby/derby335/trunk/src/ref
-*MAP1|C:/derby/derby335/trunk/src/ref
Modified: incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemfunctions.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemfunctions.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemfunctions.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemfunctions.dita Mon Jun 20 11:38:07 2005
@@ -21,11 +21,7 @@
<title>Built-in system functions</title>
<conbody>
<p>This section describes the different built-in system functions available
-with <ph conref="refconrefs.dita#prod/productshortname"></ph>. <ul>
-<li><xref href="rrefsyscschecktablefunc.dita#rrefsyscschecktablefunc"></xref></li>
-<li><xref href="rrefsyscsruntimestatsfunc.dita#rrefsyscsruntimestatsfunc"></xref></li>
-<li><xref href="rrefgetdbpropfunc.dita#rrefgetdbpropfunc"></xref></li>
-</ul></p>
+with <ph conref="refconrefs.dita#prod/productshortname"></ph>.</p>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemprocedures.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemprocedures.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemprocedures.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlbuiltinsystemprocedures.dita Mon Jun 20 11:38:07 2005
@@ -20,21 +20,8 @@
<concept id="crefsqlbuiltinsystemprocedures" xml:lang="en-us">
<title>Built-in system procedures</title>
<conbody>
-<p>Some built-in procedures are not compatible with SQL syntax used by IBM®
-DB2 Universal Database. These procedures can only be used with <ph conref="refconrefs.dita#prod/productshortname"></ph>. <ul>
-<li><xref href="rrefaltertablecompress.dita#rrefaltertablecompress"></xref></li>
-<li><xref href="rrefsqlj38831.dita#rrefsqlj38831"></xref></li>
-<li><xref href="rrefsetstatstimingproc.dita#rrefsetstatstimingproc"></xref></li>
-<li><xref href="rrefsetdbpropproc.dita#rrefsetdbpropproc"></xref></li>
-<li><xref href="rreffreezedbproc.dita#rreffreezedbproc"></xref></li>
-<li><xref href="rrefunfreezedbproc.dita#rrefunfreezedbproc"></xref></li>
-<li><xref href="rrefcheckpointdbproc.dita#rrefcheckpointdbproc"></xref></li>
-<li><xref href="rrefbackupdbproc.dita#rrefbackupdbproc"></xref></li>
-<li><xref href="rrefexportproc.dita#rrefexportproc"></xref></li>
-<li><xref href="rrefexportselectionproc.dita#rrefexportselectionproc"></xref></li>
-<li><xref href="rrefimportproc.dita#rrefimportproc"></xref></li>
-<li><xref href="rrefimportdataproc.dita#rrefimportdataproc"></xref></li>
-</ul></p>
+<p>Some built-in procedures are not compatible with SQL syntax used by IBM
+DB2 Universal Database. These procedures can only be used with <ph conref="refconrefs.dita#prod/productshortname"></ph>.</p>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj23296.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj23296.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj23296.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj23296.dita Mon Jun 20 11:38:07 2005
@@ -22,16 +22,9 @@
<conbody>
<p><ph conref="refconrefs.dita#prod/productshortname"></ph> implements an
SQL-92 core subset, as well as some SQL-99 features.</p>
-<p>This document provides an overview of the current SQL language by describing
+<p>This section provides an overview of the current SQL language by describing
the statements, built-in functions, data types, expressions, and special characters
-it contains. It includes the following sections: <ul>
-<li><xref href="rrefsqlj28468.dita#rrefsqlj28468"></xref></li>
-<li><xref href="crefsqlj18919.dita#crefsqlj18919"></xref></li>
-<li><xref href="crefsqlj39374.dita#crefsqlj39374"></xref></li>
-<li><xref href="rrefsqlj29026.dita#rrefsqlj29026"></xref></li>
-<li><xref href="crefsqlj31068.dita#crefsqlj31068"></xref></li>
-<li><xref href="rrefsqlj19433.dita#rrefsqlj19433"></xref></li>
-</ul></p>
+it contains.</p>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj31068.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj31068.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj31068.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj31068.dita Mon Jun 20 11:38:07 2005
@@ -20,12 +20,6 @@
<concept id="crefsqlj31068" xml:lang="en-us">
<title>Data types</title>
<conbody>
-<ul>
-<li><xref href="crefsqlj21305.dita#crefsqlj21305"></xref></li>
-<li><xref href="crefsqlj41507.dita#crefsqlj41507"></xref></li>
-<li><xref href="rrefsqlj58560.dita#rrefsqlj58560"></xref></li>
-<li><xref href="rrefsqlj75638.dita#rrefsqlj75638"></xref></li>
-</ul>
-</conbody>
+This section describes the data types used in <ph conref="refconrefs.dita#prod/productshortname"></ph>.</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj34834.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj34834.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj34834.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj34834.dita Mon Jun 20 11:38:07 2005
@@ -36,18 +36,7 @@
-- catalogs with case intact</ph>
CREATE VIEW "ACaseSensitiveIdentifier" (RECEIVED) AS VALUES 1</b></codeblock></section>
<section><p>This section describes the rules for using <i>SQL92Identifiers</i> to
-represent the following dictionary objects: <ul>
-<li><i><xref href="rrefschemaname.dita#rrefschemaname"></xref></i></li>
-<li><i><xref href="rreftablename.dita#rreftablename"></xref></i></li>
-<li><i><xref href="rrefcorrelationname.dita#rrefcorrelationname"></xref></i></li>
-<li><i><xref href="rrefcolumnname.dita#rrefcolumnname"></xref></i></li>
-<li><i><xref href="rrefsimplecolumnname.dita#rrefsimplecolumnname"></xref></i></li>
-<li><i><xref href="rrefindexname.dita#rrefindexname"></xref></i></li>
-<li><i><xref href="rrefconstraintname.dita#rrefconstraintname"></xref></i></li>
-<li><i><xref href="rrefcursorname.dita#rrefcursorname"></xref></i></li>
-<li><i><xref href="rreftriggername.dita#rreftriggername"></xref></i></li>
-<li><i><xref href="rrefrauthid.dita#rrefrauthid"></xref></i></li>
-</ul></p></section>
+represent the following dictionary objects.</p></section>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj35312.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj35312.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj35312.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj35312.dita Mon Jun 20 11:38:07 2005
@@ -21,10 +21,6 @@
<title>SET statements</title>
<conbody>
<p>Use the Set statements with schemas and to set the current isolation level.</p>
-<ul>
-<li><xref href="rrefsqlj32268.dita#rrefsqlj32268"></xref></li>
-<li><xref href="rrefsqlj41180.dita#rrefsqlj41180"></xref></li>
-</ul>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj39374.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj39374.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj39374.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj39374.dita Mon Jun 20 11:38:07 2005
@@ -34,15 +34,8 @@
then execute all the high-level statements, which are all marked with the
word <i>statement</i>, via the interfaces provided by JDBC. This manual indicates
whether an expression can be executed as a high-level statement.</p>
-<p>The sections below provide general information about statement use, and
-descriptions of the specific statements. <ul>
-<li><xref href="crefsqlj22771.dita#crefsqlj22771"></xref></li>
-<li><xref href="rrefsqlj81859.dita#rrefsqlj81859"></xref></li>
-<li><xref href="crefsqlj95081.dita#crefsqlj95081"></xref></li>
-<li><xref href="crefsqlj80721.dita#crefsqlj80721"></xref></li>
-<li><xref href="crefsqljrenamestatements.dita#crefsqljrenamestatements"></xref></li>
-<li><xref href="crefsqlj35312.dita#crefsqlj35312"></xref></li>
-</ul></p>
+<p>The sections provide general information about statement use, and
+descriptions of the specific statements.</p>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqlj41507.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqlj41507.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqlj41507.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqlj41507.dita Mon Jun 20 11:38:07 2005
@@ -20,12 +20,7 @@
<concept id="crefsqlj41507" xml:lang="en-us">
<title>Numeric types</title>
<conbody>
-<ul>
-<li><xref href="crefsqlj28138.dita#crefsqlj28138"></xref></li>
-<li><xref href="rrefsqlj27767.dita#rrefsqlj27767"></xref></li>
-<li><xref href="rrefsqlj20204.dita#rrefsqlj20204"></xref></li>
-<li><xref href="rrefsqlj36146.dita#rrefsqlj36146"></xref></li>
-</ul>
+Numeric types used in <ph conref="refconrefs.dita#prod/productshortname"></ph>.
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/crefsqljrenamestatements.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/crefsqljrenamestatements.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/crefsqljrenamestatements.dita (original)
+++ incubator/derby/docs/trunk/src/ref/crefsqljrenamestatements.dita Mon Jun 20 11:38:07 2005
@@ -21,10 +21,6 @@
<title>RENAME statements</title>
<conbody>
<p>Use the Rename statements with indexes and tables.</p>
-<ul>
-<li><xref href="rrefsqlj95598.dita#rrefsqlj95598"></xref></li>
-<li><xref href="crefsqljrenamestatements.dita#crefsqljrenamestatements"></xref></li>
-</ul>
</conbody>
</concept>
Modified: incubator/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/refderby.ditamap?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ incubator/derby/docs/trunk/src/ref/refderby.ditamap Mon Jun 20 11:38:07 2005
@@ -229,6 +229,8 @@
<topicref href="crefsqlbuiltinsystemprocedures.dita" navtitle="Built-in system procedures">
<topicref href="rrefaltertablecompress.dita" navtitle="SYSCS_UTIL.SYSCS_COMPRESS_TABLE">
</topicref>
+<topicref href="rrefproceduresinplacecompress.dita" navtitle="SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE">
+</topicref>
<topicref href="rrefsqlj38831.dita" navtitle="SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS">
</topicref>
<topicref href="rrefsetstatstimingproc.dita" navtitle="SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING">
Modified: incubator/derby/docs/trunk/src/ref/rrefaltertablecompress.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/rrefaltertablecompress.dita?rev=191531&r1=191530&r2=191531&view=diff
==============================================================================
--- incubator/derby/docs/trunk/src/ref/rrefaltertablecompress.dita (original)
+++ incubator/derby/docs/trunk/src/ref/rrefaltertablecompress.dita Mon Jun 20 11:38:07 2005
@@ -1,4 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
<!--
Copyright 1997, 2004 The Apache Software Foundation or its licensors, as applicable.
@@ -14,25 +16,23 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
<reference id="rrefaltertablecompress" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</title>
+<prolog><metadata>
+<keywords><indexterm>Compressing Tables</indexterm><indexterm>System procedures<indexterm>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</indexterm></indexterm>
+<indexterm>SYSCS_UTIL.SYSCS_COMPRESS_TABLE system procedure</indexterm></keywords>
+</metadata></prolog>
<refbody>
-<section><p><indexterm>Compressing Tables</indexterm><indexterm>System procedures<indexterm>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</indexterm></indexterm
-><indexterm>SYSCS_UTIL.SYSCS_COMPRESS_TABLE system procedure</indexterm>Use
-the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system procedure to reclaim
-unused, allocated space in a table and its indexes. Typically, unused allocated
-space exists when a large amount of data is deleted from a table, or indexes
-are updated. By default, <ph conref="refconrefs.dita#prod/productshortname"></ph> does
+<section><p>Use the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
+procedure to reclaim unused, allocated space in a table and its indexes. Typically,
+unused allocated space exists when a large amount of data is deleted from
+a table, or indexes are updated. By default, <ph conref="refconrefs.dita#prod/productshortname"></ph> does
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>
<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>
+IN TABLENAME VARCHAR(128), IN SEQUENTIAL SMALLINT)</b></codeblock> <dl><dlentry>
<dt>SCHEMANAME</dt>
<dd>An input argument of type VARCHAR(128) that specifies the schema of the
table. Passing a null will result in an error. </dd>
@@ -82,4 +82,3 @@
conref="refconrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
</refbody>
</reference>
-
Added: incubator/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita
URL: http://svn.apache.org/viewcvs/incubator/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita?rev=191531&view=auto
==============================================================================
--- incubator/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita (added)
+++ incubator/derby/docs/trunk/src/ref/rrefproceduresinplacecompress.dita Mon Jun 20 11:38:07 2005
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//IBM//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Copyright 1997, 2004 The Apache Software Foundation or its licensors, as applicable.
+
+Licensed 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="rrefproceduresinplacecompress" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</title>
+<prolog><metadata>
+<keywords><indexterm>Reclaiming unused space</indexterm><indexterm>System
+procedures<indexterm>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</indexterm></indexterm>
+<indexterm>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE system procedure</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section><p>Use the <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> system
+procedure to reclaim unused, allocated space in a table and its indexes. Typically,
+unused allocated space exists when a large amount of data is deleted from
+a table and there has not been any subsequent inserts to use the space created
+by the deletes. By default, <ph conref="refconrefs.dita#prod/productshortname"></ph> does
+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_INPLACE_COMPRESS_TABLE</codeph> allows
+you to return unused space to the operating system.</p><p>This system procedure
+can be used to force three levels of in-place compression of a SQL table: <codeph>PURGE_ROWS</codeph>, <codeph>DEFRAGMENT_ROWS</codeph>,
+and <codeph>TRUNCATE_END</codeph>. Unlike <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE()</codeph>,
+all work is done in place in the existing table/index.</p></section>
+<section><title>Syntax</title><codeblock><b>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE(
+ IN SCHEMANAME VARCHAR(128),
+ IN TABLENAME VARCHAR(128),
+ IN PURGE_ROWS SMALLINT,
+ IN DEFRAGMENT_ROWS SMALLINT,
+ IN TRUNCATE_END SMALLINT )</b></codeblock> <dl><dlentry>
+<dt>SCHEMANAME</dt>
+<dd>An input argument of type VARCHAR(128) that specifies the schema of the
+table. Passing a null will result in an error. </dd>
+</dlentry><dlentry>
+<dt>TABLENAME</dt>
+<dd>An input argument of type VARCHAR(128) that specifies the table name of
+the table. The string must exactly match the case of the table name, and the
+argument of "Fred" will be passed to SQL as the delimited identifier 'Fred'.
+ Passing a null will result in an error.</dd>
+</dlentry><dlentry>
+<dt>PURGE_ROWS</dt>
+<dd>If PURGE_ROWS is set to a non-zero value, then a single pass is made through
+the table which will purge committed deleted rows from the table. This space
+is then available for future inserted rows, but remains allocated to the table.
+As this option scans every page of the table, its performance is linearly
+related to the size of the table.</dd>
+</dlentry><dlentry>
+<dt>DEFRAGMENT_ROWS</dt>
+<dd>If DEFRAGMENT_ROWS is set to a non-zero value, then a single defragment
+pass is made which will move existing rows from the end of the table towards
+the front of the table. The goal of defragmentation is to empty a set of pages
+at the end of the table which can then be returned to the operating system
+by the TRUNCATE_END option. It is recommended to only run DEFRAGMENT_ROWS
+if also specifying the TRUNCATE_END option. The DEFRAGMENT_ROWS option scans
+the whole table and needs to update index entries for every base table row
+move, so the execution time is linearly related to the size of the table.</dd>
+</dlentry><dlentry>
+<dt>TRUNCATE_END</dt>
+<dd>If TRUNCATE_END is set to a non-zero value, then all contiguous pages
+at the end of the table will be returned to the operating system. Running
+the PURGE_ROWS and/or DEFRAGMENT_ROWS options may increase the number of pages
+affected. This option by itself performs no scans of the table. </dd>
+</dlentry></dl></section>
+<section><title>SQL example</title><p>To compress a table called CUSTOMER
+in a schema called US, using all available compress options:<codeblock><b>call SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE('US', 'CUSTOMER', 1, 1, 1);</b
+></codeblock></p><p>To return the empty free space at the end of the same
+table, the following call will run much quicker than running all options but
+will likely return much less space:<codeblock><b>call SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE('US', 'CUSTOMER', 0, 0, 1);</b></codeblock></p></section>
+<section><title>Java example</title><p>To compress a table called CUSTOMER
+in a schema called US, using all available compress options:<codeblock>CallableStatement cs = conn.prepareCall
+("CALL SYSCS_UTIL.SYSCS_COMPRESS_TABLE(?, ?, ?, ?, ?)");
+cs.setString(1, "US");
+cs.setString(2, "CUSTOMER");
+cs.setShort(3, (short) 1);
+cs.setShort(4, (short) 1);
+cs.setShort(5, (short) 1);
+cs.execute();</codeblock></p><p>To return the empty free space at the end
+of the same table, the following call will run much quicker than running all
+options but will likely return much less space:<codeblock>CallableStatement cs = conn.prepareCall
+("CALL SYSCS_UTIL.SYSCS_COMPRESS_TABLE(?, ?, ?, ?, ?)");
+cs.setString(1, "US");
+cs.setString(2, "CUSTOMER");
+cs.setShort(3, (short) 0);
+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="refconrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
+</refbody>
+</reference>