db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1443747 - in /db/derby/docs/trunk/src: adminguide/ devguide/ ref/
Date Thu, 07 Feb 2013 21:54:06 GMT
Author: chaase3
Date: Thu Feb  7 21:54:05 2013
New Revision: 1443747

URL: http://svn.apache.org/r1443747
Log:
DERBY-6065  LockTable API link in the documentation is broken 

Updated the Dev Guide topic mentioned in the issue; corrected 3 similar problems in the Admin Guide; made API reference in src/ref/rrefproperpreallocator.dita consistent; reorganized and added column info tables for SYSCS_DIAG tables/functions to remove need to refer to internal javadoc.

Patch: DERBY-6065.diff

Added:
    db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita   (with props)
    db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita   (with props)
Modified:
    db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
    db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita
    db/derby/docs/trunk/src/adminguide/radminjmxintro.dita
    db/derby/docs/trunk/src/devguide/cdevconcepts50894.dita
    db/derby/docs/trunk/src/ref/refderby.ditamap
    db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita
    db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita

Modified: db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxcode.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxcode.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxcode.dita Thu Feb  7 21:54:05 2013
@@ -169,11 +169,8 @@ name:</p>
 <p>In the previous examples, you have already seen how to read a single MBean
 attribute, and how to invoke an MBean operation. In order to do this, you
 usually need a reference to the MBean's <codeph>ObjectName</codeph>.</p>
-<p>If you consult the API documentation for the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans at
-<xref format="html"
-href="http://db.apache.org/derby/javadoc/publishedapi/jdbc4/"
-scope="external">http://db.apache.org/derby/javadoc/publishedapi/jdbc4/</xref>
+<p>If you consult the public API documentation for the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans 
 and obtain the system identifier of the
 <ph conref="../conrefs.dita#prod/productshortname"></ph> system you are
 accessing through JMX, you have all the information you need to be able to

Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita Thu Feb  7 21:54:05 2013
@@ -42,13 +42,10 @@ permission java.net.SocketPermission "lo
 //   non-default
 // Note: Allows outbound connections to any host!
 permission java.net.SocketPermission "*", "connect,resolve";</codeblock>
-<p>If you are using a custom security policy, refer to the public API of
-the <ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans at
-<xref format="html"
-href="http://db.apache.org/derby/javadoc/publishedapi/jdbc4/"
-scope="external">http://db.apache.org/derby/javadoc/publishedapi/jdbc4/</xref>
-and to the <ph conref="../conrefs.dita#prod/productshortname"></ph> security
-policy file template
+<p>If you are using a custom security policy, refer to the public API
+documentation for the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+MBeans and to the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+security policy file template
 (<codeph>$DERBY_HOME/demo/templates/server.policy</codeph>) for details about
 the permissions you may need to set to allow or restrict specific JMX access.
 This recommendation also applies if you are running

Modified: db/derby/docs/trunk/src/adminguide/radminjmxintro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxintro.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxintro.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxintro.dita Thu Feb  7 21:54:05 2013
@@ -30,12 +30,9 @@ limitations under the License.
 <section>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides the
 MBeans described in this section.</p>
-<p>The API documentation for each
+<p>The public API documentation for each
 <ph conref="../conrefs.dita#prod/productshortname"></ph> MBean describes its
-features in detail. You can find this documentation at <xref format="html"
-href="http://db.apache.org/derby/javadoc/publishedapi/jdbc4/"
-scope="external">http://db.apache.org/derby/javadoc/publishedapi/jdbc4/</xref>.
-</p>
+features in detail.</p>
 </section>
 <section><title>VersionMBean</title>
 <p><codeph>VersionMBean</codeph> exposes version information about the running

Modified: db/derby/docs/trunk/src/devguide/cdevconcepts50894.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevconcepts50894.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevconcepts50894.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevconcepts50894.dita Thu Feb  7 21:54:05 2013
@@ -19,18 +19,15 @@ See the License for the specific languag
 limitations under the License.
 -->
 <concept id="cdevconcepts50894" xml:lang="en-us">
-<title>Debugging Deadlocks</title>
+<title>Debugging deadlocks</title>
 <shortdesc>If deadlocks occur frequently in your multi-user system with a
 particular application, you might need to do some debugging.</shortdesc>
 <prolog></prolog>
 <conbody>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides a class
-    to help you in this situation, <i>org.apache.derby.diag.LockTable</i>.
-    Access to the <i>LockTable</i> information is provided via the
-    SYSCS_DIAG.LOCK_TABLE diagnostic table.</p>
-<p>The SYSCS_DIAG.LOCK_TABLE
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides the
+SYSCS_DIAG.LOCK_TABLE diagnostic table to help you debug deadlocks. This
 diagnostic table shows all of the locks that are currently held in the <ph
-    conref="../conrefs.dita#prod/productshortname"></ph> database. 
+conref="../conrefs.dita#prod/productshortname"></ph> database. 
 You can reference the SYSCS_DIAG.LOCK_TABLE diagnostic table directly
 in a statement.</p>
 <p>For
@@ -39,18 +36,15 @@ in a statement.</p>
 the SYSCS_DIAG.LOCK_TABLE diagnostic table is referenced in a statement, a
 snapshot of the lock table is taken.
 </p><p>
-    For more information about how to use this table:
-    <ul>
-        <li>See "SYSCS_DIAG diagnostic tables and functions" in the
-            <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>.</li>
-        <li>See the <xref format="html"
-            href="http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/LockTable.html" scope="external">LockTable API documentation</xref>.
-        </li>
-    </ul>
-    You
+For more information about how to use this table, see
+"SYSCS_DIAG.LOCK_TABLE diagnostic table" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
+<p>You
 can also set the property <i>derby.locks.deadlockTrace</i> to dump additional
