Package org.frankframework.dbms

Interface IDbmsSupport

All Known Implementing Classes:

Db2DbmsSupport, GenericDbmsSupport, H2DbmsSupport, MariaDbDbmsSupport, MsSqlServerDbmsSupport, MySqlDbmsSupport, OracleDbmsSupport, PostgresqlDbmsSupport

public interface IDbmsSupport

Interface to define DBMS specific SQL implementations.

Since:

Author:

Gerrit van Brakel

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()
default boolean	canFetchStatementParameterMetaData()
String	convertQuery(String query, String sqlDialectFrom)
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 blobHandle)
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)
default SQLType	getCursorSqlType()
String	getDateAndOffset(String dateValue, int daysOffset)
String	getDatetimeLiteral(Date date)
Dbms	getDbms()
default String	getDbmsName()
String	getFromForTablelessSelect()	http://en.wikipedia.org/wiki/DUAL_table
String	getLength(String column)
String	getSchema(Connection conn)
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 schemaOwner, 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()
default boolean	isRowVersionTimestamp(ResultSetMetaData resultSetMetaData, int columnNumber)
boolean	isSequencePresent(Connection conn, String schemaOwner, String tableName, String sequenceName)
default boolean	isStoredProcedureResultSetSupported()	DBMS Feature flag: is it possible to call a stored procedure that returns the results of a SELECT statement directly, without needing a REFCURSOR OUT parameter.
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)
void	updateBlob(ResultSet rs, int column, Object blobHandle)
void	updateBlob(ResultSet rs, String column, Object blobHandle)
void	updateClob(ResultSet rs, int column, Object clobHandle)
void	updateClob(ResultSet rs, String column, Object clobHandle)

Method Details

getDbms

Dbms getDbms()

getDbmsName

default String getDbmsName()

isParameterTypeMatchRequired

boolean isParameterTypeMatchRequired()

hasSkipLockedFunctionality

boolean hasSkipLockedFunctionality()

getSysDate

String getSysDate()

SQL String returning current date and time of dbms.

getDateAndOffset

String getDateAndOffset(String dateValue,
 int daysOffset)

getFromForTablelessSelect

String getFromForTablelessSelect()

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

getAutoIncrementKeyFieldType

String getAutoIncrementKeyFieldType()

autoIncrementKeyMustBeInserted

boolean autoIncrementKeyMustBeInserted()

autoIncrementInsertValue

String autoIncrementInsertValue(String sequenceName)

autoIncrementUsesSequenceObject

boolean autoIncrementUsesSequenceObject()

getTimestampFieldType

String getTimestampFieldType()

getDatetimeLiteral

String getDatetimeLiteral(Date date)

getTimestampAsDate

String getTimestampAsDate(String columnName)

isClobType

boolean isClobType(ResultSetMetaData rsmeta,
 int colNum)
            throws SQLException

Throws:

SQLException

getClobReader

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

Throws:

SQLException

DbmsException

getClobReader

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

Throws:

SQLException

DbmsException

getClobHandle

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

Throws:

SQLException

DbmsException

getClobWriter

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

Throws:

SQLException

DbmsException

updateClob

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

Throws:

SQLException

DbmsException

updateClob

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

Throws:

SQLException

DbmsException

getClobHandle

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

Throws:

SQLException

DbmsException

getClobWriter

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

Throws:

SQLException

DbmsException

applyClobParameter

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

Throws:

SQLException

DbmsException

getBlobFieldType

String getBlobFieldType()

isBlobType

boolean isBlobType(ResultSetMetaData rsmeta,
 int colNum)
            throws SQLException

Throws:

SQLException

getBlobInputStream

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

Throws:

SQLException

DbmsException

getBlobInputStream

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

Throws:

SQLException

DbmsException

getBlobHandle

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

Throws:

SQLException

DbmsException

getBlobOutputStream

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

Throws:

SQLException

DbmsException

updateBlob

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

Throws:

SQLException

DbmsException

updateBlob

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

Throws:

SQLException

DbmsException

getBlobHandle

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

Throws:

SQLException

DbmsException

getBlobOutputStream

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

Throws:

SQLException

DbmsException

applyBlobParameter

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

Throws:

SQLException

DbmsException

getTextFieldType

String getTextFieldType()

prepareQueryTextForWorkQueueReading

String prepareQueryTextForWorkQueueReading(int batchSize,
 String selectQuery)
                                    throws DbmsException

Throws:

DbmsException

prepareQueryTextForWorkQueueReading

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

Throws:

DbmsException

prepareQueryTextForWorkQueuePeeking

String prepareQueryTextForWorkQueuePeeking(int batchSize,
 String selectQuery)
                                    throws DbmsException

Throws:

DbmsException

prepareQueryTextForWorkQueuePeeking

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

Throws:

DbmsException

prepareQueryTextForNonLockingRead

String prepareQueryTextForNonLockingRead(String selectQuery)
                                  throws DbmsException

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)

Throws:

DbmsException

provideIndexHintAfterFirstKeyword

String provideIndexHintAfterFirstKeyword(String tableName,
 String indexName)

provideFirstRowsHintAfterFirstKeyword

String provideFirstRowsHintAfterFirstKeyword(int rowCount)

provideTrailingFirstRowsHint

String provideTrailingFirstRowsHint(int rowCount)

getSchema

String getSchema(Connection conn)
          throws DbmsException

Throws:

DbmsException

convertQuery

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

Throws:

SQLException

DbmsException

getTableColumns

ResultSet getTableColumns(Connection conn,
 String tableName)
                   throws DbmsException

Throws:

DbmsException

getTableColumns

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

Throws:

DbmsException

getTableColumns

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

Throws:

DbmsException

isTablePresent

boolean isTablePresent(Connection conn,
 String tableName)
                throws DbmsException

Throws:

DbmsException

isTablePresent

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

Throws:

DbmsException

isColumnPresent

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

Throws:

DbmsException

isColumnPresent

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

Throws:

DbmsException

isSequencePresent

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

hasIndexOnColumn

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

Throws:

DbmsException

hasIndexOnColumns

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

Throws:

DbmsException

isConstraintViolation

boolean isConstraintViolation(SQLException e)

getLength

String getLength(String column)

getBooleanValue

String getBooleanValue(boolean value)

isStoredProcedureResultSetSupported

default boolean isStoredProcedureResultSetSupported()

DBMS Feature flag: is it possible to call a stored procedure that returns the results of a SELECT statement directly, without needing a REFCURSOR OUT parameter.

Returns:

true for database that can directly return SELECT results. Not supported for PostgreSQL and Oracle.

getCursorSqlType

default SQLType getCursorSqlType()

canFetchStatementParameterMetaData

default boolean canFetchStatementParameterMetaData()

isRowVersionTimestamp

default boolean isRowVersionTimestamp(ResultSetMetaData resultSetMetaData,
 int columnNumber)
                               throws SQLException

Parameters:

resultSetMetaData -

columnNumber -

Returns:

whether the columnNumber metadata is defined as a RowVersion/Timestamp (MSSQL - specific, see MsSqlServerDbmsSupport).

Throws:

SQLException