net.sf.hajdbc.dialect

Interface Dialect

All Known Implementing Classes:

DB2Dialect, DerbyDialect, FirebirdDialect, H2Dialect, HSQLDBDialect, IngresDialect, MaxDBDialect, MckoiDialect, MySQLDialect, OracleDialect, PostgreSQLDialect, StandardDialect, SybaseDialect

public interface Dialect

Encapsulates database vendor specific SQL syntax.

Since:

1.1

Author:

Paul Ferraro

Method Summary

Methods

Modifier and Type	Method and Description
ColumnPropertiesFactory	createColumnPropertiesFactory(IdentifierNormalizer normalizer)
ForeignKeyConstraintFactory	createForeignKeyConstraintFactory(QualifiedNameFactory factory)
IdentifierNormalizer	createIdentifierNormalizer(DatabaseMetaData metaData)
QualifiedNameFactory	createQualifiedNameFactory(DatabaseMetaData metaData, IdentifierNormalizer normalizer)
UniqueConstraintFactory	createUniqueConstraintFactory(IdentifierNormalizer normalizer)
String	evaluateCurrentDate(String sql, Date date) Replaces non-deterministic CURRENT_DATE functions with deterministic static values.
String	evaluateCurrentTime(String sql, Time time) Replaces non-deterministic CURRENT_TIME functions with deterministic static values.
String	evaluateCurrentTimestamp(String sql, Timestamp timestamp) Replaces non-deterministic CURRENT_TIMESTAMP functions with deterministic static values.
String	evaluateRand(String sql) Replaces non-deterministic RAND() functions with deterministic static values.
Map<String,ColumnProperties>	getColumns(DatabaseMetaData metaData, QualifiedName table, ColumnPropertiesFactory factory) Returns the columns of the specified table.
int	getColumnType(ColumnProperties properties) Returns the data type of the specified column of the specified schema and table.
<Z,D extends Database<Z>> ConnectionProperties	getConnectionProperties(D database, Decoder decoder)
String	getCreateForeignKeyConstraintSQL(ForeignKeyConstraint constraint) Returns a SQL statement used to create a foreign key constraint.
String	getCreateSchemaSQL(String schema)
String	getCreateUniqueConstraintSQL(UniqueConstraint constraint) Returns a SQL statement used to create a unique constraint.
List<String>	getDefaultSchemas(DatabaseMetaData metaData) Returns a search path of schemas
String	getDropForeignKeyConstraintSQL(ForeignKeyConstraint constraint) Returns a SQL statement used to drop a foreign key constraint.
String	getDropSchemaSQL(String schema)
String	getDropUniqueConstraintSQL(UniqueConstraint constraint) Returns a SQL statement used to drop a unique constraint.
DumpRestoreSupport	getDumpRestoreSupport()
Collection<ForeignKeyConstraint>	getForeignKeyConstraints(DatabaseMetaData metaData, QualifiedName table, ForeignKeyConstraintFactory factory) Returns the foreign key constraints on the specified table.
Collection<String>	getIdentityColumns(Collection<ColumnProperties> columns) Identifies any identity columns from the from the specified collection of columns
IdentityColumnSupport	getIdentityColumnSupport()
UniqueConstraint	getPrimaryKey(DatabaseMetaData metaData, QualifiedName table, UniqueConstraintFactory factory) Returns the primary key of the specified table.
SequenceSupport	getSequenceSupport()
Collection<QualifiedName>	getTables(DatabaseMetaData metaData, QualifiedNameFactory factory) Returns all tables in this database mapped by schema.
TriggerSupport	getTriggerSupport()
String	getTruncateTableSQL(TableProperties properties) Returns a SQL statement used to truncate a table.
Map<Integer,Map.Entry<String,Integer>>	getTypes(DatabaseMetaData metaData) Returns a mapping of standard JDBC types to native types
Collection<UniqueConstraint>	getUniqueConstraints(DatabaseMetaData metaData, QualifiedName table, UniqueConstraint primaryKey, UniqueConstraintFactory factory) Returns the unique constraints on the specified table - excluding the primary key of the table.
boolean	indicatesFailure(SQLException e) Determines whether the specified exception indicates a catastrophic error.
boolean	indicatesFailure(XAException e) Determines whether the specified exception indicates a catastrophic error.
boolean	isSelectForUpdate(String sql) Determines whether the specified SQL is a SELECT ...
boolean	isValid(Connection connection)