-information to the derby.log file about any deadlocks that occur on your system. 
-See the Tuning Guide for more information on this property. For information, see the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>.</p>
+information to the <i>derby.log</i> file about any deadlocks that occur on your
+system. See <ph conref="../conrefs.dita#pub/citref"></ph> for more information
+on this property. Also see "Monitoring deadlocks" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
 <p>Additional general information about diagnosing locking problems can be
     found in the <ph conref="../conrefs.dita#prod/productshortname"></ph>
     Wiki at <xref format="html"

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Feb  7 21:54:05 2013
@@ -913,7 +913,15 @@ limitations under the License.
 </topicref>
 </topicref>
 </topicref>
-<topicref href="rrefsyscsdiagtables.dita" navtitle="SYSCS_DIAG diagnostic tables and functions">
+<topicref collection-type="family" href="rrefsyscsdiagtables.dita" navtitle="SYSCS_DIAG diagnostic tables and functions">
+<topicref href="rrefsyscsdiagcontainedroles.dita" navtitle="SYSCS_DIAG.CONTAINED_ROLES diagnostic table function"></topicref>
+<topicref href="rrefsyscsdiagerrorlogreader.dita" navtitle="SYSCS_DIAG.ERROR_LOG_READER diagnostic table function"></topicref>
+<topicref href="rrefsyscsdiagerrormessages.dita" navtitle="SYSCS_DIAG.ERROR_MESSAGES diagnostic table"></topicref>
+<topicref href="rrefsyscsdiaglocktable.dita" navtitle="SYSCS_DIAG.LOCK_TABLE diagnostic table"></topicref>
+<topicref href="rrefsyscsdiagspacetable.dita" navtitle="SYSCS_DIAG.SPACE_TABLE diagnostic table function"></topicref>
+<topicref href="rrefsyscsdiagstatementcache.dita" navtitle="SYSCS_DIAG.STATEMENT_CACHE diagnostic table"></topicref>
+<topicref href="rrefsyscsdiagstatementduration.dita" navtitle="SYSCS_DIAG.STATEMENT_DURATION diagnostic table function"></topicref>
+<topicref href="rrefsyscsdiagtransactiontable.dita" navtitle="SYSCS_DIAG.TRANSACTION_TABLE diagnostic table"></topicref>
 </topicref>
 <topicref href="crefsqlj31068.dita" navtitle="Data types">
 <topicref href="crefsqlj21305.dita" navtitle="Built-In type overview"></topicref>

Modified: db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefproperpreallocator.dita Thu Feb  7 21:54:05 2013
@@ -51,9 +51,9 @@ sequences.</p>
 <p>
 If set to a class name, that class must implement
 <i>org.apache.derby.catalog.SequencePreallocator</i>. The class
