[ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]
Rick Hillegas updated DERBY-1271:
---------------------------------
Description:
We can't check in any of this work until we understand how our release trains
line up. However, the JDBC4-bearing release will need the following
documentation:
1) Changes to the user guides. These need to be understood. We can analyze the
scope of these changes without checking anything in yet.
2) Summary page which explains what pieces of JDBC4 we tackled and what we
passed over.
3) Verbiage for the Release Notes.
USER GUIDES
Admin Guide
Part One...How to start an embedded server from an application
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Embedded server example
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Network client driver examples
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Accessing the Network Server by using a DataSource
For JDBC4, we have different DataSources: ClientDateSource40
and ClientConnectionPoolDataSource40.
Part One...Using the Derby ij tool with the Network Server
In case the DRIVER command ends up being needed pre-JDBC4,
we should note that you don't need it under JDBC4 because
of Driver autoloading.
Part One...The NsSample sample program
Change NsSample to demonstrate driver autoloading under JDBC4.
Part One...Overview of the SimpleNetworkServerSample program
Change SimpleNetworkServerSample to demonstrate driver autoloading under
JDBC4.
Part One...Connecting a client to the Network Server with the
SimpleNetworkClientSample program
Change SimpleNetworkClientSample to demonstrate driver autoloading under
JDBC4.
Developer's Guide
JDBC applications and Derby basics
Derby embedded basics
Derby JDBC driver
Note that you don't need Class.forName() in JDBC4.
Derby embedded basics
Embedded Derby JDBC driver
Note that you don't need Class.forName() in JDBC4.
Starting Derby as an embedded database
Note that you don't need Class.forName() or the jdbc.drivers property
in JDBC4.
Controlling Derby application behavior
Working with Derby SQLExceptions in an application
Note that with JDBC4, these are refined subclasses
Example of processing SQLExceptions
Say something about SQLException.getCause()
Using Derby as a J2EE resource manager
Classes that pertain to resource managers
Mention the JDBC4 variants of these classes.
Getting a DataSource
Include example using JDBC4 variants of these classes.
Shutting down or creating a database
Include example using JDBC4 variants of these classes.
Getting Started Guide
No changes necessary.
Reference Guide
Derby exception messages and SQL states
Describe SQLFeatureNotSupportedException and its SQLStates.
SQLState and error message reference
Mention new unimplementedFeature exceptions.
What to do about new SQLStates.
JDBC Reference
"conforms to the JDBC 2.0 and 3.0 APIs"
->
"conforms to the JDBC 2.0, 3.0, and 4.0 APIs"
java.sql.Driver
Amend this to note driver autoloading for JDBC4.
java.sql.Connection
Connection functionality not supported
List unsupported Connection methods.
java.sql.DatabaseMetaData
Columns in the ResultSet returned by getProcedureColumns
Add new columns added by JDBC4
java.sql.Statement
Waiting for Lance to confirm what to do about
setEscapeProcessing()
Note that Derby does not support the execute() and
executeQuery() overloads which return autogenerated keys.
Prepared statements and streaming columns
Note that with JDBC4, you can specify length as a long
or even omit the length when setting LOB streams.
java.sql.ResultSetMetaData
Waiting for feedback from Dag on whether we still don't
support isDefinitelyWritable(), isReadOnly(), and
isWritable().
java.sql.Blob and java.sql.Clob
Right now this section says that Derby supports the methods in
the Blob and Clob interfaces. This is not true. We should
describe the discrepancies, including any additional methods added
by JDBC4.
JDBC 4.0-only features
Add this new section, with a subsection for each SQL interface
that changed in JDBC4. The subsections should list new methods
that were added.
Derby API
JDBC implementation classes
Data Source Classes
List the JDBC4 versions of these classes
was:
We can't check in any of this work until we understand how our release trains
line up. However, the JDBC4-bearing release will need the following
documentation:
1) Changes to the user guides. These need to be understood. We can analyze the
scope of these changes without checking anything in yet.
2) Summary page which explains what pieces of JDBC4 we tackled and what we
passed over.
3) Verbiage for the Release Notes.
USER GUIDES
Admin Guide
Part One...How to start an embedded server from an application
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Embedded server example
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Network client driver examples
For JDBC4, we can omit the Class.forName() line because
of Driver autoloading.
Part One...Accessing the Network Server by using a DataSource
For JDBC4, we have different DataSources: ClientDateSource40
and ClientConnectionPoolDataSource40.
Part One...Using the Derby ij tool with the Network Server
In case the DRIVER command ends up being needed pre-JDBC4,
we should note that you don't need it under JDBC4 because
of Driver autoloading.
Part One...The NsSample sample program
Change NsSample to demonstrate driver autoloading under JDBC4.
Part One...Overview of the SimpleNetworkServerSample program
Change SimpleNetworkServerSample to demonstrate driver autoloading under
JDBC4.
Part One...Connecting a client to the Network Server with the
SimpleNetworkClientSample program
Change SimpleNetworkClientSample to demonstrate driver autoloading under
JDBC4.
Developer's Guide
JDBC applications and Derby basics
Derby embedded basics
Derby JDBC driver
Note that you don't need Class.forName() in JDBC4.
Derby embedded basics
Embedded Derby JDBC driver
Note that you don't need Class.forName() in JDBC4.
Starting Derby as an embedded database
Note that you don't need Class.forName() or the jdbc.drivers property
in JDBC4.
Controlling Derby application behavior
Working with Derby SQLExceptions in an application
Note that with JDBC4, these are refined subclasses
Example of processing SQLExceptions
Say something about SQLException.getCause()
Using Derby as a J2EE resource manager
Classes that pertain to resource managers
Mention the JDBC4 variants of these classes.
Getting a DataSource
Include example using JDBC4 variants of these classes.
Shutting down or creating a database
Include example using JDBC4 variants of these classes.
Add analysis of Getting Started Guide and Reference Guide.
> Release documentation for JDBC4 release
> ---------------------------------------
>
> Key: DERBY-1271
> URL: http://issues.apache.org/jira/browse/DERBY-1271
> Project: Derby
> Type: Improvement
> Components: Documentation, JDBC
> Versions: 10.2.0.0
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Fix For: 10.2.0.0
>
> We can't check in any of this work until we understand how our release trains
> line up. However, the JDBC4-bearing release will need the following
> documentation:
> 1) Changes to the user guides. These need to be understood. We can analyze
> the scope of these changes without checking anything in yet.
> 2) Summary page which explains what pieces of JDBC4 we tackled and what we
> passed over.
> 3) Verbiage for the Release Notes.
> USER GUIDES
> Admin Guide
> Part One...How to start an embedded server from an application
> For JDBC4, we can omit the Class.forName() line because
> of Driver autoloading.
> Part One...Embedded server example
> For JDBC4, we can omit the Class.forName() line because
> of Driver autoloading.
> Part One...Network client driver examples
> For JDBC4, we can omit the Class.forName() line because
> of Driver autoloading.
> Part One...Accessing the Network Server by using a DataSource
> For JDBC4, we have different DataSources: ClientDateSource40
> and ClientConnectionPoolDataSource40.
> Part One...Using the Derby ij tool with the Network Server
> In case the DRIVER command ends up being needed pre-JDBC4,
> we should note that you don't need it under JDBC4 because
> of Driver autoloading.
> Part One...The NsSample sample program
> Change NsSample to demonstrate driver autoloading under JDBC4.
> Part One...Overview of the SimpleNetworkServerSample program
> Change SimpleNetworkServerSample to demonstrate driver autoloading under
> JDBC4.
> Part One...Connecting a client to the Network Server with the
> SimpleNetworkClientSample program
> Change SimpleNetworkClientSample to demonstrate driver autoloading under
> JDBC4.
> Developer's Guide
> JDBC applications and Derby basics
> Derby embedded basics
> Derby JDBC driver
> Note that you don't need Class.forName() in JDBC4.
> Derby embedded basics
> Embedded Derby JDBC driver
> Note that you don't need Class.forName() in JDBC4.
> Starting Derby as an embedded database
> Note that you don't need Class.forName() or the jdbc.drivers property
> in JDBC4.
> Controlling Derby application behavior
> Working with Derby SQLExceptions in an application
> Note that with JDBC4, these are refined subclasses
> Example of processing SQLExceptions
> Say something about SQLException.getCause()
> Using Derby as a J2EE resource manager
> Classes that pertain to resource managers
> Mention the JDBC4 variants of these classes.
> Getting a DataSource
> Include example using JDBC4 variants of these classes.
> Shutting down or creating a database
> Include example using JDBC4 variants of these classes.
> Getting Started Guide
> No changes necessary.
> Reference Guide
> Derby exception messages and SQL states
> Describe SQLFeatureNotSupportedException and its SQLStates.
> SQLState and error message reference
> Mention new unimplementedFeature exceptions.
> What to do about new SQLStates.
> JDBC Reference
> "conforms to the JDBC 2.0 and 3.0 APIs"
> ->
> "conforms to the JDBC 2.0, 3.0, and 4.0 APIs"
> java.sql.Driver
> Amend this to note driver autoloading for JDBC4.
> java.sql.Connection
> Connection functionality not supported
> List unsupported Connection methods.
> java.sql.DatabaseMetaData
> Columns in the ResultSet returned by getProcedureColumns
> Add new columns added by JDBC4
> java.sql.Statement
> Waiting for Lance to confirm what to do about
> setEscapeProcessing()
> Note that Derby does not support the execute() and
> executeQuery() overloads which return autogenerated keys.
> Prepared statements and streaming columns
> Note that with JDBC4, you can specify length as a long
> or even omit the length when setting LOB streams.
> java.sql.ResultSetMetaData
> Waiting for feedback from Dag on whether we still don't
> support isDefinitelyWritable(), isReadOnly(), and
> isWritable().
> java.sql.Blob and java.sql.Clob
> Right now this section says that Derby supports the methods in
> the Blob and Clob interfaces. This is not true. We should
> describe the discrepancies, including any additional methods added
> by JDBC4.
> JDBC 4.0-only features
> Add this new section, with a subsection for each SQL interface
> that changed in JDBC4. The subsections should list new methods
> that were added.
> Derby API
> JDBC implementation classes
> Data Source Classes
> List the JDBC4 versions of these classes
--
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
