Package org.frankframework.dbms

Class GenericDbmsSupport

java.lang.Object

org.frankframework.dbms.GenericDbmsSupport

All Implemented Interfaces:

IDbmsSupport

Direct Known Subclasses:

Db2DbmsSupport, H2DbmsSupport, MsSqlServerDbmsSupport, MySqlDbmsSupport, OracleDbmsSupport, PostgresqlDbmsSupport

public class GenericDbmsSupport
extends Object
implements IDbmsSupport

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	KEYWORD_SELECT
protected org.apache.logging.log4j.Logger	log
protected static Map<String,ISqlTranslator>	sqlTranslators

Constructor Summary

Constructors

Constructor	Description
GenericDbmsSupport()

Method Summary

Modifier and Type	Method	Description
void	applyBlobParameter(PreparedStatement stmt, int column, Object blobInsertHandle)
void	applyClobParameter(PreparedStatement stmt, int column, Object clobHandle)
String	autoIncrementInsertValue(String sequenceName)
boolean	autoIncrementKeyMustBeInserted()
boolean	autoIncrementUsesSequenceObject()
String	convertQuery(String query, String sqlDialectFrom)
protected ISqlTranslator	createTranslator(String source, String target)
protected boolean	doHasIndexOnColumns(Connection conn, String schemaOwner, String tableName, List<String> columns, String indexTableName, String indexColumnTableName, String tableOwnerColumnName, String tableNameColumnName, String indexNameColumnName, String columnNameColumnName, String columPositionColumnName)
protected boolean	doIsColumnPresent(Connection conn, String columnsTable, String schemaColumn, String tableNameColumn, String columnNameColumn, String schemaName, String tableName, String columnName)	Alternative implementation of isColumnPresent(), that can be used by descender classes if the implementation via metadata does not work for that driver.
protected boolean	doIsTablePresent(Connection conn, String tablesTable, String schemaColumn, String tableNameColumn, String schemaName, String tableName)	Alternative implementation of isTablePresent(), that can be used by descender classes if the implementation via metadata does not work for that driver.
String	getAutoIncrementKeyFieldType()
String	getBlobFieldType()
Object	getBlobHandle(PreparedStatement stmt, int column)
Object	getBlobHandle(ResultSet rs, int column)
InputStream	getBlobInputStream(ResultSet rs, int column)
InputStream	getBlobInputStream(ResultSet rs, String column)
OutputStream	getBlobOutputStream(PreparedStatement stmt, int column, Object blobInsertHandle)
OutputStream	getBlobOutputStream(ResultSet rs, int column, Object blobUpdateHandle)
protected OutputStream	getBlobOutputStream(ResultSet rs, Object blobUpdateHandle)
String	getBooleanValue(boolean value)
Object	getClobHandle(PreparedStatement stmt, int column)
Object	getClobHandle(ResultSet rs, int column)
Reader	getClobReader(ResultSet rs, int column)
Reader	getClobReader(ResultSet rs, String column)
Writer	getClobWriter(PreparedStatement stmt, int column, Object clobHandle)
Writer	getClobWriter(ResultSet rs, int column, Object clobHandle)
String	getDateAndOffset(String dateValue, int daysOffset)
String	getDatetimeLiteral(Date date)
Dbms	getDbms()
String	getDbmsName()
protected String	getFormattedDate(Date date)
String	getFromForTablelessSelect()	http://en.wikipedia.org/wiki/DUAL_table
String	getLength(String column)
String	getSchema(Connection conn)
protected ISqlTranslator	getSqlTranslator(String sqlDialectFrom)
String	getSysDate()	SQL String returning current date and time of dbms.
ResultSet	getTableColumns(Connection conn, String tableName)
ResultSet	getTableColumns(Connection conn, String schemaName, String tableName)
ResultSet	getTableColumns(Connection conn, String schemaName, String tableName, String columnNamePattern)
String	getTextFieldType()
String	getTimestampAsDate(String columnName)
String	getTimestampFieldType()
boolean	hasIndexOnColumn(Connection conn, String schemaName, String tableName, String columnName)
boolean	hasIndexOnColumns(Connection conn, String schemaOwner, String tableName, List<String> columns)
boolean	hasSkipLockedFunctionality()
boolean	isBlobType(ResultSetMetaData rsmeta, int colNum)
boolean	isClobType(ResultSetMetaData rsmeta, int colNum)
boolean	isColumnPresent(Connection conn, String tableName, String columnName)
boolean	isColumnPresent(Connection conn, String schemaName, String tableName, String columnName)
boolean	isConstraintViolation(SQLException e)
boolean	isParameterTypeMatchRequired()
protected boolean	isQueryConversionRequired(String sqlDialectFrom)
boolean	isSequencePresent(Connection conn, String schemaOwner, String tableName, String sequenceName)
boolean	isTablePresent(Connection conn, String tableName)
boolean	isTablePresent(Connection conn, String schemaName, String tableName)
String	prepareQueryTextForNonLockingRead(String selectQuery)	Modify the provided selectQuery in such a way that the resulting query will not be blocked by locks, and will avoid placing locks itself as much as possible.
String	prepareQueryTextForWorkQueuePeeking(int batchSize, String selectQuery)
String	prepareQueryTextForWorkQueuePeeking(int batchSize, String selectQuery, int wait)
String	prepareQueryTextForWorkQueueReading(int batchSize, String selectQuery)
String	prepareQueryTextForWorkQueueReading(int batchSize, String selectQuery, int wait)
String	provideFirstRowsHintAfterFirstKeyword(int rowCount)
String	provideIndexHintAfterFirstKeyword(String tableName, String indexName)
String	provideTrailingFirstRowsHint(int rowCount)
protected List<String>	splitQuery(String query)
void	updateBlob(ResultSet rs, int column, Object blobUpdateHandle)
void	updateBlob(ResultSet rs, String column, Object blobUpdateHandle)
void	updateClob(ResultSet rs, int column, Object clobHandle)
void	updateClob(ResultSet rs, String column, Object clobHandle)
protected void	warnConvertQuery(String sqlDialectFrom)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.frankframework.dbms.IDbmsSupport

