[DERBY-5191] Documentation needed for connection URL attribute retrieveMessageText

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 10.7.1.1, 10.8.1.2
• Fix Version/s: 10.8.2.2, 10.9.1.0
• Component/s: Documentation
• Assignee: Camilla Haase
• Reporter: Camilla Haase
• Created: 14/Apr/11 17:45
• Updated: 25/Oct/11 17:09
• Resolved: 05/May/11 14:59

Description

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.

Issue Links

• is related to: DERBY-159 When Derby runs in Network Server mode, client does not receive warnings generated by Derby - should get documented