db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2388) DOCS - Reorder JDBC Reference section in Ref Manual
Date Thu, 07 Aug 2008 21:16:44 GMT

    [ https://issues.apache.org/jira/browse/DERBY-2388?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12620751#action_12620751
] 

Kim Haase commented on DERBY-2388:
----------------------------------

The JDBC Reference section of the Reference Manual needs some final reordering now that the
JDBC 2.0 and 3.0 sections have been merged into the general reference sections (DERBY-3409
and DERBY-3668). This is also a good time to tidy up the tasks mentioned in the attachment
JDBCref2.txt.

The ordering currently starts by following more or less the order in which the particular
interfaces are likely to be used in an application, which seems reasonable:

java.sql.Driver interface
java.sql.DriverManager.getConnection method
java.sql.Connection interface
java.sql.DatabaseMetaData interface
java.sql.Statement interface
java.sql.CallableStatement interface

Things then get out of order a bit, because "java.sql.SQLException class" comes before "java.sql.PreparedStatement
interface", and things start to get a little messy. I think the appropriate order is as follows:

java.sql.PreparedStatement interface
java.sql.ResultSet interface
java.sql.ResultSetMetaData interface
java.sql.Savepoint interface
java.sql.SQLException class
java.sql.SQLWarning class
Mapping of java.sql.Types to SQL types
JDBC Package for Connected Device Configuration/Foundation Profile (JSR169)
JDBC 4.0-only features
JDBC escape syntax

I'm listing the top-level heads; child topics stay with their parents.

The topic "Core JDBC java.sql classes, interfaces, and methods" is redundant, since it just
lists the other topics in the section. Other sections of the manual don't have such a topic,
so this one should be removed.

The topic "java.sql.SQLXML interface" should be moved under "JDBC 4.0-only features", since
it is such a feature. 

The topic "java.sql.BatchUpdateException class" should be removed completely, since it contains
no Derby-specific information. (It consists solely of the sentence, "Thrown if there is a
problem with a batch update.")

> DOCS - Reorder JDBC Reference section in Ref Manual
> ---------------------------------------------------
>
>                 Key: DERBY-2388
>                 URL: https://issues.apache.org/jira/browse/DERBY-2388
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Laura Stewart
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: JDBCref.txt, JDBCref2.txt
>
>
> The JDBC reference section isn't in alphabetical order either. It might make sense to
reorder it to correspond with the javadoc (which separates interfaces, classes, and exceptions
into subgroups and orders them alphabetically). I'd also suggest putting java.sql.Driver.getPropertyInfo
in a subtopic under java.sql.Driver. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message