canFetchStatementParameterMetaData, getCursorSqlType, isRowVersionTimestamp, isStoredProcedureResultSetSupported

Field Details

log

protected org.apache.logging.log4j.Logger log

KEYWORD_SELECT

protected static final String KEYWORD_SELECT

See Also:

• Constant Field Values

sqlTranslators

protected static Map<String,ISqlTranslator> sqlTranslators

Constructor Details

GenericDbmsSupport

public GenericDbmsSupport()

Method Details

getDbmsName

public String getDbmsName()

Specified by:

getDbmsName in interface IDbmsSupport

getDbms

public Dbms getDbms()

Specified by:

getDbms in interface IDbmsSupport

isParameterTypeMatchRequired

public boolean isParameterTypeMatchRequired()

Specified by:

isParameterTypeMatchRequired in interface IDbmsSupport

hasSkipLockedFunctionality

public boolean hasSkipLockedFunctionality()

Specified by:

hasSkipLockedFunctionality in interface IDbmsSupport

getSysDate

public String getSysDate()

Description copied from interface: IDbmsSupport

SQL String returning current date and time of dbms.

Specified by:

getSysDate in interface IDbmsSupport

getDateAndOffset

public String getDateAndOffset(String dateValue,
 int daysOffset)

Specified by:

getDateAndOffset in interface IDbmsSupport

getFromForTablelessSelect

public String getFromForTablelessSelect()

Description copied from interface: IDbmsSupport

http://en.wikipedia.org/wiki/DUAL_table

Specified by:

getFromForTablelessSelect in interface IDbmsSupport

getAutoIncrementKeyFieldType

public String getAutoIncrementKeyFieldType()

Specified by:

getAutoIncrementKeyFieldType in interface IDbmsSupport

autoIncrementKeyMustBeInserted

public boolean autoIncrementKeyMustBeInserted()

Specified by:

autoIncrementKeyMustBeInserted in interface IDbmsSupport

autoIncrementInsertValue

public String autoIncrementInsertValue(String sequenceName)

Specified by:

autoIncrementInsertValue in interface IDbmsSupport

autoIncrementUsesSequenceObject

public boolean autoIncrementUsesSequenceObject()

Specified by:

autoIncrementUsesSequenceObject in interface IDbmsSupport

