org.databene.jdbacl

Class DatabaseDialect

java.lang.Object

org.databene.jdbacl.DatabaseDialect

Direct Known Subclasses:

CubridDialect, DB2Dialect, DerbyDialect, FirebirdDialect, H2Dialect, HSQLDialect, MySQLDialect, OracleDialect, PostgreSQLDialect, SqlServerDialect, UnknownDialect

public abstract class DatabaseDialect
extends Object

Provides abstractions of concepts that are implemented differently by different database vendors.

Since:

0.4.0

Author:

Volker Bergmann

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
boolean	quoteTableNames
protected boolean	sequenceSupported

Constructor Summary

Constructors

Constructor and Description
DatabaseDialect(String system, boolean quoteTableNames, boolean sequenceSupported, String datePattern, String timePattern, String datetimePattern)

Method Summary

Methods

Modifier and Type	Method and Description
protected UnsupportedOperationException	checkSequenceSupport(String methodName)
void	createSequence(String name, long initialValue, Connection connection)
String	formatTimestamp(Timestamp timestamp)
String	formatValue(Object value)
Set<String>	getReservedWords(Connection connection)
DBSequence	getSequence(String sequenceName, Connection connection)
String	getSystem()
protected void	importReservedWords(Connection connection) Imports the reserved words defined in a configuration file, then adds words retrieved by DatabaseMetaData.getSQLKeywords().
String	insert(DBTable table, List<ColumnInfo> columnInfos)
abstract boolean	isDefaultCatalog(String catalog, String user)
abstract boolean	isDefaultSchema(String schema, String user)
abstract boolean	isDeterministicFKName(String fkName) Determines if a foreign key constraint name was explicitly specified creation or at least generated by the database in a deterministic (reproducible) way
abstract boolean	isDeterministicIndexName(String indexName) Determines if an index name was explicitly specified creation or at least generated by the database in a deterministic (reproducible) way
abstract boolean	isDeterministicPKName(String pkName) Determines if a primary key constraint name was explicitly specified on creation or at least generated by the database in a deterministic (reproducible) way
abstract boolean	isDeterministicUKName(String ukName) Determines if a unique key constraint name was explicitly specified on creation or at least generated by the database in a deterministic (reproducible) way
protected static boolean	isNotOne(BigInteger i)
boolean	isReservedWord(String word, Connection connection)
boolean	isSequenceBoundarySupported()
boolean	isSequenceSupported()
List<DBPackage>	queryPackages(DBSchema schema, Connection connection)
DBSequence[]	querySequences(Connection connection)
List<DBTrigger>	queryTriggers(DBSchema schema, Connection connection)
String	regexQuery(String expression, boolean not, String regex) Renders a query condition for a regular expression.
String	renderCase(String columnName, String elseExpression, String... whenThenExpressionPairs)
String	renderCreateSequence(DBSequence sequence)
String	renderDropSequence(String sequenceName)
String	renderFetchSequenceValue(String sequenceName)
protected String	renderSequenceNameAndType(DBSequence sequence)
abstract void	restrictRownums(int rowOffset, int rowCount, Query query)
protected String	sequenceNoCycle()
void	setNextSequenceValue(String sequenceName, long value, Connection connection)
boolean	supportsRegex() Tells if the database supports regular expressions
String	trim(String expression)
String	update(DBTable table, String[] pkColumnNames, List<ColumnInfo> columnInfos)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

quoteTableNames

public final boolean quoteTableNames

sequenceSupported

protected final boolean sequenceSupported

Constructor Detail

DatabaseDialect

public DatabaseDialect(String system,
               boolean quoteTableNames,
               boolean sequenceSupported,
               String datePattern,
               String timePattern,
               String datetimePattern)

Method Detail

getSystem

public String getSystem()

isReservedWord

public boolean isReservedWord(String word,
                     Connection connection)
                       throws SQLException

Throws:

SQLException

getReservedWords

public Set<String> getReservedWords(Connection connection)
                             throws SQLException

Throws:

SQLException

importReservedWords

protected void importReservedWords(Connection connection)
                            throws SQLException