Method Detail

getTruncateTableSQL

String getTruncateTableSQL(TableProperties properties)
                           throws SQLException

Returns a SQL statement used to truncate a table.

Parameters:

properties - table meta data

Returns:

a SQL statement

Throws:

SQLException - if there was an error fetching meta data.

getCreateForeignKeyConstraintSQL

String getCreateForeignKeyConstraintSQL(ForeignKeyConstraint constraint)
                                        throws SQLException

Returns a SQL statement used to create a foreign key constraint.

Parameters:

constraint - foreign key constraint meta data

Returns:

a SQL statement

Throws:

SQLException - if there was an error fetching meta data.

getDropForeignKeyConstraintSQL

String getDropForeignKeyConstraintSQL(ForeignKeyConstraint constraint)
                                      throws SQLException

Returns a SQL statement used to drop a foreign key constraint.

Parameters:

constraint - foreign key constraint meta data

Returns:

a SQL statement

Throws:

SQLException - if there was an error fetching meta data.

getCreateUniqueConstraintSQL

String getCreateUniqueConstraintSQL(UniqueConstraint constraint)
                                    throws SQLException

Returns a SQL statement used to create a unique constraint.

Parameters:

constraint - unique constraint meta data

Returns:

a SQL statement

Throws:

SQLException - if there was an error fetching meta data.

getDropUniqueConstraintSQL

String getDropUniqueConstraintSQL(UniqueConstraint constraint)
                                  throws SQLException

Returns a SQL statement used to drop a unique constraint.

Parameters:

constraint - unique constraint meta data

Returns:

a SQL statement

Throws:

SQLException - if there was an error fetching meta data.

isSelectForUpdate

boolean isSelectForUpdate(String sql)
                          throws SQLException

Determines whether the specified SQL is a SELECT ... FOR UPDATE statement

Parameters:

sql - a SQL statement

Returns:

true if this is a SELECT ... FOR UPDATE statement, false if it is not

Throws:

SQLException - if there was an error fetching meta data.

getColumnType

int getColumnType(ColumnProperties properties)
                  throws SQLException

Returns the data type of the specified column of the specified schema and table. This method is intended to correct JDBC driver type mapping quirks.

Parameters:

properties - table column meta data

Returns:

the JDBC data type of this column

Throws:

SQLException

getDefaultSchemas

List<String> getDefaultSchemas(DatabaseMetaData metaData)
                               throws SQLException

Returns a search path of schemas

Parameters:

metaData -

Returns:

a list of schema names

Throws:

SQLException

Since:

2.0

evaluateCurrentDate

String evaluateCurrentDate(String sql,
                         Date date)

Replaces non-deterministic CURRENT_DATE functions with deterministic static values.

Parameters:

sql - an SQL statement

date - the replacement date

Returns:

an equivalent deterministic SQL statement

Throws:

SQLException

Since:

2.0.2

evaluateCurrentTime

String evaluateCurrentTime(String sql,
                         Time time)

Replaces non-deterministic CURRENT_TIME functions with deterministic static values.

Parameters:

sql - an SQL statement

time - the replacement time

Returns:

an equivalent deterministic SQL statement

Throws:

SQLException

Since:

2.0.2

evaluateCurrentTimestamp

String evaluateCurrentTimestamp(String sql,
                              Timestamp timestamp)

Replaces non-deterministic CURRENT_TIMESTAMP functions with deterministic static values.

Parameters:

sql - an SQL statement

timestamp - the replacement timestamp

Returns:

an equivalent deterministic SQL statement

Throws:

SQLException

Since:

2.0.2

evaluateRand

String evaluateRand(String sql)

Replaces non-deterministic RAND() functions with deterministic static values.

Parameters:

sql - an SQL statement

Returns:

an equivalent deterministic SQL statement

Throws:

SQLException

Since:

2.0.2

indicatesFailure

boolean indicatesFailure(SQLException e)

Determines whether the specified exception indicates a catastrophic error.

Parameters:

e - an exception

Returns:

true, if the exception indicates catastrophe, false otherwise

indicatesFailure

boolean indicatesFailure(XAException e)

Determines whether the specified exception indicates a catastrophic error.

Parameters:

e - an exception

Returns:

true, if the exception indicates catastrophe, false otherwise

getSequenceSupport