getTimestampFieldType

public String getTimestampFieldType()

Specified by:

getTimestampFieldType in interface IDbmsSupport

getDatetimeLiteral

public String getDatetimeLiteral(Date date)

Specified by:

getDatetimeLiteral in interface IDbmsSupport

getFormattedDate

protected String getFormattedDate(Date date)

getTimestampAsDate

public String getTimestampAsDate(String columnName)

Specified by:

getTimestampAsDate in interface IDbmsSupport

isClobType

public boolean isClobType(ResultSetMetaData rsmeta,
 int colNum)
                   throws SQLException

Specified by:

isClobType in interface IDbmsSupport

Throws:

SQLException

getClobHandle

public Object getClobHandle(ResultSet rs,
 int column)
                     throws SQLException,
DbmsException

Specified by:

getClobHandle in interface IDbmsSupport

Throws:

SQLException

DbmsException

getClobWriter

public Writer getClobWriter(ResultSet rs,
 int column,
 Object clobHandle)
                     throws SQLException

Specified by:

getClobWriter in interface IDbmsSupport

Throws:

SQLException

updateClob

public void updateClob(ResultSet rs,
 int column,
 Object clobHandle)
                throws SQLException,
DbmsException

Specified by:

updateClob in interface IDbmsSupport

Throws:

SQLException

DbmsException

updateClob

public void updateClob(ResultSet rs,
 String column,
 Object clobHandle)
                throws SQLException,
DbmsException

Specified by:

updateClob in interface IDbmsSupport

Throws:

SQLException

DbmsException

getClobHandle

public Object getClobHandle(PreparedStatement stmt,
 int column)
                     throws SQLException,
DbmsException

Specified by:

getClobHandle in interface IDbmsSupport

Throws:

SQLException

DbmsException

getClobWriter

public Writer getClobWriter(PreparedStatement stmt,
 int column,
 Object clobHandle)
                     throws SQLException

Specified by:

getClobWriter in interface IDbmsSupport

Throws:

SQLException

applyClobParameter

public void applyClobParameter(PreparedStatement stmt,
 int column,
 Object clobHandle)
                        throws SQLException

Specified by:

applyClobParameter in interface IDbmsSupport

Throws:

SQLException

getClobReader

public Reader getClobReader(ResultSet rs,
 int column)
                     throws SQLException

Specified by:

getClobReader in interface IDbmsSupport

Throws:

SQLException

getClobReader

public Reader getClobReader(ResultSet rs,
 String column)
                     throws SQLException

Specified by:

getClobReader in interface IDbmsSupport

Throws:

SQLException

getBlobFieldType

public String getBlobFieldType()

Specified by:

getBlobFieldType in interface IDbmsSupport

isBlobType

public boolean isBlobType(ResultSetMetaData rsmeta,
 int colNum)
                   throws SQLException

Specified by:

isBlobType in interface IDbmsSupport

Throws:

SQLException

getBlobHandle

public Object getBlobHandle(ResultSet rs,
 int column)
                     throws SQLException,
DbmsException

Specified by:

getBlobHandle in interface IDbmsSupport

Throws:

SQLException

DbmsException

getBlobOutputStream

protected OutputStream getBlobOutputStream(ResultSet rs,
 Object blobUpdateHandle)
                                    throws SQLException

Throws:

SQLException

getBlobOutputStream

public OutputStream getBlobOutputStream(ResultSet rs,
 int column,
 Object blobUpdateHandle)
                                 throws SQLException,
DbmsException

Specified by:

getBlobOutputStream in interface IDbmsSupport

Throws:

SQLException

DbmsException

updateBlob

public void updateBlob(ResultSet rs,
 int column,
 Object blobUpdateHandle)
                throws SQLException,
DbmsException

Specified by:

updateBlob in interface IDbmsSupport

Throws:

SQLException

DbmsException

updateBlob

public void updateBlob(ResultSet rs,
 String column,
 Object blobUpdateHandle)
                throws SQLException,
DbmsException

Specified by:

updateBlob in interface IDbmsSupport

Throws:

SQLException

DbmsException

getBlobHandle

public Object getBlobHandle(PreparedStatement stmt,
 int column)
                     throws SQLException,
