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 sc...@apache.org on 2007/03/15 17:44:57 UTC
svn commit: r518684 - in /db/derby/docs/trunk/src/ref: refderby.ditamap
rrefsyscsdiagtables.dita
Author: scotsmatrix
Date: Thu Mar 15 09:44:56 2007
New Revision: 518684
URL: http://svn.apache.org/viewvc?view=rev&rev=518684
Log:
Derby1520: Added a new file to document the system diagnostic tables. Updated the ditamap file. Patch derby1520_3.diff was contributed by me.
Added:
db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita (with props)
Modified:
db/derby/docs/trunk/src/ref/refderby.ditamap
Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?view=diff&rev=518684&r1=518683&r2=518684
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Mar 15 09:44:56 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-
+
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN"
"map.dtd">
<!--
@@ -197,8 +197,10 @@
</topicref>
<topicref href="rrefsqlj29840.dita" navtitle="JOIN operations">
<topicref href="rrefsqlj35034.dita" navtitle="INNER JOIN operation"></topicref>
-<topicref href="rrefsqlj18922.dita" navtitle="LEFT OUTER JOIN operation"></topicref>
-<topicref href="rrefsqlj57522.dita" navtitle="RIGHT OUTER JOIN operation"></topicref>
+<topicref href="rrefsqlj18922.dita" navtitle="LEFT OUTER JOIN operation">
+</topicref>
+<topicref href="rrefsqlj57522.dita" navtitle="RIGHT OUTER JOIN operation">
+</topicref>
</topicref>
<topicref href="rrefqueries.dita" navtitle="SQL queries">
<topicref href="rrefsqlj21571.dita" navtitle="Query"></topicref>
@@ -224,15 +226,19 @@
<topicref href="rreffunccos.dita" navtitle="COS function"></topicref>
<topicref href="rrefsqlj38716.dita" navtitle="COUNT function"></topicref>
<topicref href="rrefsqlj66113.dita" navtitle="COUNT(*) function"></topicref>
-<topicref href="rrefsqljcurrentdate.dita" navtitle="CURRENT DATE function"></topicref>
+<topicref href="rrefsqljcurrentdate.dita" navtitle="CURRENT DATE function">
+</topicref>
<topicref href="rrefsqlj34177.dita" navtitle="CURRENT_DATE function"></topicref>
-<topicref href="rrefcurrentisolation.dita" navtitle="CURRENT ISOLATION function"></topicref>
-<topicref href="rrefsqljcurrentschema.dita" navtitle="CURRENT SCHEMA function"></topicref>
+<topicref href="rrefcurrentisolation.dita" navtitle="CURRENT ISOLATION function">
+</topicref>
+<topicref href="rrefsqljcurrentschema.dita" navtitle="CURRENT SCHEMA function">
+</topicref>
<topicref href="rrefsqlj1055824.dita" navtitle="CURRENT TIME function"></topicref>
<topicref href="rrefsqlj33772.dita" navtitle="CURRENT_TIME function"></topicref>
<topicref href="rrefsqljcurrenttimestamp.dita" navtitle="CURRENT TIMESTAMP function">
</topicref>
-<topicref href="rrefsqlj15866.dita" navtitle="CURRENT_TIMESTAMP function"></topicref>
+<topicref href="rrefsqlj15866.dita" navtitle="CURRENT_TIMESTAMP function">
+</topicref>
<topicref href="rrefsqlj42324.dita" navtitle="CURRENT_USER function"></topicref>
<topicref href="rrefdatefunc.dita" navtitle="DATE function"></topicref>
<topicref href="rrefdayfunc.dita" navtitle="DAY function"></topicref>
@@ -324,6 +330,8 @@
<topicref href="rrefsetstatstimingproc.dita" navtitle="SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING system procedure">
</topicref>
</topicref>
+<topicref href="rrefsyscsdiagtables.dita" navtitle="SYSCS_DIAG diagnostic tables and functions">
+</topicref>
<topicref href="crefsqlj31068.dita" navtitle="Data types">
<topicref href="crefsqlj21305.dita" navtitle="Built-In type overview"></topicref>
<topicref collection-type="family" href="crefsqlj41507.dita" navtitle="Numeric types">
@@ -340,7 +348,8 @@
<topicref href="rrefsqlj30435.dita" navtitle="BIGINT data type"></topicref>
<topicref href="rrefblob.dita" navtitle="BLOB data type"></topicref>
<topicref href="rrefsqlj13733.dita" navtitle="CHAR data type"></topicref>
-<topicref href="rrefsqlj57924.dita" navtitle="CHAR FOR BIT DATA data type"></topicref>
+<topicref href="rrefsqlj57924.dita" navtitle="CHAR FOR BIT DATA data type">
+</topicref>
<topicref href="rrefclob.dita" navtitle="CLOB data type"></topicref>
<topicref href="rrefsqlj18730.dita" navtitle="DATE data type"></topicref>
<topicref href="rrefsqlj15260.dita" navtitle="DECIMAL data type"></topicref>
@@ -358,7 +367,8 @@
<topicref href="rrefsqlj21908.dita" navtitle="TIME data type"></topicref>
<topicref href="rrefsqlj27620.dita" navtitle="TIMESTAMP data type"></topicref>
<topicref href="rrefsqlj41207.dita" navtitle="VARCHAR data type"></topicref>
-<topicref href="rrefsqlj32714.dita" navtitle="VARCHAR FOR BIT DATA data type"></topicref>
+<topicref href="rrefsqlj32714.dita" navtitle="VARCHAR FOR BIT DATA data type">
+</topicref>
<topicref href="rrefsqljtypexml.dita" navtitle="XML data type"></topicref>
</topicref>
</topicref>
@@ -366,25 +376,38 @@
<topicref href="rrefsql9241891.dita" navtitle="Derby support for SQL-92 features ">
</topicref>
<topicref href="rrefsistabs38369.dita" navtitle="Derby system tables">
-<topicref href="rrefsistabs28114.dita" navtitle="SYSALIASES system table"></topicref>
-<topicref href="rrefsistabs26665.dita" navtitle="SYSCHECKS system table"></topicref>
-<topicref href="rrefsistabssyscolperms.dita" navtitle="SYSCOLPERMS system table"></topicref>
-<topicref href="rrefsistabs22441.dita" navtitle="SYSCOLUMNS system table"></topicref>
-<topicref href="rrefsistabs39391.dita" navtitle="SYSCONGLOMERATES system table"></topicref>
-<topicref href="rrefsistabs23241.dita" navtitle="SYSCONSTRAINTS system table"></topicref>
-<topicref href="rrefsistabs12813.dita" navtitle="SYSDEPENDS system table"></topicref>
+<topicref href="rrefsistabs28114.dita" navtitle="SYSALIASES system table">
+</topicref>
+<topicref href="rrefsistabs26665.dita" navtitle="SYSCHECKS system table">
+</topicref>
+<topicref href="rrefsistabssyscolperms.dita" navtitle="SYSCOLPERMS system table">
+</topicref>
+<topicref href="rrefsistabs22441.dita" navtitle="SYSCOLUMNS system table">
+</topicref>
+<topicref href="rrefsistabs39391.dita" navtitle="SYSCONGLOMERATES system table">
+</topicref>
+<topicref href="rrefsistabs23241.dita" navtitle="SYSCONSTRAINTS system table">
+</topicref>
+<topicref href="rrefsistabs12813.dita" navtitle="SYSDEPENDS system table">
+</topicref>
<topicref href="rrefsistabs40972.dita" navtitle="SYSFILES system table"></topicref>
-<topicref href="rrefsistabs13420.dita" navtitle="SYSFOREIGNKEYS system table"></topicref>
+<topicref href="rrefsistabs13420.dita" navtitle="SYSFOREIGNKEYS system table">
+</topicref>
<topicref href="rrefsistabs33921.dita" navtitle="SYSKEYS system table"></topicref>
<topicref href="rrefsistabssysroutineperms.dita" navtitle="SYSROUTINEPERMS system table">
</topicref>
-<topicref href="rrefsistabs12085.dita" navtitle="SYSSCHEMAS system table"></topicref>
+<topicref href="rrefsistabs12085.dita" navtitle="SYSSCHEMAS system table">
+</topicref>
<topicref href="rrefsistabslilanguageitemsysstatistics.dita" navtitle="SYSSTATISTICS system table">
</topicref>
-<topicref href="rrefsistabs33768.dita" navtitle="SYSSTATEMENTS system table"></topicref>
-<topicref href="rrefsistabssystableperms.dita" navtitle="SYSTABLEPERMS system table"></topicref>
-<topicref href="rrefsistabs24269.dita" navtitle="SYSTABLES system table"></topicref>
-<topicref href="rrefsistabs79888.dita" navtitle="SYSTRIGGERS system table"></topicref>
+<topicref href="rrefsistabs33768.dita" navtitle="SYSSTATEMENTS system table">
+</topicref>
+<topicref href="rrefsistabssystableperms.dita" navtitle="SYSTABLEPERMS system table">
+</topicref>
+<topicref href="rrefsistabs24269.dita" navtitle="SYSTABLES system table">
+</topicref>
+<topicref href="rrefsistabs79888.dita" navtitle="SYSTRIGGERS system table">
+</topicref>
<topicref href="rrefsistabs24045.dita" navtitle="SYSVIEWS system table"></topicref>
</topicref>
<topicref collection-type="family" href="rrefexcept16677.dita" navtitle="Derby exception messages and SQL states">
@@ -395,7 +418,8 @@
<topicref href="crefjdbc25142.dita" navtitle="Core JDBC java.sql classes, interfaces, and methods">
</topicref>
<topicref href="rrefjdbc32052.dita" navtitle="java.sql.Driver interface">
-<topicref href="rrefjdbc34954.dita" navtitle="java.sql.Driver.getPropertyInfo method"></topicref>
+<topicref href="rrefjdbc34954.dita" navtitle="java.sql.Driver.getPropertyInfo method">
+</topicref>
</topicref>
<topicref collection-type="family" href="rrefjdbc34565.dita" navtitle="java.sql.DriverManager.getConnection method">
<topicref href="rrefjdbc27433.dita" navtitle="Derby database connection
@@ -436,7 +460,8 @@
<topicref href="rrefjdbc75719.dita" navtitle="CallableStatements and INOUT Parameters ">
</topicref>
</topicref>
-<topicref href="rrefjdbc16643.dita" navtitle="java.sql.SQLException class"></topicref>
+<topicref href="rrefjdbc16643.dita" navtitle="java.sql.SQLException class">
+</topicref>
<topicref collection-type="family" href="rrefjdbc29874.dita" navtitle="java.sql.PreparedStatement interface">
<topicref href="rrefjavsqlprst.dita" navtitle="Prepared statements and streaming columns ">
</topicref>
@@ -447,24 +472,31 @@
</topicref>
<topicref href="rrefjdbc38274.dita" navtitle="java.sql.ResultSetMetaData interface">
</topicref>
-<topicref href="rrefjdbc30469.dita" navtitle="java.sql.SQLWarning class"></topicref>
-<topicref href="rrefjdbcrefsqlxml.dita" navtitle="java.sql.SQLXML interface"></topicref>
+<topicref href="rrefjdbc30469.dita" navtitle="java.sql.SQLWarning class">
+</topicref>
+<topicref href="rrefjdbcrefsqlxml.dita" navtitle="java.sql.SQLXML interface">
+</topicref>
<topicref href="rrefjdbc20377.dita" navtitle="Mapping of java.sql.Types to SQL types">
<topicref collection-type="family" href="rrefjdbc96386.dita" navtitle="Mapping of java.sql.Blob and java.sql.Clob interfaces">
-<topicref href="crefjavbclobnot.dita" navtitle="Notes on mapping of java.sql.Blob and java.sql.Clob interfaces"></topicref>
+<topicref href="crefjavbclobnot.dita" navtitle="Notes on mapping of java.sql.Blob and java.sql.Clob interfaces">
+</topicref>
</topicref>
</topicref>
<topicref collection-type="family" href="rrefjdbc2_0summary.dita" navtitle="JDBC 2.0 features">
<topicref href="rrefjdbc52637.dita" navtitle="java.sql.CallableStatement interface: supported JDBC 2.0 methods">
</topicref>
-<topicref href="rrefjdbc80004.dita" navtitle="java.sql.Connection interface: supported JDBC 2.0 methods"></topicref>
+<topicref href="rrefjdbc80004.dita" navtitle="java.sql.Connection interface: supported JDBC 2.0 methods">
+</topicref>
<topicref href="rrefjdbc66688.dita" navtitle="java.sql.DatabaseMetaData interface: supported JDBC 2.0 methods">
</topicref>
<topicref href="rrefjdbc99392.dita" navtitle="java.sql.PreparedStatement interface: supported JDBC 2.0 methods">
</topicref>
-<topicref href="rrefjdbc77156.dita" navtitle="java.sql.ResultSet interface: supported JDBC 2.0 methods"></topicref>
-<topicref href="rrefjdbc71949.dita" navtitle="java.sql.ResultSetMetaData interface: supported JDBC 2.0 methods"></topicref>
-<topicref href="rrefjdbc59162.dita" navtitle="java.sql.Statement interface: supported JDBC 2.0 methods"></topicref>
+<topicref href="rrefjdbc77156.dita" navtitle="java.sql.ResultSet interface: supported JDBC 2.0 methods">
+</topicref>
+<topicref href="rrefjdbc71949.dita" navtitle="java.sql.ResultSetMetaData interface: supported JDBC 2.0 methods">
+</topicref>
+<topicref href="rrefjdbc59162.dita" navtitle="java.sql.Statement interface: supported JDBC 2.0 methods">
+</topicref>
</topicref>
<topicref href="rrefjdbc87220.dita" navtitle="java.sql.BatchUpdateException class">
</topicref>
@@ -523,13 +555,17 @@
</topicref>
</topicref>
<topicref href="rrefattrib24612.dita" navtitle="Setting attributes for the database connection URL ">
-<topicref href="rrefattrib42100.dita" navtitle="bootPassword=key attribute"></topicref>
+<topicref href="rrefattrib42100.dita" navtitle="bootPassword=key attribute">
+</topicref>
<topicref href="rrefattrib26867.dita" navtitle="create=true attribute"></topicref>
-<topicref href="rrefcreatefrom.dita" navtitle="createFrom=path attribute"></topicref>
+<topicref href="rrefcreatefrom.dita" navtitle="createFrom=path attribute">
+</topicref>
<topicref href="rrefattrib17246.dita" navtitle="databaseName=nameofDatabase attribute">
</topicref>
-<topicref href="rrefattrib15290.dita" navtitle="dataEncryption=true attribute"></topicref>
-<topicref href="rrefattribencryptkey.dita" navtitle="encryptionKey=key attribute"></topicref>
+<topicref href="rrefattrib15290.dita" navtitle="dataEncryption=true attribute">
+</topicref>
+<topicref href="rrefattribencryptkey.dita" navtitle="encryptionKey=key attribute">
+</topicref>
<topicref href="rrefattrib88843.dita" navtitle="encryptionProvider=providerName attribute">
</topicref>
<topicref href="rrefattrib60346.dita" navtitle="encryptionAlgorithm=algorithm attribute">
@@ -540,14 +576,20 @@
</topicref>
<topicref href="rrefattribnewbootpw.dita" navtitle="newBootPassword=newPassword attribute">
</topicref>
-<topicref href="rrefattrib42686.dita" navtitle="password=userPassword attribute"></topicref>
-<topicref href="rrefrestorefrom.dita" navtitle="restoreFrom=path attribute"></topicref>
+<topicref href="rrefattrib42686.dita" navtitle="password=userPassword attribute">
+</topicref>
+<topicref href="rrefrestorefrom.dita" navtitle="restoreFrom=path attribute">
+</topicref>
<topicref href="rrefrollforward.dita" navtitle="rollForwardRecoveryFrom=path attribute">
</topicref>
-<topicref href="rrefattrib16471.dita" navtitle="shutdown=true attribute"></topicref>
-<topicref href="rrefattrib56769.dita" navtitle="territory=ll_CC attribute"></topicref>
-<topicref href="rrefattrib10035.dita" navtitle="user=userName attribute"></topicref>
-<topicref href="rrefattrib34183.dita" navtitle="Creating a connection without specifying attributes"></topicref>
+<topicref href="rrefattrib16471.dita" navtitle="shutdown=true attribute">
+</topicref>
+<topicref href="rrefattrib56769.dita" navtitle="territory=ll_CC attribute">
+</topicref>
+<topicref href="rrefattrib10035.dita" navtitle="user=userName attribute">
+</topicref>
+<topicref href="rrefattrib34183.dita" navtitle="Creating a connection without specifying attributes">
+</topicref>
</topicref>
<topicref collection-type="family" href="rrefjta16677.dita" navtitle="J2EE Compliance: Java Transaction API and javax.sql Extensions">
<topicref href="rrefjta94396.dita" navtitle="JVM and libraries for J2EE features">
Added: db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita?view=auto&rev=518684
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita Thu Mar 15 09:44:56 2007
@@ -0,0 +1,181 @@
+<?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="rrefsyscsdialgtables" xml:lang="en-us">
+<title>SYSCS_DIAG diagnostic tables and functions</title>
+<shortdesc><ph conref="refconrefs.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></keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>There are two types of table expressions in <ph conref="refconrefs.dita#prod/productshortname"></ph>:<dl>
+<dlentry>
+<dt>Diagnostic tables</dt>
+<dd>Tables that are like any other table in <ph conref="refconrefs.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="refconrefs.dita#prod/productshortname"></ph>.
+The diagnostic table functions require one or more arguments. 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 <ph
+conref="refconrefs.dita#prod/productshortname"></ph> table expressions. </p><table>
+<title>System table expressions provided by <ph conref="refconrefs.dita#prod/productshortname"></ph></title>
+<tgroup cols="2"><colspec colname="col1" colwidth="50*"/><colspec colname="col2"
+colwidth="49*"/>
+<thead>
+<row valign="bottom">
+<entry colname="col1">Diagnostic tables</entry>
+<entry colname="col2">Diagnostic table functions</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="col1">SYSCS_DIAG.ERROR_MESSAGES</entry>
+<entry colname="col2">SYSCS_DIAG.ERROR_LOG_READER</entry>
+</row>
+<row>
+<entry colname="col1">SYSCS_DIAG.LOCK_TABLE</entry>
+<entry colname="col2">SYSCS_DIAG.SPACE_TABLE</entry>
+</row>
+<row>
+<entry colname="col1">SYSCS_DIAG.STATEMENT_CACHE</entry>
+<entry colname="col2">SYSCS_DIAG.STATEMENT_DURATION</entry>
+</row>
+<row>
+<entry colname="col1">SYSCS_DIAG.TRANSACTION_TABLE </entry>
+<entry colname="col2"> </entry>
+</row>
+</tbody>
+</tgroup>
+</table><p><note type="restriction">If you reference a diagnostic table in
+a DDL statement or a compression procedure, <ph conref="refconrefs.dita#prod/productshortname"></ph> returns
+an exception. </note></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>To
+use SYSCS_DIAG.ERROR_LOG_READER diagnostic table function, you specify the
+name of the function in the 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>To specify a log file name, the file name must be an expression
+whose data type maps to a Java string. Use single quotation marks when you
+specify the log file name to ensure that the argument is read as string, otherwise
+a syntax error is thrown.</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="refconrefs.dita#prod/productshortname"></ph> log
+files contain only boot, shutdown, and error messages. In the <cite><ph conref="refconrefs.dita#pub/cittuning"></ph> guide</cite>,
+see the <parmname>derby.stream.error.logSeverityLevel</parmname> property
+and the <parmname>derby.language.logStatementText</parmname> property for
+instructions on how to print more information to <ph conref="refconrefs.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="refconrefs.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></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="refconrefs.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>When
+the SYSCS_DIAG.LOCK_TABLE diagnostic table is referenced in a statement, a
+snap shot of the lock table is taken. A snap shot 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 snap
+shot is taken. </p></section>
+<section><title>SYSCS_DIAG.SPACE_TABLE diagnostic table function</title><p>The
+SYSCS_DIAG.SPACE_TABLE diagnostics table function shows the space usage of
+a particular table and its indexes. You can use the SYSCS_DIAG.SPACE_TABLE
+diagnostics table function to determine if space might be saved by compressing
+the table and indexes.</p><p>To use SYSCS_DIAG.SPACE_TABLE diagnostic table
+function, you specify the name of the function in the table function syntax.</p><p>For
+example: <codeblock>SELECT *
+ FROM TABLE (SYSCS_DIAG.SPACE_TABLE(schemaName, tableName))
+ AS T2</codeblock>where T2 is a user-specified table name that is any valid
+identifier. </p><p>If you do not specify the <parmname>schemaName</parmname>,
+the current schema is used.</p><p>Both the <parmname>schemaName</parmname> and
+the <parmname>tableName</parmname> parameters must be expressions whose data
+types map to Java strings. Use single quotation marks when you specify these
+parameters to ensure that the arguments are read as strings, otherwise a syntax
+error is thrown. 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></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 use the SYSCS_DIAG.STATEMENT_DURATION
+diagnostic table function to get a indication of where the bottlenecks are
+in the JDBC code for an application.</p><p>To use SYSCS_DIAG.STATEMENT_DURATION
+diagnostic table function, you specify the name of the function in the 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>To specify a log file name, the file
+name must be an expression whose data type maps to a Java string. Use single
+quotation marks when you specify the log file name to ensure that the argument
+is read as string, otherwise a syntax error is thrown.</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="refconrefs.dita#prod/productshortname"></ph> log
+files contain only boot, shutdown, and error messages. In the <cite><ph conref="refconrefs.dita#pub/cittuning"></ph> guide</cite>,
+see the <parmname>derby.stream.error.logSeverityLevel</parmname> property
+and the <parmname>derby.language.logStatementText</parmname> property for
+instructions on how to print more information to <ph conref="refconrefs.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 snap shot of the transaction table is taken. A snap shot 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 snap shot is taken. </p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
------------------------------------------------------------------------------
svn:eol-style = native