com.github.susom.database

Interface Options

All Known Implementing Classes:

OptionsDefault, OptionsOverride

public interface Options

Control various optional behavior for the database interactions.

Author:

garricko

Method Summary

Modifier and Type	Method and Description
boolean	allowConnectionAccess() Control whether the Database object will allow calls to underlyingConnection().
boolean	allowTransactionControl() Control whether the Database object will allow calls to commitNow() and rollbackNow().
Calendar	calendarForTimestamps() This calendar will be used for conversions when storing and retrieving timestamps from the database.
Date	currentDate() The value returned by this method will be used for argDateNowPerApp() calls.
Flavor	flavor() Access compatibility information for the underlying database.
String	generateErrorCode() In cases where exceptions are thrown, use this method to provide a common code that will be included in the exception message and the log message so they can be searched and correlated later.
boolean	ignoreTransactionControl() Useful for testing code that explicitly controls transactions, and you don't really want it to commit/rollback.
boolean	isDetailedExceptions() If true, text of the SQL and possibly parameter values (depending on @{#isLogParameters()}) will be included in exception messages.
boolean	isLogParameters() If this is false, log messages will look something like:
int	maxStringLengthParam() The maximum number of characters to print in debug SQL for a given String type query parameter.
boolean	useBytesForBlob() Indicate whether to use the Blob functionality of the underlying database driver, or whether to use setBytes() methods instead.
boolean	useDatePerAppOnly() Wherever argDateNowPerDb() is specified, use argDateNowPerApp() instead.
boolean	useStringForClob() Indicate whether to use the Clob functionality of the underlying database driver, or whether to use setString() methods instead.

Method Detail

allowTransactionControl

boolean allowTransactionControl()

Control whether the Database object will allow calls to commitNow() and rollbackNow(). By default it will throw exceptions if you try to call those.

ignoreTransactionControl

boolean ignoreTransactionControl()

Useful for testing code that explicitly controls transactions, and you don't really want it to commit/rollback. Disabled by default, meaning calls will be allowed or throw exceptions depending on allowTransctionControl(). The value of allowTranscationControl() has no affect if this returns true.

allowConnectionAccess

boolean allowConnectionAccess()

Control whether the Database object will allow calls to underlyingConnection(). By default that method will throw an exception.

isLogParameters

boolean isLogParameters()

If this is false, log messages will look something like:

   ...select a from b where c=?
 

If this is true, log messages will look something like:

   ...select a from b where c=?|select a from b where c='abc'
 

Returns:

true if parameter values should be logged along with SQL, false otherwise

isDetailedExceptions

boolean isDetailedExceptions()

If true, text of the SQL and possibly parameter values (depending on @{#isLogParameters()}) will be included in exception messages. This can be very helpful for debugging, but poses some disclosure risks.

Returns:

true to add possibly sensitive data in exception messages, false otherwise

generateErrorCode

String generateErrorCode()

In cases where exceptions are thrown, use this method to provide a common code that will be included in the exception message and the log message so they can be searched and correlated later.

Returns:

an arbitrary, fairly unique, speakable over the phone, without whitespace

useBytesForBlob

boolean useBytesForBlob()

Indicate whether to use the Blob functionality of the underlying database driver, or whether to use setBytes() methods instead. Using Blobs is preferred, but is not supported by all drivers.

The default behavior of this method is to delegate to flavor().useBytesForBlob(), but it is provided on this interface so the behavior can be controlled.

Returns:

true to avoid using Blob functionality, false otherwise

useStringForClob

boolean useStringForClob()

Indicate whether to use the Clob functionality of the underlying database driver, or whether to use setString() methods instead. Using Clobs is preferred, but is not supported by all drivers.

The default behavior of this method is to delegate to flavor().useStringForClob(), but it is provided on this interface so the behavior can be controlled.

Returns:

true to avoid using Clob functionality, false otherwise

flavor

Flavor flavor()

Access compatibility information for the underlying database. The Flavor class enumerates the known databases and tries to smooth over some of the variations in features and syntax.

currentDate

Date currentDate()

The value returned by this method will be used for argDateNowPerApp() calls. It may also be used for argDateNowPerDb() calls if you have enabled that.

useDatePerAppOnly

boolean useDatePerAppOnly()

Wherever argDateNowPerDb() is specified, use argDateNowPerApp() instead. This is useful for testing purposes as you can use OptionsOverride to provide your own system clock that will be used for time travel.

calendarForTimestamps

Calendar calendarForTimestamps()

This calendar will be used for conversions when storing and retrieving timestamps from the database. By default this is the JVM default with TimeZone explicitly set to GMT (so timestamps will be stored in the database as GMT).

It is strongly recommended to always run your database in GMT timezone, and leave this set to the default.

Behavior in releases 1.3 and prior was to use the JVM default TimeZone, and this was not configurable.

maxStringLengthParam

int maxStringLengthParam()

The maximum number of characters to print in debug SQL for a given String type query parameter. If it exceeds this length the value will be truncated and a "..." will be appended.