DbmsException

Specified by:

getBlobHandle in interface IDbmsSupport

Throws:

SQLException

DbmsException

getBlobOutputStream

public OutputStream getBlobOutputStream(PreparedStatement stmt,
 int column,
 Object blobInsertHandle)
                                 throws SQLException

Specified by:

getBlobOutputStream in interface IDbmsSupport

Throws:

SQLException

applyBlobParameter

public void applyBlobParameter(PreparedStatement stmt,
 int column,
 Object blobInsertHandle)
                        throws SQLException

Specified by:

applyBlobParameter in interface IDbmsSupport

Throws:

SQLException

getBlobInputStream

public InputStream getBlobInputStream(ResultSet rs,
 int column)
                               throws SQLException

Specified by:

getBlobInputStream in interface IDbmsSupport

Throws:

SQLException

getBlobInputStream

public InputStream getBlobInputStream(ResultSet rs,
 String column)
                               throws SQLException

Specified by:

getBlobInputStream in interface IDbmsSupport

Throws:

SQLException

getTextFieldType

public String getTextFieldType()

Specified by:

getTextFieldType in interface IDbmsSupport

prepareQueryTextForWorkQueueReading

public String prepareQueryTextForWorkQueueReading(int batchSize,
 String selectQuery)
                                           throws DbmsException

Specified by:

prepareQueryTextForWorkQueueReading in interface IDbmsSupport

Throws:

DbmsException

prepareQueryTextForWorkQueueReading

public String prepareQueryTextForWorkQueueReading(int batchSize,
 String selectQuery,
 int wait)
                                           throws DbmsException

Specified by:

prepareQueryTextForWorkQueueReading in interface IDbmsSupport

Throws:

DbmsException

prepareQueryTextForWorkQueuePeeking

public String prepareQueryTextForWorkQueuePeeking(int batchSize,
 String selectQuery)
                                           throws DbmsException

Specified by:

prepareQueryTextForWorkQueuePeeking in interface IDbmsSupport

Throws:

DbmsException

prepareQueryTextForWorkQueuePeeking

public String prepareQueryTextForWorkQueuePeeking(int batchSize,
 String selectQuery,
 int wait)
                                           throws DbmsException

Specified by:

prepareQueryTextForWorkQueuePeeking in interface IDbmsSupport

Throws:

DbmsException

prepareQueryTextForNonLockingRead

public String prepareQueryTextForNonLockingRead(String selectQuery)
                                         throws DbmsException

Description copied from interface: IDbmsSupport

Modify the provided selectQuery in such a way that the resulting query will not be blocked by locks, and will avoid placing locks itself as much as possible. Preferably, the effective isolation level is READ_COMMITTED (committed rows of other transactions may be read), but if placing locks can be avoided by an isolation level similar to READ_UNCOMMITTED, that is allowed too. Should return the query unmodified if no special action is required. For an example, see MsSqlServerDbmsSupport.prepareQueryTextForNonLockingRead(String)

Specified by:

prepareQueryTextForNonLockingRead in interface IDbmsSupport

Throws:

DbmsException

provideIndexHintAfterFirstKeyword

public String provideIndexHintAfterFirstKeyword(String tableName,
 String indexName)

Specified by:

provideIndexHintAfterFirstKeyword in interface IDbmsSupport

provideFirstRowsHintAfterFirstKeyword

public String provideFirstRowsHintAfterFirstKeyword(int rowCount)

Specified by:

provideFirstRowsHintAfterFirstKeyword in interface IDbmsSupport

provideTrailingFirstRowsHint

public String provideTrailingFirstRowsHint(int rowCount)

Specified by:

provideTrailingFirstRowsHint in interface IDbmsSupport

getSchema

public String getSchema(Connection conn)
                 throws DbmsException

Specified by:

getSchema in interface IDbmsSupport

Throws:

DbmsException

getTableColumns

public ResultSet getTableColumns(Connection conn,
 String tableName)
                          throws DbmsException

Specified by:

getTableColumns in interface IDbmsSupport

Throws:

DbmsException

getTableColumns

public ResultSet getTableColumns(Connection conn,
 String schemaName,
 String tableName)
                          throws DbmsException

Specified by:

