Package com.ibm.fhir.database.utils.db2

Class Db2Translator

java.lang.Object

com.ibm.fhir.database.utils.db2.Db2Translator

All Implemented Interfaces:

IDatabaseTranslator

public class Db2Translator
extends Object
implements IDatabaseTranslator

Handles translation of statements/fragments etc specific to DB2

Constructor Summary

Constructors

Constructor	Description
Db2Translator()

Method Summary

Modifier and Type	Method	Description
String	addForUpdate(String sql)	Append FOR UPDATE/FOR UPDATE WITH RS depending on the target DB type
boolean	clobSupportsInline()	Does the database support inlining for clobs
String	createGlobalTempTable(String ddl)
String	createSequence(String name, int cache)	Craft the DDL for a CREATE SEQUENCE statement
String	currentTimestampString()	Get the "CURRENT TIMESTAMP" string for the database type
String	dropForeignKeyConstraint(String qualifiedTableName, String constraintName)	Generate the DDL for dropping the named FK constraint from the given table
String	dualTableName()	The name of the "DUAL" table...that special table giving us one row/column.
void	fillProperties(Properties p, ConnectionDetails cd)	Configure the properties using information from the ConnectionDetails
String	getDriverClassName()	Get the driver class to use for connections
DbType	getType()	The main type of the database
String	getUrl(Properties connectionProperties)	Get the JDBC connection URL based on the properties
String	globalTempTableName(String tableName)	Get the proper table name based on the type of database we are connected to.
boolean	isAlreadyExists(SQLException x)	Check the exception to see if it is reporting that THE NAME OF THE OBJECT TO BE CREATED OR THE TARGET OF A RENAME STATEMENT IS IDENTICAL TO THE EXISTING NAME OF THE OBJECT TYPE
boolean	isBadTenantKeyError(SQLException x)
boolean	isBadTenantNameError(SQLException x)
boolean	isConnectionError(SQLException x)	Returns true if the exception represents a connection error
boolean	isDatabaseNotReady(SQLException x)
boolean	isDeadlock(SQLException x)	Was this statement the victim of a deadlock
boolean	isDerby()	Are we working with a Derby database
boolean	isDuplicate(SQLException x)	Check the exception to see if it is reporting a duplicate value constraint violation
boolean	isLockTimeout(SQLException x)	Database timed out waiting to get a lock.
boolean	isTenantFrozenError(SQLException x)
boolean	isUndefinedName(SQLException x)	Returns true if the SQLException is indicating an object is undefined (e.g.
String	limit(String arg)	Get the correct LIMIT/FETCH NEXT ROWS clause for the database
String	nextValue(String schemaName, String sequenceName)	Statement for getting the next value (for use in a select list or insert values)
String	pagination(int offset, int rowsPerPage)	Construct a pagination clause specific to the type of database
String	reorgTableCommand(String tableName)	Return the REORG TABLE command if supported, or null otherwise
String	selectSequenceNextValue(String schemaName, String sequenceName)	Compose a select statement to obtain the next value from the named sequence
String	timestampDiff(String left, String right, String alias)	Returns an expression which computes the timestamp difference between left and right in seconds
DataAccessException	translate(SQLException x)	Get an appropriate instance of ReplicatorException to throw depending on the details of SQLException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.fhir.database.utils.api.IDatabaseTranslator

isIndexUseSchemaPrefix

Constructor Detail

Db2Translator

public Db2Translator()

Method Detail

addForUpdate

public String addForUpdate(String sql)

Description copied from interface: IDatabaseTranslator

Append FOR UPDATE/FOR UPDATE WITH RS depending on the target DB type

Specified by:

addForUpdate in interface IDatabaseTranslator

Returns:

isDerby

public boolean isDerby()

Description copied from interface: IDatabaseTranslator

Are we working with a Derby database

Specified by:

isDerby in interface IDatabaseTranslator

Returns:

globalTempTableName

public String globalTempTableName(String tableName)

Description copied from interface: IDatabaseTranslator

Get the proper table name based on the type of database we are connected to. Derby has its own handling of temp tables

Specified by:

globalTempTableName in interface IDatabaseTranslator

Returns:

createGlobalTempTable

public String createGlobalTempTable(String ddl)

Specified by:

createGlobalTempTable in interface IDatabaseTranslator

Returns:

isDuplicate

public boolean isDuplicate(SQLException x)

Description copied from interface: IDatabaseTranslator

Check the exception to see if it is reporting a duplicate value constraint violation

Specified by:

isDuplicate in interface IDatabaseTranslator

Returns:

isAlreadyExists

public boolean isAlreadyExists(SQLException x)

Description copied from interface: IDatabaseTranslator

Check the exception to see if it is reporting that THE NAME OF THE OBJECT TO BE CREATED OR THE TARGET OF A RENAME STATEMENT IS IDENTICAL TO THE EXISTING NAME OF THE OBJECT TYPE

Specified by:

isAlreadyExists in interface IDatabaseTranslator

Returns:

isLockTimeout

public boolean isLockTimeout(SQLException x)

Description copied from interface: IDatabaseTranslator

Database timed out waiting to get a lock. This is not the same as a deadlock, of course

Specified by:

isLockTimeout in interface IDatabaseTranslator

Returns:

isDeadlock

public boolean isDeadlock(SQLException x)

Description copied from interface: IDatabaseTranslator

Was this statement the victim of a deadlock

Specified by:

isDeadlock in interface IDatabaseTranslator

Returns:

isConnectionError

public boolean isConnectionError(SQLException x)

Description copied from interface: IDatabaseTranslator

Returns true if the exception represents a connection error

Specified by:

isConnectionError in interface IDatabaseTranslator

Returns:

translate

public DataAccessException translate(SQLException x)

Description copied from interface: IDatabaseTranslator

Get an appropriate instance of ReplicatorException to throw depending on the details of SQLException

Specified by:

translate in interface IDatabaseTranslator

Returns:

isDatabaseNotReady

public boolean isDatabaseNotReady(SQLException x)

isTenantFrozenError

public boolean isTenantFrozenError(SQLException x)

isBadTenantKeyError

public boolean isBadTenantKeyError(SQLException x)

isBadTenantNameError

public boolean isBadTenantNameError(SQLException x)

isUndefinedName

public boolean isUndefinedName(SQLException x)

Description copied from interface: IDatabaseTranslator

Returns true if the SQLException is indicating an object is undefined (e.g. "DROP TABLE foo.bar", where table "foo.bar" doesn't exist)

Specified by:

isUndefinedName in interface IDatabaseTranslator

Returns:

fillProperties

public void fillProperties(Properties p,
                           ConnectionDetails cd)

Description copied from interface: IDatabaseTranslator

Configure the properties using information from the ConnectionDetails

Specified by:

fillProperties in interface IDatabaseTranslator

timestampDiff

public String timestampDiff(String left,
                            String right,
                            String alias)

Description copied from interface: IDatabaseTranslator

Returns an expression which computes the timestamp difference between left and right in seconds

Specified by:

timestampDiff in interface IDatabaseTranslator

alias - adds " AS alias " if alias is not null

Returns:

createSequence

public String createSequence(String name,
                             int cache)

Description copied from interface: IDatabaseTranslator

Craft the DDL for a CREATE SEQUENCE statement

Specified by:

createSequence in interface IDatabaseTranslator

cache - the number of sequence values to cache, if supported by the database

Returns:

reorgTableCommand

public String reorgTableCommand(String tableName)

Description copied from interface: IDatabaseTranslator

Return the REORG TABLE command if supported, or null otherwise

Specified by:

reorgTableCommand in interface IDatabaseTranslator

Returns:

getDriverClassName

public String getDriverClassName()

Description copied from interface: IDatabaseTranslator

Get the driver class to use for connections

Specified by:

getDriverClassName in interface IDatabaseTranslator

Returns:

getUrl

public String getUrl(Properties connectionProperties)

Description copied from interface: IDatabaseTranslator

Get the JDBC connection URL based on the properties

Specified by:

getUrl in interface IDatabaseTranslator

Returns:

clobSupportsInline

public boolean clobSupportsInline()

Description copied from interface: IDatabaseTranslator

Does the database support inlining for clobs

Specified by:

clobSupportsInline in interface IDatabaseTranslator

Returns:

getType

public DbType getType()

Description copied from interface: IDatabaseTranslator

The main type of the database

Specified by:

getType in interface IDatabaseTranslator

Returns:

dualTableName

public String dualTableName()

Description copied from interface: IDatabaseTranslator

The name of the "DUAL" table...that special table giving us one row/column.

Specified by:

dualTableName in interface IDatabaseTranslator

Returns:

the name of the "DUAL" table for the database, or null if not supported

selectSequenceNextValue

public String selectSequenceNextValue(String schemaName,
                                      String sequenceName)

Description copied from interface: IDatabaseTranslator

Compose a select statement to obtain the next value from the named sequence

Specified by:

selectSequenceNextValue in interface IDatabaseTranslator

Returns:

currentTimestampString

public String currentTimestampString()

Description copied from interface: IDatabaseTranslator

Get the "CURRENT TIMESTAMP" string for the database type

Specified by:

currentTimestampString in interface IDatabaseTranslator

Returns:

dropForeignKeyConstraint

public String dropForeignKeyConstraint(String qualifiedTableName,
                                       String constraintName)

Description copied from interface: IDatabaseTranslator

Generate the DDL for dropping the named FK constraint from the given table

Specified by:

dropForeignKeyConstraint in interface IDatabaseTranslator

Parameters:

qualifiedTableName - such as schema.foo_tab

constraintName - the constraint name of the FK

Returns:

nextValue

public String nextValue(String schemaName,
                        String sequenceName)

Description copied from interface: IDatabaseTranslator

Statement for getting the next value (for use in a select list or insert values)

Specified by:

nextValue in interface IDatabaseTranslator

Returns:

limit

public String limit(String arg)

Description copied from interface: IDatabaseTranslator

Get the correct LIMIT/FETCH NEXT ROWS clause for the database

Specified by:

limit in interface IDatabaseTranslator

Parameters:

arg - a literal int or ? bind-variable marker

Returns:

pagination

public String pagination(int offset,
                         int rowsPerPage)

Description copied from interface: IDatabaseTranslator

Construct a pagination clause specific to the type of database

Specified by:

pagination in interface IDatabaseTranslator

Parameters:

offset - the row offset

rowsPerPage - limit the number of rows returned (from the offset)

Returns: