nl.nn.adapterframework.jdbc.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 and 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	emptyBlobValue()
String	emptyClobValue()
String	getAutoIncrementKeyFieldType()
String	getBlobFieldType()
Object	getBlobHandle(PreparedStatement stmt, int column)
Object	getBlobHandle(ResultSet rs, int column)
Object	getBlobHandle(ResultSet rs, String 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)
OutputStream	getBlobOutputStream(ResultSet rs, String column, Object blobHandle)
String	getBooleanFieldType()
String	getBooleanValue(boolean value)
String	getCleanUpIbisstoreQuery(String tableName, String keyField, String typeField, String expiryDateField, int maxRows)
String	getClobFieldType()
Object	getClobHandle(PreparedStatement stmt, int column)
Object	getClobHandle(ResultSet rs, int column)
Object	getClobHandle(ResultSet rs, String 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)
Writer	getClobWriter(ResultSet rs, String column, Object clobHandle)
String	getDateAndOffset(String dateValue, int daysOffset)
String	getDatetimeLiteral(Date date)
Dbms	getDbms() Numeric value defining database type, defined in DbmsSupportFactory.
String	getDbmsName()
String	getFirstRecordQuery(String tableName)
String	getFromForTablelessSelect() http://en.wikipedia.org/wiki/DUAL_table
String	getIbisStoreSummaryQuery()
String	getInsertedAutoIncrementValueQuery(String sequenceName)
String	getLength(String column)
String	getNumericKeyFieldType()
String	getRowNumber(String order, String sort)
String	getRowNumberShortName()
String	getSchema(Connection conn)
String	getSchemaOwner(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()
String	getUpdateBlobQuery(String table, String clobField, String keyField)
String	getUpdateClobQuery(String table, String clobField, String keyField)
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	isIndexPresent(Connection conn, String schemaOwner, String tableName, String indexName)
boolean	isParameterTypeMatchRequired()
boolean	isSequencePresent(Connection conn, String schemaOwner, String tableName, String sequenceName)
boolean	isStoredProcedureOutParametersSupported() DBMS Feature flag: are OUT parameters for stored procedures supported? Can only be true if isStoredProceduresSupported() is true.
default boolean	isStoredProcedureRefCursorOutParameterSupported() DBMS Feature flag: is it possible to return a DB CURSOR in an OUT parameter, as a means to return results of a SELECT statement.
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.
default boolean	isStoredProceduresSupported() DBMS Feature flag: are stored procedures supported?
boolean	isTablePresent(Connection conn, String tableName)
boolean	isTablePresent(Connection conn, String schemaName, String tableName)
boolean	mustInsertEmptyBlobBeforeData()
boolean	mustInsertEmptyClobBeforeData()
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 Detail

getDbms

Dbms getDbms()

Numeric value defining database type, defined in DbmsSupportFactory.

getDbmsName

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)

getNumericKeyFieldType

String getNumericKeyFieldType()

getFromForTablelessSelect

String getFromForTablelessSelect()

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

getAutoIncrementKeyFieldType

String getAutoIncrementKeyFieldType()

autoIncrementKeyMustBeInserted

boolean autoIncrementKeyMustBeInserted()

autoIncrementInsertValue

String autoIncrementInsertValue(String sequenceName)

autoIncrementUsesSequenceObject

boolean autoIncrementUsesSequenceObject()

getInsertedAutoIncrementValueQuery

String getInsertedAutoIncrementValueQuery(String sequenceName)

getTimestampFieldType

String getTimestampFieldType()

getDatetimeLiteral

String getDatetimeLiteral(Date date)

getTimestampAsDate

String getTimestampAsDate(String columnName)

getClobFieldType

String getClobFieldType()

isClobType

boolean isClobType(ResultSetMetaData rsmeta,
                   int colNum)
            throws SQLException

Throws:

SQLException

mustInsertEmptyClobBeforeData

boolean mustInsertEmptyClobBeforeData()

emptyClobValue

String emptyClobValue()

getClobReader

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

Throws:

SQLException

JdbcException

getClobReader

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

Throws:

SQLException

JdbcException

getUpdateClobQuery

String getUpdateClobQuery(String table,
                          String clobField,
                          String keyField)

getClobHandle

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

Throws:

SQLException

JdbcException

getClobHandle

Object getClobHandle(ResultSet rs,
                     String column)
              throws SQLException,
                     JdbcException

Throws:

SQLException

JdbcException

getClobWriter

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

Throws:

SQLException

JdbcException

getClobWriter

Writer getClobWriter(ResultSet rs,
                     String column,
                     Object clobHandle)
              throws SQLException,
                     JdbcException

Throws:

SQLException

JdbcException

updateClob

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

Throws:

SQLException

JdbcException

updateClob

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

Throws:

SQLException

JdbcException

getClobHandle

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

Throws:

SQLException

JdbcException

getClobWriter

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

Throws:

SQLException

JdbcException

applyClobParameter

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

Throws:

SQLException

JdbcException

getBlobFieldType

String getBlobFieldType()

isBlobType

boolean isBlobType(ResultSetMetaData rsmeta,
                   int colNum)
            throws SQLException

Throws:

SQLException

mustInsertEmptyBlobBeforeData

boolean mustInsertEmptyBlobBeforeData()

emptyBlobValue

String emptyBlobValue()

getBlobInputStream

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

Throws:

SQLException

JdbcException

getBlobInputStream

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

Throws:

SQLException

JdbcException

getUpdateBlobQuery

String getUpdateBlobQuery(String table,
                          String clobField,
                          String keyField)

getBlobHandle

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

Throws:

SQLException

JdbcException

getBlobHandle

Object getBlobHandle(ResultSet rs,
                     String column)
              throws SQLException,
                     JdbcException

Throws:

SQLException

JdbcException

getBlobOutputStream

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

Throws:

SQLException

JdbcException

getBlobOutputStream

OutputStream getBlobOutputStream(ResultSet rs,
                                 String column,
                                 Object blobHandle)
                          throws SQLException,
                                 JdbcException

Throws:

SQLException

JdbcException

updateBlob

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

Throws:

SQLException

JdbcException

updateBlob

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

Throws:

SQLException

JdbcException

getBlobHandle

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

Throws:

SQLException

JdbcException

getBlobOutputStream

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

Throws:

SQLException

JdbcException

applyBlobParameter

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

Throws:

SQLException

JdbcException

getTextFieldType

String getTextFieldType()

prepareQueryTextForWorkQueueReading

String prepareQueryTextForWorkQueueReading(int batchSize,
                                           String selectQuery)
                                    throws JdbcException

Throws:

JdbcException

prepareQueryTextForWorkQueueReading

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

Throws:

JdbcException

prepareQueryTextForWorkQueuePeeking

String prepareQueryTextForWorkQueuePeeking(int batchSize,
                                           String selectQuery)
                                    throws JdbcException

Throws:

JdbcException

prepareQueryTextForWorkQueuePeeking

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

Throws:

JdbcException

getFirstRecordQuery

String getFirstRecordQuery(String tableName)
                    throws JdbcException

Throws:

JdbcException

prepareQueryTextForNonLockingRead

String prepareQueryTextForNonLockingRead(String selectQuery)
                                  throws JdbcException

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:

JdbcException

provideIndexHintAfterFirstKeyword

String provideIndexHintAfterFirstKeyword(String tableName,
                                         String indexName)

provideFirstRowsHintAfterFirstKeyword

String provideFirstRowsHintAfterFirstKeyword(int rowCount)

provideTrailingFirstRowsHint

String provideTrailingFirstRowsHint(int rowCount)

getSchema

String getSchema(Connection conn)
          throws JdbcException

Throws:

JdbcException

convertQuery

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

Throws:

SQLException

JdbcException

getTableColumns

ResultSet getTableColumns(Connection conn,
                          String tableName)
                   throws JdbcException

Throws:

JdbcException

getTableColumns

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

Throws:

JdbcException

getTableColumns

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

Throws:

JdbcException

isTablePresent

boolean isTablePresent(Connection conn,
                       String tableName)
                throws JdbcException

Throws:

JdbcException

isTablePresent

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

Throws:

JdbcException

isColumnPresent

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

Throws:

JdbcException

isColumnPresent

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

Throws:

JdbcException

isIndexPresent

boolean isIndexPresent(Connection conn,
                       String schemaOwner,
                       String tableName,
                       String indexName)

isSequencePresent

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

hasIndexOnColumn

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

Throws:

JdbcException

hasIndexOnColumns

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

Throws:

JdbcException

getSchemaOwner

String getSchemaOwner(Connection conn)
               throws SQLException,
                      JdbcException

Throws:

SQLException

JdbcException

isConstraintViolation

boolean isConstraintViolation(SQLException e)

getRowNumber

String getRowNumber(String order,
                    String sort)

getRowNumberShortName

String getRowNumberShortName()

getLength

String getLength(String column)

getIbisStoreSummaryQuery

String getIbisStoreSummaryQuery()

getBooleanFieldType

String getBooleanFieldType()

getBooleanValue

String getBooleanValue(boolean value)

getCleanUpIbisstoreQuery

String getCleanUpIbisstoreQuery(String tableName,
                                String keyField,
                                String typeField,
                                String expiryDateField,
                                int maxRows)

isStoredProceduresSupported

default boolean isStoredProceduresSupported()

DBMS Feature flag: are stored procedures supported?

Returns:

true if stored procedures are supported, false otherwise. All databases are supported except for now H2.

isStoredProcedureOutParametersSupported

boolean isStoredProcedureOutParametersSupported()

DBMS Feature flag: are OUT parameters for stored procedures supported? Can only be true if isStoredProceduresSupported() is true.

Returns:

true if you can use stored procedures with OUT parameters with this database. H2 does not support this by design. Oracle does not currently support this.

isStoredProcedureResultSetSupported

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.

isStoredProcedureRefCursorOutParameterSupported

default boolean isStoredProcedureRefCursorOutParameterSupported()

DBMS Feature flag: is it possible to return a DB CURSOR in an OUT parameter, as a means to return results of a SELECT statement.
Currently, not yet supported on any database, planned for future for PostgreSQL and Oracle.

Returns:

false for all databases currently. Future support planned for Oracle and PostgreSQL.

canFetchStatementParameterMetaData

default boolean canFetchStatementParameterMetaData()