[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-09-18 Thread Jean T. Anderson (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Jean T. Anderson updated DERBY-1271:


Attachment: JWarn-all-src-2.diff
JWarn-all-review-2.zip

This adds the JDBC 4.0 warning to reference topics (mostly) in the
Reference Manual, Admin Guide, Developers Guide, and Tools Guide:

   JWarn-all-src-2.diff   - patch to DITA source
   JWarn-all-review-2.zip - html pages for review

This is mostly for reference topics because I discovered there are still
problems with some reference topics in the guides.  The real issue seems to
be the placement of the shortdesc and title elements outside the
refbody or conbody element.  That can be untangled post-9.2.

This patch adds the disclaimer to these files:

   src/tools/rtoolsijproprefdatasource.dita
   src/adminguide/radminembeddedserverex.dita
   src/adminguide/radminappsclientxmp.dita
   src/devguide/cdevdvlp19524.dita
   src/ref/rrefjdbc4_0connection.dita
   src/ref/rrefjdbc4_0sqlexception.dita
   src/ref/rrefjdbc4_0databaseMetaData.dita
   src/ref/rrefjdbc32052.dita
   src/ref/rrefjavsqlprst.dita
   src/ref/rrefjdbc4_0statement.dita
   src/ref/rrefjdbc4_0dataSource.dita
   src/ref/rrefjdbc4_0summary.dita
   src/ref/rrefapi1003363.dita

These conrefs files get the variable defined:

   src/adminguide/adminconrefs.dita
   src/tools/toolsconrefs.dita
   src/devguide/devconrefs.dita
   src/ref/refconrefs.dita

The Developer's Guide didn't end up with the disclaimer in any pages that 
reference JDBC 4.0, so I added the disclaimer to devguide/cdevdvlp19524.dita, 
which is the first page of the Developer Guide's JDBC applications and Derby 
basics.

If nobody spots any problems by the end of today, I'll go ahead and commit
these changes.

 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.1.0
Reporter: Rick Hillegas
 Assigned To: Jean T. Anderson
 Fix For: 10.2.1.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, derby-1271_refGuide_v01.diff, 
 derby-1271_refGuide_v01.tar, derby-1271_toolsGuide_v01.diff, 
 derby1271-2-html.zip, derby1271-2.diff, derby1271-3-html.zip, 
 derby1271-3.diff, devGuide_v01.tar, JWarn-all-review-2.zip, 
 JWarn-all-src-2.diff, JWarn-ref-review-1.zip, JWarn-ref-src-1.diff, 
 toolsGuide_v01.tar


 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 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-09-15 Thread Jean T. Anderson (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Jean T. Anderson updated DERBY-1271:


Attachment: JWarn-ref-src-1.diff
JWarn-ref-review-1.zip

This adds the JDBC 4.0 warning to files in the Reference Guide:

   JWarn-ref-src-1.diff- patch to DITA source
   JWarn-ref-review-1.zip  - changed html pages, refderby.pdf, ref-single.html

My approach was to update any file that had already been updated as part
of DERBY-1271, but only update it if the file actually references JDK 1.6 or
JDBC 4.0.  Eleven files get the disclaimer.  The files listed below don't get
the disclaimer because they either just link to the JDBC 4.0 summary page or
don't mention either JDK 1.6 or JDBC 4.0 (they got updated for some other
reason).  Also, I also didn't update the error message pages.

   src/ref/rrefcrsrgpc1.dita
   src/ref/rrefjdbc40794.dita
   src/ref/crefjavccns.dita
   src/ref/rrefexcept16677.dita (error messages)

In the pdf and single html book, updating even these many files looks like 
over communicating the issue, but the singleton pages don't have that 
surrounding context. That's why included all three product types in that
zip file for review.

At any rate, here's how adding the warning works, and it will make it easy to 
update the message itself, and to plug it in (or pull out) wherever we see fit.

The refconrefs.dita file stores the text for the warning in a jdbc4disclaimer
variable, which the other files reference with this syntax:

sectionpph 
conref=refconrefs.dita#vers/jdbc4disclaimer/ph/p/section

Incidently, DITA processing complains about the note element in the variable, 
but it does get processed correctly.

Everything works pretty nicely in the Reference Guide and in the Tools Guide,
which has just one topic updated, but there are formatting problems in
the Admin Guide and in Developers Guide, that fortunately gets exhibited
by one page in the Reference Guide, so I can describe it here.

The online DITA instructions at
http://db.apache.org/derby/manuals/dita.html mention the three file types:
concepts, tasks, and reference.  I found it pretty easy to update the
reference pages in the Reference Guide pages because content seems to go
entirely within a refbody element. But I'm grappling with updating concept
files, such as src/ref/crefjdbc12657.dita, which puts content both outside
and inside a conbody element. If you put the disclaimer within the conbody, 
the placement is after the short description which is declared outside the 
conbody. If you put the disclaimer in a section before the conbody, it causes 
weird indents to the left.

pdf page 199 of Ref Guide JDBC Reference shows what the problem looks like.

If any of you who know DITA could look at the source and suggest what
would produce better output, I'd be grateful and that would help me add
the notice to the Admin and Dev guides which have lots more of those c
type files.

I know now vastly more about DITA than I did two days ago.




 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.1.0
Reporter: Rick Hillegas
 Assigned To: Jean T. Anderson
 Fix For: 10.2.1.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, derby-1271_refGuide_v01.diff, 
 derby-1271_refGuide_v01.tar, derby-1271_toolsGuide_v01.diff, 
 derby1271-2-html.zip, derby1271-2.diff, derby1271-3-html.zip, 
 derby1271-3.diff, devGuide_v01.tar, JWarn-ref-review-1.zip, 
 JWarn-ref-src-1.diff, toolsGuide_v01.tar


 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 

Which JDBC 4? -- WAS - Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-09-14 Thread Daniel John Debrunner
Jean T. Anderson (JIRA) wrote:


 Here's the current notice:
 Derby 10.2.1 includes JDBC 4.0 functionality based on a pre-release of Java 
 SE 6.

Do we want to be more precise than that? I had been thinking that Derby
was based upon the Proposed Final Draft, but now I think more likely
it's based upon Mustang b98.

Is there a good statement as to what version of JDBC 4.0 Derby is based
upon, and is that version public?

Maybe the above text is good, but the release notes should state which
point Derby is based upon?

Dan.




Re: Which JDBC 4? -- WAS - Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-09-14 Thread Jean T. Anderson
Daniel John Debrunner wrote:
 Jean T. Anderson (JIRA) wrote:
 
Here's the current notice:
Derby 10.2.1 includes JDBC 4.0 functionality based on a pre-release of Java 
SE 6.
 
 Do we want to be more precise than that? I had been thinking that Derby
 was based upon the Proposed Final Draft, but now I think more likely
 it's based upon Mustang b98.
 
 Is there a good statement as to what version of JDBC 4.0 Derby is based
 upon, and is that version public?
 
 Maybe the above text is good, but the release notes should state which
 point Derby is based upon?

yes, specific details in the Release Notes are important.

For the notice that appears in each jdbc4 topic, I think we want the
shortest notice possible, with a pointer to the Release Notes.

 -jean





[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-09-13 Thread Jean T. Anderson (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Jean T. Anderson updated DERBY-1271:


Attachment: derby1271-3.diff
derby1271-3-html.zip

These files incorporate feedback from [1] and [2]:
derby1271-3.diff - patch for 10.2 doc branch
derby1271-3-html.zip - review pages for jdbc4_0 topics in reference guide

Here's the current notice:
Derby 10.2.1 includes JDBC 4.0 functionality based on a pre-release of Java SE 
6. When you use Derby with a Java SE 6 virtual machine, Derby will use its JDBC 
3.0 drivers, just as with 1.4 and 1.5 virtual machines. JDBC 4.0 is available 
only to developers who download Java SE 6 and use it to build in support for 
JDBC 4.0. The Release Notes explain how to build the JDBC 4.0 functionality 
with Derby 10.2.1. When Java SE 6 becomes generally available, a follow-on 
Derby release will include final JDBC 4.0 functionality.

If I don't receive any more changes, I'll selectively apply this notice to 
other files that mention jdb 4.0.

thanks for the feedback!

 -jean

[1] http://mail-archives.apache.org/mod_mbox/db-derby-dev/200609.mbox/[EMAIL 
PROTECTED]
[2] http://mail-archives.apache.org/mod_mbox/db-derby-dev/200609.mbox/[EMAIL 
PROTECTED]


 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.1.0
Reporter: Rick Hillegas
 Assigned To: Jean T. Anderson
 Fix For: 10.2.1.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, derby-1271_refGuide_v01.diff, 
 derby-1271_refGuide_v01.tar, derby-1271_toolsGuide_v01.diff, 
 derby1271-2-html.zip, derby1271-2.diff, derby1271-3-html.zip, 
 derby1271-3.diff, devGuide_v01.tar, toolsGuide_v01.tar


 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 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-07-24 Thread Rick Hillegas (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

Attachment: derby-1271_refGuide_v01.diff
derby-1271_refGuide_v01.tar

Attaching relevant changes to the Reference Guide 
(derby-1271_refGuide_v01.diff) and the corresponding html and pdf output 
(derby-1271_refGuide_v01.tar). This patch touches the following files:

A  src\ref\rrefjdbc4_0connection.dita
A  src\ref\rrefjdbc4_0sqlexception.dita
M  src\ref\rrefjdbc40794.dita
A  src\ref\rrefjdbc4_0databaseMetaData.dita
M  src\ref\rrefjdbc32052.dita
M  src\ref\rrefjavsqlprst.dita
M  src\ref\crefjdbc12657.dita
A  src\ref\rrefjdbc4_0statement.dita
M  src\ref\rrefexcept16677.dita
A  src\ref\rrefjdbc4_0dataSource.dita
M  src\ref\rrefcrsrgpc1.dita
M  src\ref\crefjavccns.dita
A  src\ref\rrefjdbc4_0summary.dita
M  src\ref\refderby.ditamap
M  src\ref\rrefapi1003363.dita


 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.0.0
Reporter: Rick Hillegas
 Assigned To: Rick Hillegas
 Fix For: 10.2.0.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, derby-1271_refGuide_v01.diff, 
 derby-1271_refGuide_v01.tar, derby-1271_toolsGuide_v01.diff, 
 devGuide_v01.tar, toolsGuide_v01.tar


 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 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-07-21 Thread Rick Hillegas (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

Attachment: derby-1271_devGuide_v01.diff
devGuide_v01.tar

Attaching patch derby-1271_devGuide_v01.diff and tar of corresponding html and 
pdf: devGuide_v01.tar. These are the changes to the Developer's Guide. This 
patch touches the following files:

M  src\devguide\cdevdvlp40170.dita
M  src\devguide\tdevdvlp38381.dita
M  src\devguide\cdevdvlp40653.dita
M  src\devguide\rdevprocsqle.dita
M  src\devguide\rdevresman79556.dita
M  src\devguide\cdevresman92946.dita
M  src\devguide\cdevconcepts24927.dita
M  src\devguide\cdevresman89722.dita

 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.0.0
Reporter: Rick Hillegas
 Assigned To: Rick Hillegas
 Fix For: 10.2.0.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, devGuide_v01.tar


 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
 Note that Derby does not support the execute() and
 executeQuery() overloads which return autogenerated keys.
 Prepared statements and 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-07-21 Thread Rick Hillegas (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

Attachment: derby-1271_toolsGuide_v01.diff
toolsGuide_v01.tar

Attaching patch derby-1271_toolsGuide_v01.diff and the correponding html and 
pdf output, toolsGuilde_v01.tar. This patch makes the changes to the Tools 
Guide and touches the following files:

M  src\tools\rtoolsijproprefdatasource.dita
M  src\tools\ttoolsij98878.dita

 Release documentation for JDBC4 release
 ---

 Key: DERBY-1271
 URL: http://issues.apache.org/jira/browse/DERBY-1271
 Project: Derby
  Issue Type: Improvement
  Components: Documentation, JDBC
Affects Versions: 10.2.0.0
Reporter: Rick Hillegas
 Assigned To: Rick Hillegas
 Fix For: 10.2.0.0

 Attachments: adminGuide_v01.tar, derby-1271_adminGuide_v01.diff, 
 derby-1271_copyrights.diff, derby-1271_copyrights_v02.diff, 
 derby-1271_devGuide_v01.diff, derby-1271_toolsGuide_v01.diff, 
 devGuide_v01.tar, toolsGuide_v01.tar


 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
 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
  

Re: Copyright format (was Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release)

2006-06-23 Thread Rick Hillegas

Hi Jean,

I have uploaded a new patch which amends the copyrights to this:

Copyright 1997, 2006 The Apache Software Foundation or its licensors, as 
applicable.


In addition, I have removed the Edition lines, whose meaning no-one 
seems to understand.


Do these edits seem acceptable to you?

Thanks,
-Rick

Jean T. Anderson wrote:


Rick Hillegas (JIRA) wrote:
 


[ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

   Attachment: derby-1271_copyrights.diff

Attaching derby-1271_copyrights.diff. This adjusts dates in the visible 
copyright notices in the user guides. Touches the following files:
   



regarding the format of the copyright, Rick did what I originally suggested:

 


Copyright 1997, 2005-2006 The Apache Software Foundation or its licensors, as 
applicable.
   



Looking at this more closely, all that is needed is the origin year and
the year of the most recent update:

  Copyright 1997, 2006 The Apache Software Foundation or its licensors,
as applicable.

-jean
 





Re: Copyright format (was Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release)

2006-06-23 Thread Jean T. Anderson
Rick Hillegas wrote:
 Hi Jean,
 
 I have uploaded a new patch which amends the copyrights to this:
 
 Copyright 1997, 2006 The Apache Software Foundation or its licensors, as
 applicable.
 
 
 In addition, I have removed the Edition lines, whose meaning no-one
 seems to understand.
 
 Do these edits seem acceptable to you?

Looks good to me. Thanks, Rick!

 -jean



Re: Copyright format (was Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release)

2006-06-23 Thread Andrew McIntyre

On 6/23/06, Jean T. Anderson [EMAIL PROTECTED] wrote:

Rick Hillegas wrote:
 Hi Jean,

 I have uploaded a new patch which amends the copyrights to this:

 Copyright 1997, 2006 The Apache Software Foundation or its licensors, as
 applicable.


 In addition, I have removed the Edition lines, whose meaning no-one
 seems to understand.

 Do these edits seem acceptable to you?

Looks good to me. Thanks, Rick!


FYI, now that we seem to really have this issue resolved, I plan on
making a similar change to the 10.1 docs for the 10.1.3 docs.

andrew


Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Rick Hillegas
Thanks, Jean. The Edition line turns up in the visible text which 
appears in the printed document. That makes me think that it applies to 
something that the customer, the reader, cares about. I don't think the 
reader is particularly concerned about our transition to dita. If that 
is what Edition is supposed to capture, perhaps the Edition lines should 
be moved to a comments section so that they will not be 
visible/confusing to customers.


Regards,
-Rick

Jean T. Anderson wrote:


Rick Hillegas (JIRA) wrote:
 


[ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

   Attachment: derby-1271_copyrights.diff

Attaching derby-1271_copyrights.diff. This adjusts dates in the visible 
copyright notices in the user guides. Touches the following files:

   



The update of the copyright line looks fine to me, but I'm not so sure
about the change of the Second Edition (July 2005) line to Third
Edition (July 2006).

I don't know the Edition history -- suspect it maps to the conversion
of the source docs to DITA. Does anyone know for sure?

-jean


 





Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Jean T. Anderson
Rick Hillegas wrote:
 Thanks, Jean. The Edition line turns up in the visible text which
 appears in the printed document. That makes me think that it applies to
 something that the customer, the reader, cares about. I don't think the
 reader is particularly concerned about our transition to dita. If that
 is what Edition is supposed to capture, perhaps the Edition lines should
 be moved to a comments section so that they will not be
 visible/confusing to customers.

The Developers Guide has a first edition for both 10.0 and 10.1:
   http://db.apache.org/derby/docs/10.0/manuals/develop/develop.html
   http://db.apache.org/derby/docs/10.1/devguide/rdevcopyright.html

I don't know why the Edition was bumped for the others. :-)

If there isn't a major change to the content of the book, I don't think
the edition should be bumped.

Working With Derby should definitely not be bumped from First to
Second edition since 10.2 will be its first release.

 -jean



Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Rick Hillegas

Jean T. Anderson wrote:


Rick Hillegas wrote:
 


Thanks, Jean. The Edition line turns up in the visible text which
appears in the printed document. That makes me think that it applies to
something that the customer, the reader, cares about. I don't think the
reader is particularly concerned about our transition to dita. If that
is what Edition is supposed to capture, perhaps the Edition lines should
be moved to a comments section so that they will not be
visible/confusing to customers.
   



The Developers Guide has a first edition for both 10.0 and 10.1:
  http://db.apache.org/derby/docs/10.0/manuals/develop/develop.html
  http://db.apache.org/derby/docs/10.1/devguide/rdevcopyright.html

I don't know why the Edition was bumped for the others. :-)

If there isn't a major change to the content of the book, I don't think
the edition should be bumped.

Working With Derby should definitely not be bumped from First to
Second edition since 10.2 will be its first release.
 

I could just bump the edition for the Reference Guide, which will carry 
a lot of edits to reflect JDBC4. Would that be acceptable?



-jean

 





Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Daniel John Debrunner
Rick Hillegas wrote:

 Jean T. Anderson wrote:
 
 Rick Hillegas wrote:
  

 Thanks, Jean. The Edition line turns up in the visible text which
 appears in the printed document. That makes me think that it applies to
 something that the customer, the reader, cares about. I don't think the
 reader is particularly concerned about our transition to dita. If that
 is what Edition is supposed to capture, perhaps the Edition lines should
 be moved to a comments section so that they will not be
 visible/confusing to customers.
   


 The Developers Guide has a first edition for both 10.0 and 10.1:
   http://db.apache.org/derby/docs/10.0/manuals/develop/develop.html
   http://db.apache.org/derby/docs/10.1/devguide/rdevcopyright.html

 I don't know why the Edition was bumped for the others. :-)

 If there isn't a major change to the content of the book, I don't think
 the edition should be bumped.

 Working With Derby should definitely not be bumped from First to
 Second edition since 10.2 will be its first release.
  

 I could just bump the edition for the Reference Guide, which will carry
 a lot of edits to reflect JDBC4. Would that be acceptable?

What does the edition represent? Would this mean the first release of
the 10.2 documentation set would be partially at the second edition,
doesn't seem to make sense to me.

Dan.



Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Rick Hillegas

Daniel John Debrunner wrote:


Rick Hillegas wrote:

 


Jean T. Anderson wrote:

   


Rick Hillegas wrote:


 


Thanks, Jean. The Edition line turns up in the visible text which
appears in the printed document. That makes me think that it applies to
something that the customer, the reader, cares about. I don't think the
reader is particularly concerned about our transition to dita. If that
is what Edition is supposed to capture, perhaps the Edition lines should
be moved to a comments section so that they will not be
visible/confusing to customers.
 
   


The Developers Guide has a first edition for both 10.0 and 10.1:
 http://db.apache.org/derby/docs/10.0/manuals/develop/develop.html
 http://db.apache.org/derby/docs/10.1/devguide/rdevcopyright.html

I don't know why the Edition was bumped for the others. :-)

If there isn't a major change to the content of the book, I don't think
the edition should be bumped.

Working With Derby should definitely not be bumped from First to
Second edition since 10.2 will be its first release.


 


I could just bump the edition for the Reference Guide, which will carry
a lot of edits to reflect JDBC4. Would that be acceptable?
   



What does the edition represent? Would this mean the first release of
the 10.2 documentation set would be partially at the second edition,
doesn't seem to make sense to me.

Dan.
 

This is what's troubling me too. From Jean's investigations it seems 
that edition doesn't have a consistent meaning across our user guides 
and releases. We could just remove the edition lines. If we leave them 
in, then it would be good to agree on their meaning. Maybe one of the 
following:


1) The Edition number is bumped whenever we create a release branch. We 
don't bump Edition for point or patch releases.


2) The Edition number is bumped whenever reviewers agree that a user 
guide has changed significantly.


3) The Edition number is the same as the release number. All user guides 
in a given release have identical Edition numbers.





Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Jeff Levitt


--- Rick Hillegas [EMAIL PROTECTED] wrote:

 Daniel John Debrunner wrote:
 
 Rick Hillegas wrote:
 
   
 
 Jean T. Anderson wrote:
 
 
 
 Rick Hillegas wrote:
  
 
   
 
 Thanks, Jean. The Edition line turns up in the
 visible text which
 appears in the printed document. That makes me
 think that it applies to
 something that the customer, the reader, cares
 about. I don't think the
 reader is particularly concerned about our
 transition to dita. If that
 is what Edition is supposed to capture, perhaps
 the Edition lines should
 be moved to a comments section so that they will
 not be
 visible/confusing to customers.
   
 
 
 The Developers Guide has a first edition for
 both 10.0 and 10.1:
  

http://db.apache.org/derby/docs/10.0/manuals/develop/develop.html
  

http://db.apache.org/derby/docs/10.1/devguide/rdevcopyright.html
 
 I don't know why the Edition was bumped for the
 others. :-)
 
 If there isn't a major change to the content of
 the book, I don't think
 the edition should be bumped.
 
 Working With Derby should definitely not be
 bumped from First to
 Second edition since 10.2 will be its first
 release.
  
 
   
 
 I could just bump the edition for the Reference
 Guide, which will carry
 a lot of edits to reflect JDBC4. Would that be
 acceptable?
 
 
 
 What does the edition represent? Would this mean
 the first release of
 the 10.2 documentation set would be partially at
 the second edition,
 doesn't seem to make sense to me.
 
 Dan.
   
 
 This is what's troubling me too. From Jean's
 investigations it seems 
 that edition doesn't have a consistent meaning
 across our user guides 
 and releases. We could just remove the edition
 lines. If we leave them 
 in, then it would be good to agree on their meaning.
 Maybe one of the 
 following:
 
 1) The Edition number is bumped whenever we create a
 release branch. We 
 don't bump Edition for point or patch releases.
 
 2) The Edition number is bumped whenever reviewers
 agree that a user 
 guide has changed significantly.
 
 3) The Edition number is the same as the release
 number. All user guides 
 in a given release have identical Edition numbers.
 
 
 