-customizes the size of the preallocation range for each sequence. For more information, see the public API javadoc for
-<i>org.apache.derby.catalog.SequencePreallocator</i>.
-</p>
+customizes the size of the preallocation range for each sequence. For more
+information, see the public API documentation for
+<i>org.apache.derby.catalog.SequencePreallocator</i>.</p>
 </refsyn>
 <section><title>Default</title>
 <p>100</p>

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagcontainedroles" xml:lang="en-us">
+<title>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</title>
+<prolog><metadata>
+<keywords>
+<indexterm>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</indexterm>
+<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.CONTAINED_ROLES</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.CONTAINED_ROLES diagnostic table function returns all the
+roles contained within the specified role. The argument that is passed to this
+table function should be the name of the role, specified as a string in quotes,
+or the special keyword CURRENT_ROLE, which indicates the current role in
+effect. For a definition of role containment, see "Syntax for roles" in
+<xref href="rrefsqljgrant.dita#rrefsqljgrant/grantrolesyn">GRANT
+statement</xref>.</p>
+<p>For example:</p>
+<codeblock>SELECT * FROM TABLE (SYSCS_DIAG.CONTAINED_ROLES('READER')) AS T1
+SELECT * FROM TABLE (SYSCS_DIAG.CONTAINED_ROLES(CURRENT_ROLE)) AS T2
+</codeblock>
+<p>All users can access this diagnostic table function, whether or not the
+database has authentication and SQL authorization enabled.</p>
+<p>The returned table has the column shown in the following table.</p>
+<table frame="all">
+<title>Column returned by the SYSCS_DIAG.CONTAINED_ROLES table function</title>
+<desc>For the column returned by the SYSCS_DIAG.CONTAINED_ROLES table function, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">ROLEID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The identifier of the role.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagerrorlogreader" xml:lang="en-us">
+<title>SYSCS_DIAG.ERROR_LOG_READER diagnostic table function</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.ERROR_LOG_READER</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.ERROR_LOG_READER diagnostic table function</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.ERROR_LOG_READER diagnostic table function contains all the
+useful SQL statements that are in the <filepath>derby.log</filepath> file or a
+log file that you specify.</p>
+<p>One use of this diagnostic table function is to determine the active
+transactions and the SQL statements in those transactions at a given point in
+time. For example, if a deadlock or lock timeout occurred, you can find the
+timestamp (timestampConstant) in the error log.</p>
+<p>For a database for which authentication and SQL authorization are both
+enabled, only the
+<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
+access this diagnostic table function.</p>
+<p>To access the SYSCS_DIAG.ERROR_LOG_READER diagnostic table function, you must
+use the SQL table function syntax.</p>
+<p>For example:<codeblock>SELECT * 
+    FROM TABLE (SYSCS_DIAG.ERROR_LOG_READER()) 
+    AS T1</codeblock>
+where T1 is a user-specified table name that is any valid identifier.</p>
+<p>You can specify a log file name as an optional argument to the
+SYSCS_DIAG.ERROR_LOG_READER diagnostic table function. When you specify a log
+file name, the file name must be an expression whose data type maps to a Java
+string.</p>
+<p>For example:<codeblock>SELECT * 
+    FROM TABLE (SYSCS_DIAG.ERROR_LOG_READER('myderbyerrors.log')) 
+    AS T1</codeblock></p>
+<p><note type="tip"> By default,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> log files contain only
+boot, shutdown, and error messages. See the
+<codeph><xref href="rrefproper26985.dita#rrefproper26985">derby.stream.error.logSeverityLevel</xref></codeph>
+property and the
+<codeph><xref href="rrefproper43517.dita#rrefproper43517">derby.language.logStatementText</xref></codeph>
+property for instructions on how to print more information to
+<ph conref="../conrefs.dita#prod/productshortname"></ph> log files. You can then
+query that information by using the SYSCS_DIAG.ERROR_LOG_READER diagnostic table
+function.</note></p>
+<p>The returned table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns returned by the SYSCS_DIAG.ERROR_LOG_READER table function</title>
+<desc>For the columns returned by the SYSCS_DIAG.ERROR_LOG_READER table function, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">TS</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">26</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The timestamp of the statement.</entry>
+</row>
+<row>
+<entry colname="1">THREADID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">40</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The thread name.</entry>
+</row>
+<row>
+<entry colname="1">XID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">15</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The transaction ID.</entry>
+</row>
+<row>
+<entry colname="1">LCCID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">15</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The connection ID.</entry>
+</row>
+<row>
+<entry colname="1">DATABASE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The database name.</entry>
+</row>
+<row>
+<entry colname="1">DRDAID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">50</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The DRDA ID for network server session.</entry>
+</row>
+<row>
+<entry colname="1">LOGTEXT</entry>
+<entry colname="2">LONG VARCHAR</entry>
+<entry colname="3">32,700</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The text of the statement or commit or rollback.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagerrormessages" xml:lang="en-us">
+<title>SYSCS_DIAG.ERROR_MESSAGES diagnostic table</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.ERROR_MESSAGES</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.ERROR_MESSAGES diagnostic table</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.ERROR_MESSAGES diagnostic table shows all of the SQLStates,
+locale-sensitive error messages, and exception severities for a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database. You can
+reference the SYSCS_DIAG.ERROR_MESSAGES diagnostic table directly in a
+statement.</p>
+<p>For example:
+<codeblock>SELECT * FROM SYSCS_DIAG.ERROR_MESSAGES</codeblock></p>
+<p>All users can access this diagnostic table, whether or not the database has
+authentication and SQL authorization enabled.</p>
+<p>The table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns in the SYSCS_DIAG.ERROR_LOG_READER table</title>
+<desc>For the columns in the SYSCS_DIAG.ERROR_LOG_READER table, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">SQL_STATE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">5</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The <i>SQLState</i> of the <i>SQLException</i> (that is, the
+value returned by <i>SQLException.getSQLState()</i>).</entry>
+</row>
+<row>
+<entry colname="1">MESSAGE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">32672</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The error message (that is, the value returned by
+<i>SQLException.getMessage()</i>).</entry>
+</row>
+<row>
+<entry colname="1">SEVERITY</entry>
+<entry colname="2">INTEGER</entry>
+<entry colname="3">10</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The <ph conref="../conrefs.dita#prod/productshortname"></ph>
+code for the severity (that is, the value returned by
+<i>SQLException.getErrorCode()</i>).</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,154 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiaglocktable" xml:lang="en-us">
+<title>SYSCS_DIAG.LOCK_TABLE diagnostic table</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.LOCK_TABLE</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.LOCK_TABLE diagnostic table</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.LOCK_TABLE diagnostic table shows all of the locks that are
+currently held in the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+database. You can reference the SYSCS_DIAG.LOCK_TABLE diagnostic table directly
+in a statement.</p>
+<p>For example:<codeblock>SELECT * FROM SYSCS_DIAG.LOCK_TABLE</codeblock></p>
+<p>All users can access this diagnostic table, whether or not the database has
+authentication and SQL authorization enabled.</p>
+<p>When the SYSCS_DIAG.LOCK_TABLE diagnostic table is referenced in a statement,
+a snapshot of the lock table is taken.  A snapshot is used so that referencing
+the diagnostic table does not alter the normal timing and flow of the
+application. It is possible that some locks will be in a transition state when
+the snapshot is taken.</p>
+<p>The table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns in the SYSCS_DIAG.LOCK_TABLE table</title>
+<desc>For each column in the SYSCS_DIAG.LOCK_TABLE table, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc><tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">XID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">15</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The transaction ID, which can be joined with the XID of the
+transaction table. See
+<xref href="rrefsyscsdiagtransactiontable.dita#rrefsyscsdiagtransactiontable"></xref>.</entry>
+</row>
+<row>
+<entry colname="1">TYPE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">5</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The type of lock, which can be either 'ROW', 'TABLE', or
+'LATCH'.</entry>
+</row>
+<row>
+<entry colname="1">MODE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">4</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The mode of the lock. For a lock of type 'TABLE', the valid
+values are:
+<lines><i>'S'</i> for shared lock
+<i>'U'</i> for update lock
+<i>'X'</i> for exclusive lock
+<i>'IS'</i> for intent shared lock
+<i>'IX'</i> for intent exclusive lock
+</lines>For a lock of type 'ROW', the valid
+values are:
+<lines><i>'S'</i> for shared lock
+<i>'U'</i> for update lock
+<i>'X'</i> for exclusive lock
+</lines>For a lock of type 'LATCH', the only valid value is:
+<lines><i>'X'</i> for exclusive lock
+</lines>
+</entry>
+</row>
+<row>
+<entry colname="1">TABLENAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The name of the base table that the lock is for.</entry>
+</row>
+<row>
+<entry colname="1">LOCKNAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">20</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The name of the lock.</entry>
+</row>
+<row>
+<entry colname="1">STATE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">5</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The state of the lock, which is either 'GRANT' or
+'WAIT'.</entry>
+</row>
+<row>
+<entry colname="1">TABLETYPE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">9</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The type of the table. Valid values are:
+<lines><i>'T'</i> for user table
+<i>'S'</i> for system table
+</lines>
+</entry>
+</row>
+<row>
+<entry colname="1">LOCKCOUNT</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">5</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The internal lock count.</entry>
+</row>
+<row>
+<entry colname="1">INDEXNAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">true</entry>
+<entry colname="5">Value is normally null. If it is non-null, a lock is held on
+the index.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagspacetable" xml:lang="en-us">
+<title>SYSCS_DIAG.SPACE_TABLE diagnostic table function</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.SPACE_TABLE</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.SPACE_TABLE diagnostic table function</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.SPACE_TABLE diagnostic table function shows the space usage of
+a particular table and its indexes. You can use this diagnostic table function
+to determine if space might be saved by compressing the table and indexes.</p>
+<p>All users can access this diagnostic table function, whether or not the
+database has authentication and SQL authorization enabled.</p>
+<p>To access the SYSCS_DIAG.SPACE_TABLE diagnostic table function, you must use
+the SQL table function syntax. You can invoke the table function in the
+following ways:
+<ul>
+<li>If invoked with no arguments, the table function retrieves space information
+for all tables and indexes in the database.</li>
+<li>If invoked with one argument, a <parmname>tableName</parmname>, the table
+function retrieves information for the specified table in the current
+schema.</li>
+<li>If invoked with two arguments, a <parmname>schemaName</parmname> followed by
+a <parmname>tableName</parmname>, the table function retrieves information for
+the specified schema and table.</li>
+</ul></p>
+<p>The returned table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns returned by the SYSCS_DIAG.SPACE_TABLE table function</title>
+<desc>For each column returned by the SYSCS_DIAG.SPACE_TABLE table function, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc><tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">CONGLOMERATENAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The name of the conglomerate, which is either the table name or the index name. (Unlike the SYSCONGLOMERATES column of the same name, table ID's do not appear here).</entry>
+</row>
+<row>
+<entry colname="1">ISINDEX</entry>
+<entry colname="2">SMALLINT</entry>
+<entry colname="3">5</entry>
+<entry colname="4">false</entry>
+<entry colname="5">Is not zero if the conglomerate is an index, 0 otherwise.</entry>
+</row>
+<row>
+<entry colname="1">NUMALLOCATEDPAGES</entry>
+<entry colname="2">BIGINT</entry>
+<entry colname="3">20</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The number of pages actively linked into the table. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
+</row>
+<row>
+<entry colname="1">NUMFREEPAGES</entry>
+<entry colname="2">BIGINT</entry>
+<entry colname="3">20</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The number of free pages that belong to the table. When a new page is to be linked into the table the system will move a page from the NUMFREEPAGES list to the NUMALLOCATEDPAGES list. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
+</row>
+<row>
+<entry colname="1">NUMUNFILLEDPAGES</entry>
+<entry colname="2">BIGINT</entry>
+<entry colname="3">20</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The number of unfilled pages that belong to the table. Unfilled pages are allocated pages that are not completely full. Note that the number of unfilled pages is an estimate and is not exact. Running the same query twice can give different results on this column.</entry>
+</row>
+<row>
+<entry colname="1">PAGESIZE</entry>
+<entry colname="2">INTEGER</entry>
+<entry colname="3">10</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The size of the page in bytes for that conglomerate.</entry>
+</row>
+<row>
+<entry colname="1">ESTIMSPACESAVING</entry>
+<entry colname="2">BIGINT</entry>
+<entry colname="3">20</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The estimated space which could possibly be saved by compressing the conglomerate, in bytes.</entry>
+</row>
+<row>
+<entry colname="1">TABLEID</entry>
+<entry colname="2">CHAR</entry>
+<entry colname="3">36</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The id of the table to which the conglomerate belongs. </entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<p>For example, use the following query to return the space usage for all of the
+user tables and indexes in the database:
+<codeblock>SELECT T2.*
+    FROM
+        SYS.SYSTABLES systabs,
+        TABLE (SYSCS_DIAG.SPACE_TABLE()) AS T2
+    WHERE systabs.tabletype = 'T'
+    AND systabs.tableid = T2.tableid;</codeblock>
+where T2 is a user-specified
+table name that is any valid identifier. </p><p>Both the <parmname>schemaName</parmname> and
+the <parmname>tableName</parmname> arguments must be expressions whose data
+types map to Java strings. If the <parmname>schemaName</parmname> and the <parmname>tableName</parmname> are
+non-delimited identifiers, you must specify the names in upper case.</p><p>For
+example: <codeblock>SELECT * 
+    FROM TABLE (SYSCS_DIAG.SPACE_TABLE('MYSCHEMA', 'MYTABLE')) 
+    AS T2</codeblock></p>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagstatementcache" xml:lang="en-us">
+<title>SYSCS_DIAG.STATEMENT_CACHE diagnostic table</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.STATEMENT_CACHE</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.STATEMENT_CACHE diagnostic table</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.STATEMENT_CACHE diagnostic table shows the contents of the SQL
+statement cache. You can reference the SYSCS_DIAG.STATEMENT_CACHE diagnostic
+table directly in a statement.</p>
+<p>For example:<codeblock>SELECT * FROM SYSCS_DIAG.STATEMENT_CACHE</codeblock></p>
+<p>For a database for which authentication and SQL authorization are both
+enabled, only the
+<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
+access this diagnostic table.</p>
+<p>The table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns in the SYSCS_DIAG.STATEMENT_CACHE table</title>
+<desc>For the columns in the SYSCS_DIAG.STATEMENT_CACHE table, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">ID</entry>
+<entry colname="2">CHAR</entry>
+<entry colname="3">36</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The internal identifier of the compiled statement.</entry>
+</row>
+<row>
+<entry colname="1">SCHEMANAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The schema the statement was compiled in.</entry>
+</row>
+<row>
+<entry colname="1">SQL_TEXT</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">32,672</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The text of the statement.</entry>
+</row>
+<row>
+<entry colname="1">UNICODE</entry>
+<entry colname="2">BOOLEAN</entry>
+<entry colname="3">1</entry>
+<entry colname="4">false</entry>
+<entry colname="5"><i>true</i> (the statement is compiled as a pure unicode
+string)
+<p><i>false</i> (the statement handled unicode escapes)</p></entry>
+</row>
+<row>
+<entry colname="1">VALID</entry>
+<entry colname="2">BOOLEAN</entry>
+<entry colname="3">1</entry>
+<entry colname="4">false</entry>
+<entry colname="5"><i>true</i> (the statement is currently valid)
+<p><i>false</i> (the statement is not currently valid)</p></entry>
+</row>
+<row>
+<entry colname="1">COMPILED_AT</entry>
+<entry colname="2">TIMESTAMP</entry>
+<entry colname="3">29</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The time the statement was compiled. Requires statistics
+timing to be enabled (see
+<xref href="rrefsetstatstimingproc.dita#rrefsetstatstimingproc"></xref>).</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagstatementduration" xml:lang="en-us">
+<title>SYSCS_DIAG.STATEMENT_DURATION diagnostic table function</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.STATEMENT_DURATION</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.STATEMENT_DURATION diagnostic table functions</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>You can use the SYSCS_DIAG.STATEMENT_DURATION diagnostic table function to
+analyze the <term>execution duration</term> of the useful SQL statements in the
+<filepath>derby.log</filepath> file or a log file that you specify.</p>
+<p>You can also use this diagnostic table function to get an indication of where
+the bottlenecks are in the JDBC code for an application.</p>
+<p>For a database for which authentication and SQL authorization are both
+enabled, only the
+<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
+access this diagnostic table function.</p>
+<p>To access the SYSCS_DIAG.STATEMENT_DURATION diagnostic
+table function, you must use the SQL table function syntax.</p>
+<p>For example:<codeblock>SELECT * 
+    FROM TABLE (SYSCS_DIAG.STATEMENT_DURATION()) 
+    AS T1</codeblock>
+where T1 is a user-specified table name that is any valid
+identifier.</p>
+<note type="restriction">For each transaction ID, a row is not returned for the
+last statement with that transaction ID. Transaction IDs change within a
+connection after a commit or rollback, if the transaction that just ended
+modified data.</note>
+<p>You can specify a log file name as an optional argument to the
+SYSCS_DIAG.STATEMENT_DURATION diagnostic table function. When you specify a log
+file name, the file name must be an expression whose data type maps to a Java
+string.</p>
+<p>For example:<codeblock>SELECT * 
+    FROM TABLE (SYSCS_DIAG.STATEMENT_DURATION('somederby.log')) 
+    AS T1</codeblock></p>
+<p><note type="tip"> By default
+<ph conref="../conrefs.dita#prod/productshortname"></ph> log files contain only
+boot, shutdown, and error messages. See the
+<codeph><xref href="rrefproper26985.dita#rrefproper26985">derby.stream.error.logSeverityLevel</xref></codeph>
+property and the
+<codeph><xref href="rrefproper43517.dita#rrefproper43517">derby.language.logStatementText</xref></codeph>
+property for instructions on how to print more information to
+<ph conref="../conrefs.dita#prod/productshortname"></ph> log files. You can then
+query that information by using the SYSCS_DIAG.STATEMENT_DURATION diagnostic
+table function.</note></p>
+<p>The returned table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns returned by the SYSCS_DIAG.STATEMENT_DURATION table function</title>
+<desc>For the columns returned by the SYSCS_DIAG.STATEMENT_DURATION table function, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">TS</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">26</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The timestamp of the statement.</entry>
+</row>
+<row>
+<entry colname="1">THREADID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">80</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The thread name.</entry>
+</row>
+<row>
+<entry colname="1">XID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">15</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The transaction ID.</entry>
+</row>
+<row>
+<entry colname="1">LOGTEXT</entry>
+<entry colname="2">LONG VARCHAR</entry>
+<entry colname="3">32,700</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The text of the statement or commit or rollback.</entry>
+</row>
+<row>
+<entry colname="1">DURATION</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">10</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The duration, in milliseconds, of the statement.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita?rev=1443747&r1=1443746&r2=1443747&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita Thu Feb  7 21:54:05 2013
@@ -18,45 +18,38 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<reference id="rrefsyscsdialgtables" xml:lang="en-us">
+<reference id="rrefsyscsdiagtables" xml:lang="en-us">
 <title>SYSCS_DIAG diagnostic tables and functions</title>
 <shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
 a set of system table expressions which you can use to obtain diagnostic information
 about the state of the database and about the database sessions. </shortdesc>
 <prolog><metadata>
