Documentation needed for connection URL attribute retrieveMessageText
---------------------------------------------------------------------
Key: DERBY-5191
URL: https://issues.apache.org/jira/browse/DERBY-5191
Project: Derby
Issue Type: Bug
Components: Documentation
Affects Versions: 10.7.1.1
Reporter: Kim Haase
Priority: Minor
The connection URL attribute retrieveMessageText, mentioned in the Admin Guide
in the topic "Accessing the Network Server by using the network client driver
(cadminappsclient.dita), is not documented in the Reference Manual but should
be.
I can't find any javadoc comments on this attribute in the implementation code
in java/client/org/apache/derby/jdbc/ClientBaseDataSource.java or
client/org/apache/derby/client/am/Connection.java.
The Admin Guide just says the following, noting that the default setting is
true:
"Retrieve message text from the server. A stored procedure is called to
retrieve the message text with each SQLException and might start a new unit of
work. Set this property to false if you do not want the performance impact or
when starting new units of work."
This last sentence is confusing. Seems like it should be something like "Set
this property to false if you do not want the performance impact or do not want
to start a new unit of work." Does that make more sense?
I know the attribute is client-specific.
Must it be combined with any other attributes, or are there some that it must
NOT be combined with?
What else needs to be said?
I'll pick this up if someone can clear up these few points.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