Imports the reserved words defined in a configuration file, then adds words retrieved by DatabaseMetaData.getSQLKeywords(). If no system-specific configuration file is found, jdbacl falls back to the keywords defined in SQL:2003. The combination of both approaches happens, since the documentation of DatabaseMetaData.getSQLKeywords() says that it "Retrieves a comma-separated list of all of this database's SQL keywords that are NOT also SQL:2003 keywords. By adding keywords dynamically retrieved from the JDBC driver I also get the chance to automatically handle keywords introduced in a new database version without having loads of different reserved-words-files.

Throws:

SQLException

isDefaultCatalog

public abstract boolean isDefaultCatalog(String catalog,
                       String user)

isDefaultSchema

public abstract boolean isDefaultSchema(String schema,
                      String user)

isSequenceSupported

public boolean isSequenceSupported()

isSequenceBoundarySupported

public boolean isSequenceBoundarySupported()

querySequences

public DBSequence[] querySequences(Connection connection)
                            throws SQLException

Throws:

SQLException

createSequence

public void createSequence(String name,
                  long initialValue,
                  Connection connection)
                    throws SQLException

Throws:

SQLException

renderCreateSequence

public String renderCreateSequence(DBSequence sequence)

renderSequenceNameAndType

protected String renderSequenceNameAndType(DBSequence sequence)

sequenceNoCycle

protected String sequenceNoCycle()

isNotOne

protected static boolean isNotOne(BigInteger i)

renderFetchSequenceValue

public String renderFetchSequenceValue(String sequenceName)

setNextSequenceValue

public void setNextSequenceValue(String sequenceName,
                        long value,
                        Connection connection)
                          throws SQLException

Throws:

SQLException

getSequence

public DBSequence getSequence(String sequenceName,
                     Connection connection)
                       throws SQLException

Throws:

SQLException

renderDropSequence

public String renderDropSequence(String sequenceName)

insert

public String insert(DBTable table,
            List<ColumnInfo> columnInfos)

update

public String update(DBTable table,
            String[] pkColumnNames,
            List<ColumnInfo> columnInfos)

formatValue

public String formatValue(Object value)

formatTimestamp

public String formatTimestamp(Timestamp timestamp)

checkSequenceSupport

protected UnsupportedOperationException checkSequenceSupport(String methodName)

isDeterministicPKName

public abstract boolean isDeterministicPKName(String pkName)

Determines if a primary key constraint name was explicitly specified on creation or at least generated by the database in a deterministic (reproducible) way

isDeterministicUKName

public abstract boolean isDeterministicUKName(String ukName)

Determines if a unique key constraint name was explicitly specified on creation or at least generated by the database in a deterministic (reproducible) way

isDeterministicFKName

public abstract boolean isDeterministicFKName(String fkName)

Determines if a foreign key constraint name was explicitly specified creation or at least generated by the database in a deterministic (reproducible) way

isDeterministicIndexName

public abstract boolean isDeterministicIndexName(String indexName)

Determines if an index name was explicitly specified creation or at least generated by the database in a deterministic (reproducible) way

supportsRegex

public boolean supportsRegex()

Tells if the database supports regular expressions

regexQuery

public String regexQuery(String expression,
                boolean not,
                String regex)

Renders a query condition for a regular expression.

Parameters:

expression - a column name or a SQL value expression to be checked with a regular expression

not - if set to true, the query fits expressions which do not match the regular expression

regex - the regular expression to check with

Returns:

a string with a SQL query condition.

Throws:

UnsupportedOperationException - if the database does not support regular expressions

trim

public String trim(String expression)

renderCase

public String renderCase(String columnName,
                String elseExpression,
                String... whenThenExpressionPairs)

queryTriggers

public List<DBTrigger> queryTriggers(DBSchema schema,
                            Connection connection)
                              throws SQLException

Throws:

SQLException

queryPackages

public List<DBPackage> queryPackages(DBSchema schema,
                            Connection connection)
                              throws SQLException

Throws:

SQLException

restrictRownums

public abstract void restrictRownums(int rowOffset,
                   int rowCount,
                   Query query)