You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2014/06/10 21:52:48 UTC
svn commit: r1601760 - /db/derby/docs/trunk/src/ref/
Author: chaase3
Date: Tue Jun 10 19:52:48 2014
New Revision: 1601760
URL: http://svn.apache.org/r1601760
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 12 Reference Manual topics.
Patch: DERBY-6379-ref-diag.diff
Modified:
db/derby/docs/trunk/src/ref/rrefscalarsubquery.dita
db/derby/docs/trunk/src/ref/rrefselectexpression.dita
db/derby/docs/trunk/src/ref/rrefsqlj29840.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita
Modified: db/derby/docs/trunk/src/ref/rrefscalarsubquery.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefscalarsubquery.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefscalarsubquery.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefscalarsubquery.dita Tue Jun 10 19:52:48 2014
@@ -19,15 +19,18 @@ limitations under the License.
-->
<reference id="rrefscalarsubquery" xml:lang="en-us">
<title>scalarSubquery</title>
+<shortdesc>A <i>scalarSubquery</i>, sometimes called an expression subquery, is
+a subquery that evaluates to a single row with a single column.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>scalarSubquery</indexterm></keywords>
+<keywords><indexterm>scalarSubquery</indexterm>
+<indexterm>expression subquery</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>You can place a <i>scalarSubquery</i> anywhere an <i>expression</i> is
-permitted. A <i>scalarSubquery</i> turns a <i><xref href="rrefselectexpression.dita#rrefselectexpression">selectExpression</xref></i> result
-into a scalar value because it returns only a single row and column value.</p> <p>The
-query must evaluate to a single row with a single column.</p> <p><indexterm>Expression
-subquery</indexterm>Sometimes also called an expression subquery.</p></section>
+<section> <p>You can place a <i>scalarSubquery</i> anywhere an <i>expression</i>
+is permitted. A <i>scalarSubquery</i> turns a
+<i><xref href="rrefselectexpression.dita">selectExpression</xref></i> result
+into a scalar value because it returns only a single row and column value.</p>
+</section>
<refsyn><title>Syntax</title>
<codeblock><b>( <i><xref href="rrefsqlj21571.dita#rrefsqlj21571">query</xref></i>
[ <i><xref href="rrefsqlj13658.dita#rrefsqlj13658">ORDER BY clause</xref></i> ]
Modified: db/derby/docs/trunk/src/ref/rrefselectexpression.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefselectexpression.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefselectexpression.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefselectexpression.dita Tue Jun 10 19:52:48 2014
@@ -19,15 +19,15 @@ limitations under the License.
-->
<reference id="rrefselectexpression" xml:lang="en-us">
<title>selectExpression</title>
+<shortdesc>A <i>selectExpression</i> is the basic SELECT-FROM-WHERE construct
+used to build a table value based on filtering and projecting values from other
+tables.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Select expression</indexterm><indexterm>DISTINCT clause<indexterm>part
of selectExpression</indexterm><indexterm>* as wildcard in SQL SELECT</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>A <i>selectExpression</i> is the basic SELECT-FROM-WHERE construct
-used to build a table value based on filtering and projecting values from
-other tables.</p></section>
<refsyn><title>Syntax</title> <codeblock><b>SELECT [ DISTINCT | ALL ] <i>selectItem</i> [ , <i>selectItem </i>]*
<i><xref href="rrefsqlj21583.dita#rrefsqlj21583">FROM clause</xref></i>
[ <i><xref href="rrefsqlj33602.dita#rrefsqlj33602">WHERE clause</xref> </i>]
Modified: db/derby/docs/trunk/src/ref/rrefsqlj29840.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj29840.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj29840.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj29840.dita Tue Jun 10 19:52:48 2014
@@ -19,15 +19,16 @@ limitations under the License.
-->
<reference id="rrefsqlj29840" xml:lang="en-us">
<title>JOIN operations</title>
+<shortdesc>The JOIN operations perform joins between two tables.</shortdesc>
<prolog><metadata>
<keywords><indexterm>JOIN operations</indexterm><indexterm>Outer joins</indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>The JOIN operations, which are among the possible <i><xref href="rreftableexpression.dita#rreftableexpression">tableExpression</xref
->s</i> in a <xref href="rrefsqlj21583.dita#rrefsqlj21583">FROM clause</xref>,
-perform joins between two tables. (You can also perform a join between two
-tables using an explicit equality test in a WHERE clause, such as
+<section><p>The JOIN operations are among the possible
+<i><xref href="rreftableexpression.dita">tableExpression</xref></i>s in a
+<xref href="rrefsqlj21583.dita">FROM clause</xref>. (You can also perform a join
+between two tables using an explicit equality test in a WHERE clause, such as
<codeph>WHERE t1.col1 = t2.col2</codeph>.)</p></section>
<section><p>The JOIN operations are:</p> <ul>
<li><xref href="rrefsqlj35034.dita#rrefsqlj35034"></xref> <p>Specifies a
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagcontainedroles.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagcontainedroles" xml:lang="en-us">
<title>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</title>
+<shortdesc>The SYSCS_DIAG.CONTAINED_ROLES diagnostic table function returns all
+the roles contained within the specified role.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>SYSCS_DIAG.CONTAINED_ROLES diagnostic table function</indexterm>
@@ -28,8 +30,7 @@ limitations under the License.
</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
+<p>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
@@ -40,7 +41,9 @@ statement</xref>.</p>
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>
+database has authentication and SQL authorization enabled. See "Configuring user
+authentication" and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagerrorlogreader.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,9 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagerrorlogreader" xml:lang="en-us">
<title>SYSCS_DIAG.ERROR_LOG_READER diagnostic table function</title>
+<shortdesc>The SYSCS_DIAG.ERROR_LOG_READER diagnostic table function contains all the
+useful SQL statements that are in the <codeph>derby.log</codeph> file or a
+log file that you specify.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.ERROR_LOG_READER</indexterm></indexterm>
@@ -28,9 +31,6 @@ limitations under the License.
</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
@@ -38,7 +38,9 @@ timestamp (timestampConstant) in the err
<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>
+access this diagnostic table function. See "Configuring user authentication"
+and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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 *
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagerrormessages.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,9 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagerrormessages" xml:lang="en-us">
<title>SYSCS_DIAG.ERROR_MESSAGES diagnostic table</title>
+<shortdesc>The SYSCS_DIAG.ERROR_MESSAGES diagnostic table shows all of the
+<i>SQLState</i>s, locale-sensitive error messages, and exception severities for
+a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.ERROR_MESSAGES</indexterm></indexterm>
@@ -28,15 +31,13 @@ limitations under the License.
</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:
+<p>You can reference the SYSCS_DIAG.ERROR_MESSAGES diagnostic table directly in
+a statement. 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>
+authentication and SQL authorization enabled. See "Configuring user
+authentication" and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</p>
<p>The table has the columns shown in the following table.</p>
<table frame="all">
<title>Columns in the SYSCS_DIAG.ERROR_MESSAGES table</title>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiaglocktable.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,9 @@ limitations under the License.
-->
<reference id="rrefsyscsdiaglocktable" xml:lang="en-us">
<title>SYSCS_DIAG.LOCK_TABLE diagnostic table</title>
+<shortdesc>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.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.LOCK_TABLE</indexterm></indexterm>
@@ -28,13 +31,13 @@ limitations under the License.
</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>You can reference the SYSCS_DIAG.LOCK_TABLE diagnostic table directly
+in a statement. 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>
+authentication and SQL authorization enabled. See "Configuring user
+authentication" and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagspacetable.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagspacetable" xml:lang="en-us">
<title>SYSCS_DIAG.SPACE_TABLE diagnostic table function</title>
+<shortdesc>The SYSCS_DIAG.SPACE_TABLE diagnostic table function shows the space
+usage of a particular table and its indexes.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.SPACE_TABLE</indexterm></indexterm>
@@ -28,28 +30,30 @@ limitations under the License.
</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>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>
+database has authentication and SQL authorization enabled. See "Configuring user
+authentication" and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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
+<li>If invoked with one argument, a <varname>tableName</varname>, 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
+<li>If invoked with two arguments, a <varname>schemaName</varname> followed by
+a <varname>tableName</varname>, 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">
+<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*"/>
@@ -70,7 +74,9 @@ the specified schema and table.</li>
<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>
+<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>
@@ -84,21 +90,28 @@ the specified schema and table.</li>
<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>
+<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>
+<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>
+<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>
@@ -112,14 +125,15 @@ the specified schema and table.</li>
<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>
+<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>
+<entry colname="5">The id of the table to which the conglomerate belongs.</entry>
</row>
</tbody>
</tgroup>
@@ -134,10 +148,10 @@ user tables and indexes in the database:
AND sysschemas.schemaid = systabs.schemaid
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
+<p>Both the <varname>schemaName</varname> and the <varname>tableName</varname>
+arguments must be expressions whose data types map to Java strings. If the
+<varname>schemaName</varname> and the <varname>tableName</varname> are
+non-delimited identifiers, you must specify the names in uppercase.</p><p>For
example: <codeblock>SELECT *
FROM TABLE (SYSCS_DIAG.SPACE_TABLE('MYSCHEMA', 'MYTABLE'))
AS T2</codeblock></p>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementcache.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagstatementcache" xml:lang="en-us">
<title>SYSCS_DIAG.STATEMENT_CACHE diagnostic table</title>
+<shortdesc>The SYSCS_DIAG.STATEMENT_CACHE diagnostic table shows the contents of
+the SQL statement cache.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.STATEMENT_CACHE</indexterm></indexterm>
@@ -28,14 +30,15 @@ limitations under the License.
</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>You can reference the SYSCS_DIAG.STATEMENT_CACHE diagnostic table directly in
+a statement. 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>
+access this diagnostic table. See "Configuring user authentication" and
+"Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagstatementduration.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,10 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagstatementduration" xml:lang="en-us">
<title>SYSCS_DIAG.STATEMENT_DURATION diagnostic table function</title>
+<shortdesc>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 <codeph>derby.log</codeph> file or a log file that you
+specify.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic table functions<indexterm>SYSCS_DIAG.STATEMENT_DURATION</indexterm></indexterm>
@@ -28,15 +32,14 @@ limitations under the License.
</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>
+access this diagnostic table function. See "Configuring user authentication" and
+"Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</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 *
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,10 @@ limitations under the License.
-->
<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 tables and table functions</indexterm>
@@ -28,9 +32,6 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p><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.</p>
<p>There are two types of diagnostic table expressions in
<ph conref="../conrefs.dita#prod/productshortname"></ph>:
<dl>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita?rev=1601760&r1=1601759&r2=1601760&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtransactiontable.dita Tue Jun 10 19:52:48 2014
@@ -20,6 +20,8 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagtransactiontable" xml:lang="en-us">
<title>SYSCS_DIAG.TRANSACTION_TABLE diagnostic table</title>
+<shortdesc>The SYSCS_DIAG.TRANSACTION_TABLE diagnostic table shows all of the
+transactions that are currently in the database.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic tables<indexterm>SYSCS_DIAG.TRANSACTION_TABLE</indexterm></indexterm>
@@ -28,10 +30,8 @@ limitations under the License.
</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:
+<p>You can reference the SYSCS_DIAG.TRANSACTION_TABLE diagnostic table directly
+in a statement. 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
@@ -41,7 +41,9 @@ transition state when the snapshot is ta
<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>
+access this diagnostic table. See "Configuring user authentication" and
+"Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</p>
<p>The table has the columns shown in the following table.</p>
<table frame="all">
<title>Columns in the SYSCS_DIAG.TRANSACTION_TABLE table</title>