svn commit: r1166829 - /db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita

[ch...@apache.org]

Author: chaase3
Date: Thu Sep  8 18:10:42 2011
New Revision: 1166829

URL: http://svn.apache.org/viewvc?rev=1166829&view=rev
Log:
DERBY-5404  Document DBO restriction for four diagnostic VTIs

Merged DERBY-5404-2.diff to 10.8 docs branch from trunk revision 1166780.

Modified:
    db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita

Modified: db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita?rev=1166829&r1=1166828&r2=1166829&view=diff
==============================================================================
--- db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita (original)
+++ db/derby/docs/branches/10.8/src/ref/rrefsyscsdiagtables.dita Thu Sep  8 18:10:42 2011
@@ -121,6 +121,8 @@ statement</xref>.</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
@@ -128,8 +130,12 @@ SQL statements that are in the <filepath
 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
-access the SYSCS_DIAG.ERROR_LOG_READER diagnostic table function, you must
+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
@@ -152,22 +158,29 @@ diagnostic table function. </note></p></
 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></section>
+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>When
+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
-snap shot of the lock table is taken.  A snap shot is used so that referencing
+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 snap
-shot is taken. </p></section>
+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>To
-access the SYSCS_DIAG.SPACE_TABLE diagnostic table function, you must use
+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. This diagnostic table function takes two arguments,
 the <parmname>schemaName</parmname> and the <parmname>tableName</parmname>.
 The <parmname>tableName</parmname> argument is required. If you do not specify
@@ -260,13 +273,22 @@ example: <codeblock>SELECT * 
 <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>
+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>To access the SYSCS_DIAG.STATEMENT_DURATION diagnostic
+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
@@ -293,9 +315,14 @@ SYSCS_DIAG.TRANSACTION_TABLE  diagnostic
 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
+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 snap shot is taken. </p></section>
+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>
 </refbody>
 </reference>