-<keywords><indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.ERROR_LOG_READER</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.ERROR_LOG_READER diagnostic table function</indexterm>
-<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.ERROR_MESSAGES</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.ERROR_MESSAGES diagnostic table</indexterm><indexterm>diagnostic
-table functions<indexterm>SYSCS_DIAG.LOCK_TABLE</indexterm></indexterm><indexterm>SYSCS_DIAG.LOCK_TABLE
-diagnostic table</indexterm><indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.SPACE_TABLE</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.SPACE_TABLE diagnostic table function</indexterm><indexterm>diagnostic
-tables<indexterm>SYSCS_DIAG.STATEMENT_CACHE</indexterm></indexterm><indexterm>SYSCS_DIAG.STATEMENT_CACHE
-diagnostic table</indexterm><indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.STATEMENT_DURATION</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.STATEMENT_DURATION diagnostic table functions</indexterm>
-<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.TRANSACTION_TABLE</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.TRANSACTION_TABLE diagnostic table</indexterm>
-<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.TRANSACTION_TABLE</indexterm></indexterm>
-<indexterm>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</indexterm>
-<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.CONTAINED_ROLES</indexterm></indexterm>
+<keywords>
+<indexterm>diagnostic tables and table functions</indexterm>
+<indexterm>SYSCS_DIAG tables and functions</indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<section> <p>There are two types of diagnostic table expressions in <ph conref="../conrefs.dita#prod/productshortname"></ph>:<dl>
+<section>
+<p>There are two types of diagnostic table expressions in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>:
+<dl>
 <dlentry>
 <dt>Diagnostic tables</dt>
