db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stan Bradbury (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-1520) Document new SYSCS_DIAG tables
Date Tue, 22 Aug 2006 20:58:17 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1520?page=comments#action_12429805 ] 
            
Stan Bradbury commented on DERBY-1520:
--------------------------------------

For now I think we need to simply document the names of the tables and a biref description
of each.  A simple list with the table names and a one or two line description will suffice.
 Also provide USAGE examples to drive home that these are referenced like any other table
in a SELECT statement.   You could even refer people to the JAVADOC description of the corresponding
DIAG class for more information but this could lead to confusion as the JAVADOC contains information
only available when using the CLASSES from a JDBC program as well as lists alternate (deprecated)
SELECT syntax.

I would pull the description from the JAVADOC to use in the list above and also list the columns
as described in the JAVADOC.  In case you had trouble mapping these to the proper JAVADOC
here are specific links:

http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/LockTable.html
http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/StatementCache.html
http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/TransactionTable.html
http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/ErrorMessages.html

It is also important to note that the SELECT syntax shown in the JAVADOC is being depricated
and that the new syntax referencing the tables in the SYSCS_DIAG schema should be used.

> Document new SYSCS_DIAG tables
> ------------------------------
>
>                 Key: DERBY-1520
>                 URL: http://issues.apache.org/jira/browse/DERBY-1520
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.2.1.0
>            Reporter: Stan Bradbury
>
> See comments for DERBY-571 for initial documentation discussion.  The new tables (mapped
to the old Diagnostic VTIs) are:
> The old style syntax will remain in place for 10.2, but become deprecated.
> The tables to be implemented in this change are:
> SYSCS_DIAG.LOCK_TABLE replaces org.apache.derby.diag.LockTable
> SYSCS_DIAG.STATEMENT_CACHE replaces org.apache.derby.diag.StatementCache
> SYSCS_DIAG.TRANSACTION_TABLE replaces org.apache.derby.diag.TransactionTable
> SYSCS_DIAG.ERROR_MESSAGES replaces org.apache.derby.diag.ErrorMessages 
> The information about the tables can be found in the javadoc for the class listed above.
> That can be found at:
> http://db.apache.org/derby/javadoc/engine/
> click on the org.apache.derby.diag link in the Packages table, then select each class,
e.g. LockTable to see the info.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message