As the person who contributed the DITA-converted
documentation, I can tell you I didn't bump the
edition up based on that.  I believe the pre-DITA
documentation already said Second Edition.  

The thought is that major releases (10.0, 10.1, 10.2)
are First Editions, and subsequent fixpaks are Second,
Third, Fourth editions etc., like 10.1.3 would be.  In
any case, we haven't adhered to any kind of
consistency on this with the guides, so I agree that
we need to define what we feel is an edition and
stick with it or remove it alltogether (although
perhaps there's a legal reason to keep it?)



__
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com 


Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Jean T. Anderson
Jeff Levitt wrote:
snip

 As the person who contributed the DITA-converted
 documentation, I can tell you I didn't bump the
 edition up based on that.  I believe the pre-DITA
 documentation already said Second Edition.  

The pre-DITA (10.0) doc source says First Edition:

https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/getstart/gspr.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/reference/sqlj.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/develop/develop.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/tools/tools.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/admin/hubprnt.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/tuning/perf.ihtml

 The thought is that major releases (10.0, 10.1, 10.2)
 are First Editions, and subsequent fixpaks are Second,
 Third, Fourth editions etc., like 10.1.3 would be.  In
 any case, we haven't adhered to any kind of
 consistency on this with the guides, so I agree that
 we need to define what we feel is an edition and
 stick with it or remove it alltogether (although
 perhaps there's a legal reason to keep it?)

If we don't have a specific use for it, I recommend removing it. I don't
know of any legal reason to have it.

 -jean


Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-22 Thread Rick Hillegas

+1

Regards,
-Rick

Jean T. Anderson wrote:


Jeff Levitt wrote:
snip

 


As the person who contributed the DITA-converted
documentation, I can tell you I didn't bump the
edition up based on that.  I believe the pre-DITA
documentation already said Second Edition.  
   



The pre-DITA (10.0) doc source says First Edition:

https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/getstart/gspr.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/reference/sqlj.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/develop/develop.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/tools/tools.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/admin/hubprnt.ihtml
https://svn.apache.org/repos/asf/db/derby/docs/branches/10.0/src/documentation/content/xdocs/manuals/tuning/perf.ihtml

 


The thought is that major releases (10.0, 10.1, 10.2)
are First Editions, and subsequent fixpaks are Second,
Third, Fourth editions etc., like 10.1.3 would be.  In
any case, we haven't adhered to any kind of
consistency on this with the guides, so I agree that
we need to define what we feel is an edition and
stick with it or remove it alltogether (although
perhaps there's a legal reason to keep it?)
   



If we don't have a specific use for it, I recommend removing it. I don't
know of any legal reason to have it.
 


-jean
 





Copyright format (was Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release)

2006-06-22 Thread Jean T. Anderson
Rick Hillegas (JIRA) wrote:
  [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]
 
 Rick Hillegas updated DERBY-1271:
 -
 
 Attachment: derby-1271_copyrights.diff
 
 Attaching derby-1271_copyrights.diff. This adjusts dates in the visible 
 copyright notices in the user guides. Touches the following files:

regarding the format of the copyright, Rick did what I originally suggested:

 Copyright 1997, 2005-2006 The Apache Software Foundation or its licensors, as 
 applicable.

Looking at this more closely, all that is needed is the origin year and
the year of the most recent update:

   Copyright 1997, 2006 The Apache Software Foundation or its licensors,
as applicable.

 -jean


[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-21 Thread Rick Hillegas (JIRA)
 [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]

Rick Hillegas updated DERBY-1271:
-

Attachment: derby-1271_copyrights.diff

Attaching derby-1271_copyrights.diff. This adjusts dates in the visible 
copyright notices in the user guides. Touches the following files:

M  src\tools\rtoolscopyright.dita
M  src\workingwithderby\rwwdcopyright.dita
M  src\tuning\rtuncopyright.dita
M  src\adminguide\radmincopyright.dita
M  src\devguide\rdevcopyright.dita
M  src\ref\rrefcopyright.dita
M  src\getstart\rgscopyright.dita

 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
  Attachments: derby-1271_copyrights.diff

 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
 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 

Re: [jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-21 Thread Jean T. Anderson
Rick Hillegas (JIRA) wrote:
  [ http://issues.apache.org/jira/browse/DERBY-1271?page=all ]
 
 Rick Hillegas updated DERBY-1271:
 -
 
 Attachment: derby-1271_copyrights.diff
 
 Attaching derby-1271_copyrights.diff. This adjusts dates in the visible 
 copyright notices in the user guides. Touches the following files:
 

The update of the copyright line looks fine to me, but I'm not so sure
about the change of the Second Edition (July 2005) line to Third
Edition (July 2006).

I don't know the Edition history -- suspect it maps to the conversion
of the source docs to DITA. Does anyone know for sure?

 -jean




[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-12 Thread Rick Hillegas (JIRA)
 [ 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

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



Tools Guide

  Using ij
Getting started with ij
  Running ij scripts

You don't need to specify the Derby drivers
on the command line even under JDBC2.

  ij properties reference
ij.dataSource

  This is the DataSource for embedded JDBC3. Note that
  this 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-12 Thread Rick Hillegas (JIRA)
 [ 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

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



Tools Guide

  Using ij
Getting started with ij
  Running ij scripts

You don't need to specify the Derby drivers
on the command line even under JDBC2.

  ij properties reference
ij.dataSource

  This is the DataSource for embedded JDBC3. Note that
  this 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-06-08 Thread Rick Hillegas (JIRA)
 [ 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

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 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-05-12 Thread Rick Hillegas (JIRA)
 [ 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.


  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.




Add analysis of changes we need to make to the Developer's Guide to support 
JDBC4.

 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: 

[jira] Updated: (DERBY-1271) Release documentation for JDBC4 release

2006-05-09 Thread Rick Hillegas (JIRA)
 [ 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.



  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.



Added description of changes needed for the Admin 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.

-- 
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