SequenceSupport getSequenceSupport()

getIdentityColumnSupport

IdentityColumnSupport getIdentityColumnSupport()

getDumpRestoreSupport

DumpRestoreSupport getDumpRestoreSupport()

getTriggerSupport

TriggerSupport getTriggerSupport()

getCreateSchemaSQL

String getCreateSchemaSQL(String schema)

getDropSchemaSQL

String getDropSchemaSQL(String schema)

getTables

Collection<QualifiedName> getTables(DatabaseMetaData metaData,
                                  QualifiedNameFactory factory)
                                    throws SQLException

Returns all tables in this database mapped by schema.

Parameters:

metaData - a DatabaseMetaData implementation

Returns:

a Map of schema name to Collection of table names

Throws:

SQLException - if an error occurs access DatabaseMetaData

getColumns

Map<String,ColumnProperties> getColumns(DatabaseMetaData metaData,
                                      QualifiedName table,
                                      ColumnPropertiesFactory factory)
                                        throws SQLException

Returns the columns of the specified table.

Parameters:

metaData - a DatabaseMetaData implementation

table - a schema qualified table name

Returns:

a Map of column name to column properties

Throws:

SQLException - if an error occurs access DatabaseMetaData

getPrimaryKey

UniqueConstraint getPrimaryKey(DatabaseMetaData metaData,
                             QualifiedName table,
                             UniqueConstraintFactory factory)
                               throws SQLException

Returns the primary key of the specified table.

Parameters:

metaData - a DatabaseMetaData implementation

table - a schema qualified table name

Returns:

a unique constraint

Throws:

SQLException - if an error occurs access DatabaseMetaData

getForeignKeyConstraints

Collection<ForeignKeyConstraint> getForeignKeyConstraints(DatabaseMetaData metaData,
                                                        QualifiedName table,
                                                        ForeignKeyConstraintFactory factory)
                                                          throws SQLException

Returns the foreign key constraints on the specified table.

Parameters:

metaData - a DatabaseMetaData implementation

table - a schema qualified table name

Returns:

a Collection of foreign key constraints.

Throws:

SQLException - if an error occurs access DatabaseMetaData

getUniqueConstraints

Collection<UniqueConstraint> getUniqueConstraints(DatabaseMetaData metaData,
                                                QualifiedName table,
                                                UniqueConstraint primaryKey,
                                                UniqueConstraintFactory factory)
                                                  throws SQLException

Returns the unique constraints on the specified table - excluding the primary key of the table.

Parameters:

metaData - a schema qualified table name

table - a qualified table name

primaryKey - the primary key of this table

Returns:

a Collection of unique constraints.

Throws:

SQLException - if an error occurs access DatabaseMetaData

getIdentityColumns

Collection<String> getIdentityColumns(Collection<ColumnProperties> columns)
                                      throws SQLException

Identifies any identity columns from the from the specified collection of columns

Parameters:

columns - the columns of a table

Returns:

a collection of column names

Throws:

SQLException

getTypes

Map<Integer,Map.Entry<String,Integer>> getTypes(DatabaseMetaData metaData)
                                                throws SQLException

Returns a mapping of standard JDBC types to native types

Parameters:

metaData - database meta data

Returns:

a map of JDBC types

Throws:

SQLException

createIdentifierNormalizer

IdentifierNormalizer createIdentifierNormalizer(DatabaseMetaData metaData)
                                                throws SQLException

Throws:

SQLException

createQualifiedNameFactory

QualifiedNameFactory createQualifiedNameFactory(DatabaseMetaData metaData,
                                              IdentifierNormalizer normalizer)
                                                throws SQLException

Throws:

SQLException

createColumnPropertiesFactory

ColumnPropertiesFactory createColumnPropertiesFactory(IdentifierNormalizer normalizer)

createForeignKeyConstraintFactory

ForeignKeyConstraintFactory createForeignKeyConstraintFactory(QualifiedNameFactory factory)

createUniqueConstraintFactory

UniqueConstraintFactory createUniqueConstraintFactory(IdentifierNormalizer normalizer)

isValid

boolean isValid(Connection connection)
                throws SQLException

Throws:

SQLException

getConnectionProperties

<Z,D extends Database<Z>> ConnectionProperties getConnectionProperties(D database,
                                                                     Decoder decoder)
                                             throws SQLException

Throws:

SQLException