-<dd>Tables that are like any other table in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-You can specify the diagnostic table name anywhere a normal table name is
-allowed.</dd>
+<dd>Tables that are like any other table in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. You can specify the
+diagnostic table name anywhere a normal table name is allowed.</dd>
 </dlentry><dlentry>
 <dt>Diagnostic table functions</dt>
-<dd>Functions that are like any other function in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-Diagnostic table functions can accept zero or more arguments, depending on
-the table function that you use. You must use the SQL-defined table function
-syntax to access these functions.</dd>
-</dlentry></dl> </p><p>The following table shows the types and names of the
-diagnostic table expressions in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<dd>Functions that are like any other function in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. Diagnostic table
+functions can accept zero or more arguments, depending on the table function
+that you use. You must use the SQL-defined table function syntax to access these
+functions.</dd>
+</dlentry></dl>
+</p>
+<p>The following table shows the types and names of the diagnostic table
+expressions in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
 <table>
 <title>System diagnostic table expressions provided by
 <ph conref="../conrefs.dita#prod/productshortname"></ph></title>
@@ -100,247 +93,15 @@ diagnostic table expressions in
 <entry colname="col2">Table function</entry>
 </row>
 <row>
-<entry colname="col1">SYSCS_DIAG.TRANSACTION_TABLE </entry>
+<entry colname="col1">SYSCS_DIAG.TRANSACTION_TABLE</entry>
 <entry colname="col2">Table</entry>
 </row>
 </tbody>
 </tgroup>