getTableColumns in interface IDbmsSupport

Throws:

DbmsException

getTableColumns

public ResultSet getTableColumns(Connection conn,
 String schemaName,
 String tableName,
 String columnNamePattern)
                          throws DbmsException

Specified by:

getTableColumns in interface IDbmsSupport

Throws:

DbmsException

isTablePresent

public boolean isTablePresent(Connection conn,
 String tableName)
                       throws DbmsException

Specified by:

isTablePresent in interface IDbmsSupport

Throws:

DbmsException

isTablePresent

public boolean isTablePresent(Connection conn,
 String schemaName,
 String tableName)
                       throws DbmsException

Specified by:

isTablePresent in interface IDbmsSupport

Throws:

DbmsException

isColumnPresent

public boolean isColumnPresent(Connection conn,
 String tableName,
 String columnName)
                        throws DbmsException

Specified by:

isColumnPresent in interface IDbmsSupport

Throws:

DbmsException

isColumnPresent

public boolean isColumnPresent(Connection conn,
 String schemaName,
 String tableName,
 String columnName)
                        throws DbmsException

Specified by:

isColumnPresent in interface IDbmsSupport

Throws:

DbmsException

hasIndexOnColumn

public boolean hasIndexOnColumn(Connection conn,
 String schemaName,
 String tableName,
 String columnName)
                         throws DbmsException

Specified by:

hasIndexOnColumn in interface IDbmsSupport

Throws:

DbmsException

doHasIndexOnColumns

protected boolean doHasIndexOnColumns(Connection conn,
 String schemaOwner,
 String tableName,
 List<String> columns,
 String indexTableName,
 String indexColumnTableName,
 String tableOwnerColumnName,
 String tableNameColumnName,
 String indexNameColumnName,
 String columnNameColumnName,
 String columPositionColumnName)

doIsTablePresent

protected boolean doIsTablePresent(Connection conn,
 String tablesTable,
 String schemaColumn,
 String tableNameColumn,
 String schemaName,
 String tableName)
                            throws DbmsException

Alternative implementation of isTablePresent(), that can be used by descender classes if the implementation via metadata does not work for that driver.

Throws:

DbmsException

doIsColumnPresent

protected boolean doIsColumnPresent(Connection conn,
 String columnsTable,
 String schemaColumn,
 String tableNameColumn,
 String columnNameColumn,
 String schemaName,
 String tableName,
 String columnName)
                             throws DbmsException

Alternative implementation of isColumnPresent(), that can be used by descender classes if the implementation via metadata does not work for that driver.

Throws:

DbmsException

isSequencePresent

public boolean isSequencePresent(Connection conn,
 String schemaOwner,
 String tableName,
 String sequenceName)

Specified by:

isSequencePresent in interface IDbmsSupport

hasIndexOnColumns

public boolean hasIndexOnColumns(Connection conn,
 String schemaOwner,
 String tableName,
 List<String> columns)
                          throws DbmsException

Specified by:

hasIndexOnColumns in interface IDbmsSupport

Throws:

DbmsException

isConstraintViolation

public boolean isConstraintViolation(SQLException e)

Specified by:

isConstraintViolation in interface IDbmsSupport

getLength

public String getLength(String column)

Specified by:

getLength in interface IDbmsSupport

getBooleanValue

public String getBooleanValue(boolean value)

Specified by:

getBooleanValue in interface IDbmsSupport

createTranslator

protected ISqlTranslator createTranslator(String source,
 String target)
                                   throws DbmsException

Throws:

DbmsException

getSqlTranslator

@Nullable
protected ISqlTranslator getSqlTranslator(@Nonnull
 String sqlDialectFrom)
                                   throws DbmsException

Throws:

DbmsException

convertQuery

@Nonnull
public String convertQuery(@Nonnull
 String query,
 @Nonnull
 String sqlDialectFrom)
                    throws SQLException,
DbmsException

Specified by:

convertQuery in interface IDbmsSupport

Throws:

SQLException

DbmsException

warnConvertQuery

protected void warnConvertQuery(String sqlDialectFrom)

isQueryConversionRequired

protected boolean isQueryConversionRequired(String sqlDialectFrom)

splitQuery

protected List<String> splitQuery(String query)