-</table><note type="restriction">If you reference a diagnostic table in
-a DDL statement or a compression procedure, <ph conref="../conrefs.dita#prod/productshortname"></ph> returns
-an exception.</note></section>
-<section><title>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</title>
-<p>The SYSCS_DIAG.CONTAINED_ROLES diagnostic table function returns all the
-    roles contained within the specified role. 
-    The argument that is passed to this table function should be the name
-    of the role, specified as a string in quotes, or the special keyword
-    CURRENT_ROLE, which indicates the current role in effect.
-    For a definition of role containment,
-see "Syntax for roles" in
-<xref href="rrefsqljgrant.dita#rrefsqljgrant/grantrolesyn">GRANT
-statement</xref>.</p>
-<p>For example:</p>
-<codeblock>SELECT * FROM TABLE (SYSCS_DIAG.CONTAINED_ROLES('READER')) AS T1
-SELECT * FROM TABLE (SYSCS_DIAG.CONTAINED_ROLES(CURRENT_ROLE)) AS T2
-</codeblock>
-<p>All users can access this diagnostic table function, whether or not the
-database has authentication and SQL authorization enabled.</p>
-</section>
-<section><title>SYSCS_DIAG.ERROR_LOG_READER diagnostic table function</title><p>The
-SYSCS_DIAG.ERROR_LOG_READER diagnostic table function contains all the useful
-SQL statements that are in the <filepath>derby.log</filepath> file or a log
-file that you specify. </p><p>One use of this diagnostic table function is
-to determine the active transactions and the SQL statements in those transactions
-at a given point in time. For example, if a deadlock or lock timeout occurred
-you can find the timestamp (timestampConstant) in the error log.</p>
-<p>For a database for which authentication and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
-access this diagnostic table function.</p>
-<p>To access the SYSCS_DIAG.ERROR_LOG_READER diagnostic table function, you must
-use the SQL table function syntax.</p><p>For example:<codeblock>SELECT * 
-    FROM TABLE (SYSCS_DIAG.ERROR_LOG_READER()) 
-    AS T1</codeblock>where T1 is a user-specified table name that is any valid
-identifier.</p><p>You can specify a log file name as an optional argument
-to the SYSCS_DIAG.ERROR_LOG_READER diagnostic table function. When you specify
-a log file name, the file name must be an expression whose data type maps
-to a Java string.</p><p>For example:<codeblock>SELECT * 
-    FROM TABLE (SYSCS_DIAG.ERROR_LOG_READER('myderbyerrors.log')) 
-    AS T1</codeblock></p><p><note type="tip"> By default <ph conref="../conrefs.dita#prod/productshortname"></ph> log
-files contain only boot, shutdown, and error messages.
-See the
-<codeph><xref href="rrefproper26985.dita#rrefproper26985">derby.stream.error.logSeverityLevel</xref></codeph>
-property and the
-<codeph><xref href="rrefproper43517.dita#rrefproper43517">derby.language.logStatementText</xref></codeph>
-property for
-instructions on how to print more information to <ph conref="../conrefs.dita#prod/productshortname"></ph> log
-files. You can then query that information by using the SYSCS_DIAG.ERROR_LOG_READER
-diagnostic table function. </note></p></section>
-<section><title>SYSCS_DIAG.ERROR_MESSAGES diagnostic table</title><p>The SYSCS_DIAG.ERROR_MESSAGES
-diagnostic table shows all of the SQLStates, locale-sensitive error messages,
-and exception severities for a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.
-You can reference the SYSCS_DIAG.ERROR_MESSAGES diagnostic table directly
-in a statement.</p><p>For example:<codeblock>SELECT * FROM SYSCS_DIAG.ERROR_MESSAGES</codeblock></p>
-<p>All users can access this diagnostic table, whether or not the database has
-authentication and SQL authorization enabled.</p>
-</section>
-<section><title>SYSCS_DIAG.LOCK_TABLE diagnostic table</title><p>The SYSCS_DIAG.LOCK_TABLE
-diagnostic table shows all of the locks that are currently held in the <ph
-conref="../conrefs.dita#prod/productshortname"></ph> database.  You can reference
-the SYSCS_DIAG.LOCK_TABLE diagnostic table directly in a statement.</p><p>For
-example:<codeblock>SELECT * FROM SYSCS_DIAG.LOCK_TABLE</codeblock></p>
-<p>All users can access this diagnostic table, whether or not the database has
-authentication and SQL authorization enabled.</p><p>When
-the SYSCS_DIAG.LOCK_TABLE diagnostic table is referenced in a statement, a
-snapshot of the lock table is taken.  A snapshot is used so that referencing
-the diagnostic table does not alter the normal timing and flow of the application.
-It is possible that some locks will be in a transition state when the 
-snapshot is taken. </p></section>
-<section><title>SYSCS_DIAG.SPACE_TABLE diagnostic table function</title><p>The
-SYSCS_DIAG.SPACE_TABLE diagnostic table function shows the space usage of
-a particular table and its indexes. You can use this diagnostic table function
-to determine if space might be saved by compressing the table and indexes.</p>
-<p>All users can access this diagnostic table function, whether or not the
-database has authentication and SQL authorization enabled.</p>
-<p>To access the SYSCS_DIAG.SPACE_TABLE diagnostic table function, you must use
-the SQL table function syntax. You can invoke the table function in the
-following ways:
-<ul>
-<li>If invoked with no arguments, the table function retrieves
-space information for all tables and indexes in the database.</li>
-<li>If invoked with one argument, a <parmname>tableName</parmname>, the table
-function retrieves information for the specified table in the current
-schema.</li>
-<li>If invoked with two arguments, a <parmname>schemaName</parmname> followed by
-a <parmname>tableName</parmname>, the table function retrieves information for
-the specified schema and table.</li>
-</ul></p>
-<p>The returned table has the columns shown in the following table.</p>
-<table frame="all">
-<title>Columns returned by the SYSCS_DIAG.SPACE_TABLE function</title>
-<desc>For each column returned by the SYSCS_DIAG.SPACE_TABLE function, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc><tgroup cols="5" colsep="1" rowsep="1">
-<colspec colname="1" colnum="1" colwidth="31*"/>
-<colspec colname="2" colnum="2" colwidth="17*"/>
-<colspec colname="3" colnum="3" colwidth="11*"/>
-<colspec colname="4" colnum="4" colwidth="12*"/>
-<colspec colname="5" colnum="5" colwidth="29*"/>
-<thead>
-<row valign="bottom">
-<entry colname="1">Column Name</entry>
-<entry colname="2">Type</entry>
-<entry colname="3">Length</entry>
-<entry colname="4">Nullable</entry>
-<entry colname="5">Contents</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry colname="1">CONGLOMERATENAME</entry>
-<entry colname="2">VARCHAR</entry>
-<entry colname="3">128</entry>
-<entry colname="4">true</entry>
-<entry colname="5">The name of the conglomerate, which is either the table name or the index name. (Unlike the SYSCONGLOMERATES column of the same name, table ID's do not appear here).</entry>
-</row>
-<row>
-<entry colname="1">ISINDEX</entry>
-<entry colname="2">SMALLINT</entry>
-<entry colname="3">5</entry>
-<entry colname="4">false</entry>
-<entry colname="5">Is not zero if the conglomerate is an index, 0 otherwise.</entry>
-</row>
-<row>
-<entry colname="1">NUMALLOCATEDPAGES</entry>
-<entry colname="2">BIGINT</entry>
-<entry colname="3">20</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The number of pages actively linked into the table. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
-</row>
-<row>
-<entry colname="1">NUMFREEPAGES</entry>
-<entry colname="2">BIGINT</entry>
-<entry colname="3">20</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The number of free pages that belong to the table. When a new page is to be linked into the table the system will move a page from the NUMFREEPAGES list to the NUMALLOCATEDPAGES list. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
-</row>
-<row>
-<entry colname="1">NUMUNFILLEDPAGES</entry>
-<entry colname="2">BIGINT</entry>
-<entry colname="3">20</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The number of unfilled pages that belong to the table. Unfilled pages are allocated pages that are not completely full. Note that the number of unfilled pages is an estimate and is not exact. Running the same query twice can give different results on this column.</entry>
-</row>
-<row>
-<entry colname="1">PAGESIZE</entry>
-<entry colname="2">INTEGER</entry>
-<entry colname="3">10</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The size of the page in bytes for that conglomerate.</entry>
-</row>
-<row>
-<entry colname="1">ESTIMSPACESAVING</entry>
-<entry colname="2">BIGINT</entry>
-<entry colname="3">20</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The estimated space which could possibly be saved by compressing the conglomerate, in bytes.</entry>
-</row>
-<row>
-<entry colname="1">TABLEID</entry>
-<entry colname="2">CHAR</entry>
-<entry colname="3">36</entry>
-<entry colname="4">false</entry>
-<entry colname="5">The id of the table to which the conglomerate belongs. </entry>
-</row>
-</tbody>
-</tgroup>
 </table>
-<p>For example, use the following query to return the space usage for all of the
-user tables and indexes in the database:
-<codeblock>SELECT T2.*
-    FROM
-        SYS.SYSTABLES systabs,
-        TABLE (SYSCS_DIAG.SPACE_TABLE()) AS T2
-    WHERE systabs.tabletype = 'T'
-    AND systabs.tableid = T2.tableid;</codeblock>
-where T2 is a user-specified
-table name that is any valid identifier. </p><p>Both the <parmname>schemaName</parmname> and
-the <parmname>tableName</parmname> arguments must be expressions whose data
-types map to Java strings. If the <parmname>schemaName</parmname> and the <parmname>tableName</parmname> are
-non-delimited identifiers, you must specify the names in upper case.</p><p>For
-example: <codeblock>SELECT * 
-    FROM TABLE (SYSCS_DIAG.SPACE_TABLE('MYSCHEMA', 'MYTABLE')) 
-    AS T2</codeblock></p></section>
-<section><title>SYSCS_DIAG.STATEMENT_CACHE diagnostic table</title><p>The
-SYSCS_DIAG.STATEMENT_CACHE diagnostic table shows the contents of the SQL
-statement cache. You can reference the SYSCS_DIAG.STATEMENT_CACHE diagnostic
-table directly in a statement.</p><p>For example:<codeblock>SELECT * FROM SYSCS_DIAG.STATEMENT_CACHE</codeblock></p>
-<p>For a database for which authentication and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
-access this diagnostic table.</p></section>
-<section><title>SYSCS_DIAG.STATEMENT_DURATION diagnostic table function</title><p>You
-can use the SYSCS_DIAG.STATEMENT_DURATION diagnostic table function to analyze
-the <term>execution duration</term> of the useful SQL statements in the <filepath>derby.log</filepath> file
-or a log file that you specify. </p><p>You can also use this diagnostic table
-function to get an indication of where the bottlenecks are in the JDBC code
-for an application.</p>
-<p>For a database for which authentication and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
-access this diagnostic table function.</p>
-<p>To access the SYSCS_DIAG.STATEMENT_DURATION diagnostic
-table function, you must use the SQL table function syntax.</p><p>For example:<codeblock>SELECT * 
-    FROM TABLE (SYSCS_DIAG.STATEMENT_DURATION()) 
-    AS T1</codeblock>where T1 is a user-specified table name that is any valid
-identifier.</p><note type="restriction">For each transaction ID, a row is
-not returned for the last statement with that transaction id. Transaction
-IDs change within a connection after a commit or rollback, if the transaction
-that just ended modified data.</note><p>You can specify a log file name as
-an optional argument to the SYSCS_DIAG.STATEMENT_DURATION diagnostic table
-function. When you specify a log file name, the file name must be an expression
-whose data type maps to a Java string.</p><p>For example:<codeblock>SELECT * 
-    FROM TABLE (SYSCS_DIAG.STATEMENT_DURATION('somederby.log')) 
-    AS T1</codeblock></p><p><note type="tip"> By default <ph conref="../conrefs.dita#prod/productshortname"></ph> log
-files contain only boot, shutdown, and error messages.
-See the
-<codeph><xref href="rrefproper26985.dita#rrefproper26985">derby.stream.error.logSeverityLevel</xref></codeph>
-property and the
-<codeph><xref href="rrefproper43517.dita#rrefproper43517">derby.language.logStatementText</xref></codeph>
-property for
-instructions on how to print more information to <ph conref="../conrefs.dita#prod/productshortname"></ph> log
-files. You can then query that information by using the SYSCS_DIAG.STATEMENT_DURATION
-diagnostic table function. </note></p></section>
-<section><title>SYSCS_DIAG.TRANSACTION_TABLE  diagnostic table</title><p>The
-SYSCS_DIAG.TRANSACTION_TABLE  diagnostic table shows all of the transactions
-that are currently in the database. You can reference the SYSCS_DIAG.TRANSACTION_TABLE
- diagnostic table directly in a statement.</p><p>For example:<codeblock>SELECT * FROM SYSCS_DIAG.TRANSACTION_TABLE</codeblock></p><p>When
-the SYSCS_DIAG.TRANSACTION_TABLE  diagnostic table is referenced in a statement,
-a snapshot of the transaction table is taken.  A snapshot is used so that
-referencing the diagnostic table does not alter the normal timing and flow
-of the application.  It is possible that some transactions will be in a transition
-state when the snapshot is taken. </p>
-<p>For a database for which authentication and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
-access this diagnostic table.</p>
-</section>
+<note type="restriction">If you reference a diagnostic table in a DDL statement
+or a compression procedure,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> returns an
+exception.</note></section>
 </refbody>
 </reference>

Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita?rev=1443747&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita Thu Feb  7 21:54:05 2013
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefsyscsdiagtransactiontable" xml:lang="en-us">
+<title>SYSCS_DIAG.TRANSACTION_TABLE diagnostic table</title>
+<prolog><metadata>
+<keywords>
+<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.TRANSACTION_TABLE</indexterm></indexterm>
+<indexterm>SYSCS_DIAG.TRANSACTION_TABLE diagnostic table</indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>The SYSCS_DIAG.TRANSACTION_TABLE diagnostic table shows all of the
+transactions that are currently in the database. You can reference the
+SYSCS_DIAG.TRANSACTION_TABLE diagnostic table directly in a statement.</p>
+<p>For example:
+<codeblock>SELECT * FROM SYSCS_DIAG.TRANSACTION_TABLE</codeblock></p>
+<p>When the SYSCS_DIAG.TRANSACTION_TABLE diagnostic table is referenced in a
+statement, a snapshot of the transaction table is taken.  A snapshot is used so
+that referencing the diagnostic table does not alter the normal timing and flow
+of the application. It is possible that some transactions will be in a
+transition state when the snapshot is taken.</p>
+<p>For a database for which authentication and SQL authorization are both
+enabled, only the
+<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> can
+access this diagnostic table.</p>
+<p>The table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns in the SYSCS_DIAG.STATEMENT_CACHE table</title>
+<desc>For the columns in the SYSCS_DIAG.STATEMENT_CACHE table, this table provides its data type, its length in bytes, whether it is nullable, and a description of its contents.</desc>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">XID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">15</entry>
+<entry colname="4">false</entry>
+<entry colname="5">The transaction id, which can be joined with the
+lock table virtual table's XID. See
+<xref href="rrefsyscsdiaglocktable.dita#rrefsyscsdiaglocktable"></xref>.</entry>
+</row>
+<row>
+<entry colname="1">GLOBAL_XID</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">140</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The global transaction ID, set only if this transaction is a
+participant in a distributed transaction.</entry>
+</row>
+<row>
+<entry colname="1">USERNAME</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">128</entry>
+<entry colname="4">true</entry>
+<entry colname="5">The user name (the default value is APP). May appear null if
+the transaction is started by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
+</row>
+<row>
+<entry colname="1">TYPE</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">30</entry>
+<entry colname="4">false</entry>
+<entry colname="5">Either 'UserTransaction' or an internal transaction spawned
+by <ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
+</row>
+<row>
+<entry colname="1">STATUS</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">8</entry>
+<entry colname="4">false</entry>
+<entry colname="5">Either 'IDLE' or 'ACTIVE'. A transaction is IDLE only when it
+is first created or right after it commits. Any transaction that holds or has
+held any resource in the database is ACTIVE. Accessing the TransactionTable
+virtual table without using the class alias will not activate the transaction.</entry>
+</row>
+<row>
+<entry colname="1">FIRST_INSTANT</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">20</entry>
+<entry colname="4">true</entry>
+<entry colname="5">If null, this is a read-only transaction. If not null, this
+is the first log record instant written by the transaction.</entry>
+</row>
+<row>
+<entry colname="1">SQL_TEXT</entry>
+<entry colname="2">VARCHAR</entry>
+<entry colname="3">32,672</entry>
+<entry colname="4">true</entry>
+<entry colname="5">If null, this transaction is currently not being executed in
+the database. If not null, this is the SQL statement currently being executed in
+the database.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message