net.sf.hajdbc

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

Modifier and Type	Method and Description
java.lang.String	evaluateCurrentDate(java.lang.String sql, java.sql.Date date) Replaces non-deterministic CURRENT_DATE functions with deterministic static values.
java.lang.String	evaluateCurrentTime(java.lang.String sql, java.sql.Time time) Replaces non-deterministic CURRENT_TIME functions with deterministic static values.
java.lang.String	evaluateCurrentTimestamp(java.lang.String sql, java.sql.Timestamp timestamp) Replaces non-deterministic CURRENT_TIMESTAMP functions with deterministic static values.
java.lang.String	evaluateRand(java.lang.String sql) Replaces non-deterministic RAND() functions with deterministic static values.
java.lang.String	getAlterIdentityColumnSQL(TableProperties table, ColumnProperties column, long value) Returns a SQL statement used reset the current value of an identity column.
java.lang.String	getAlterSequenceSQL(SequenceProperties sequence, long value) Returns a SQL statement used reset the current value of a sequence.
int	getColumnType(ColumnProperties properties) Returns the data type of the specified column of the specified schema and table.
java.lang.String	getCreateForeignKeyConstraintSQL(ForeignKeyConstraint constraint) Returns a SQL statement used to create a foreign key constraint.
java.lang.String	getCreateUniqueConstraintSQL(UniqueConstraint constraint) Returns a SQL statement used to create a unique constraint.
java.util.List<java.lang.String>	getDefaultSchemas(java.sql.DatabaseMetaData metaData) Returns a search path of schemas
java.lang.String	getDropForeignKeyConstraintSQL(ForeignKeyConstraint constraint) Returns a SQL statement used to drop a foreign key constraint.
java.lang.String	getDropUniqueConstraintSQL(UniqueConstraint constraint) Returns a SQL statement used to drop a unique constraint.
java.util.regex.Pattern	getIdentifierPattern(java.sql.DatabaseMetaData metaData) Returns a pattern for identifiers that do not require quoting
java.lang.String	getNextSequenceValueSQL(SequenceProperties sequence) Returns a SQL statement for obtaining the next value the specified sequence
java.util.Collection<QualifiedName>	getSequences(java.sql.DatabaseMetaData metaData) Returns a collection of all sequences in this database.
java.lang.String	getSimpleSQL() Returns a simple SQL statement used to validate whether a database is alive or not.
java.lang.String	getTruncateTableSQL(TableProperties properties) Returns a SQL statement used to truncate a table.
boolean	isSelectForUpdate(java.lang.String sql) Determines whether the specified SQL is a SELECT ...
java.lang.String	parseInsertTable(java.lang.String sql) Parses a table name from the specified INSERT SQL statement that may contain identity columns.
java.lang.String	parseSequence(java.lang.String sql) Parses a sequence name from the specified SQL statement.

Method Detail

getSimpleSQL

java.lang.String getSimpleSQL()
                       throws java.sql.SQLException

Returns a simple SQL statement used to validate whether a database is alive or not.

Returns:

a SQL statement

Throws:

java.sql.SQLException

getTruncateTableSQL

java.lang.String getTruncateTableSQL(TableProperties properties)
                              throws java.sql.SQLException

Returns a SQL statement used to truncate a table.

Parameters:

properties - table meta data

Returns:

a SQL statement

Throws:

java.sql.SQLException - if there was an error fetching meta data.

getCreateForeignKeyConstraintSQL

java.lang.String getCreateForeignKeyConstraintSQL(ForeignKeyConstraint constraint)
                                           throws java.sql.SQLException

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

Parameters:

constraint - foreign key constraint meta data

Returns:

a SQL statement

Throws:

java.sql.SQLException - if there was an error fetching meta data.

getDropForeignKeyConstraintSQL

java.lang.String getDropForeignKeyConstraintSQL(ForeignKeyConstraint constraint)
                                         throws java.sql.SQLException

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

Parameters:

constraint - foreign key constraint meta data

Returns:

a SQL statement

Throws:

java.sql.SQLException - if there was an error fetching meta data.

getCreateUniqueConstraintSQL

java.lang.String getCreateUniqueConstraintSQL(UniqueConstraint constraint)
                                       throws java.sql.SQLException

Returns a SQL statement used to create a unique constraint.

Parameters:

constraint - unique constraint meta data

Returns:

a SQL statement

Throws:

java.sql.SQLException - if there was an error fetching meta data.

getDropUniqueConstraintSQL

java.lang.String getDropUniqueConstraintSQL(UniqueConstraint constraint)
                                     throws java.sql.SQLException

Returns a SQL statement used to drop a unique constraint.

Parameters:

constraint - unique constraint meta data

Returns:

a SQL statement

Throws:

java.sql.SQLException - if there was an error fetching meta data.

isSelectForUpdate

boolean isSelectForUpdate(java.lang.String sql)
                   throws java.sql.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:

java.sql.SQLException - if there was an error fetching meta data.

getColumnType

int getColumnType(ColumnProperties properties)
           throws java.sql.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:

java.sql.SQLException

parseInsertTable

java.lang.String parseInsertTable(java.lang.String sql)
                           throws java.sql.SQLException

Parses a table name from the specified INSERT SQL statement that may contain identity columns.

Parameters:

sql - a SQL statement

Returns:

the name of a table, or null if this SQL statement is not an INSERT statement or this dialect does not support identity columns

Throws:

java.sql.SQLException

Since:

2.0

parseSequence

java.lang.String parseSequence(java.lang.String sql)
                        throws java.sql.SQLException

Parses a sequence name from the specified SQL statement.

Parameters:

sql - a SQL statement

Returns:

the name of a sequence, or null if this SQL statement does not reference a sequence or this dialect does not support sequences

Throws:

java.sql.SQLException

Since:

2.0

getSequences

java.util.Collection<QualifiedName> getSequences(java.sql.DatabaseMetaData metaData)
                                          throws java.sql.SQLException

Returns a collection of all sequences in this database.

Parameters:

metaData - database meta data

Returns:

a collection of sequence names

Throws:

java.sql.SQLException

Since:

2.0

getNextSequenceValueSQL

java.lang.String getNextSequenceValueSQL(SequenceProperties sequence)
                                  throws java.sql.SQLException

Returns a SQL statement for obtaining the next value the specified sequence

Parameters:

sequence - a sequence name

Returns:

a SQL statement

Throws:

java.sql.SQLException

Since:

2.0

getAlterSequenceSQL

java.lang.String getAlterSequenceSQL(SequenceProperties sequence,
                                     long value)
                              throws java.sql.SQLException

Returns a SQL statement used reset the current value of a sequence.

Parameters:

sequence - a sequence name

value - a sequence value

Returns:

a SQL statement

Throws:

java.sql.SQLException

Since:

2.0

getAlterIdentityColumnSQL

java.lang.String getAlterIdentityColumnSQL(TableProperties table,
                                           ColumnProperties column,
                                           long value)
                                    throws java.sql.SQLException

Returns a SQL statement used reset the current value of an identity column.

Parameters:

table - a sequence name

column - a sequence name

value - a sequence value

Returns:

a SQL statement

Throws:

java.sql.SQLException

Since:

2.0.2

getDefaultSchemas

java.util.List<java.lang.String> getDefaultSchemas(java.sql.DatabaseMetaData metaData)
                                            throws java.sql.SQLException

Returns a search path of schemas

Parameters:

metaData -

Returns:

a list of schema names

Throws:

java.sql.SQLException

Since:

2.0

getIdentifierPattern

java.util.regex.Pattern getIdentifierPattern(java.sql.DatabaseMetaData metaData)
                                      throws java.sql.SQLException

Returns a pattern for identifiers that do not require quoting

Parameters:

metaData -

Returns:

a regular expression pattern

Throws:

java.sql.SQLException

Since:

2.0.2

evaluateCurrentDate

java.lang.String evaluateCurrentDate(java.lang.String sql,
                                     java.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:

java.sql.SQLException

Since:

2.0.2

evaluateCurrentTime

java.lang.String evaluateCurrentTime(java.lang.String sql,
                                     java.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:

java.sql.SQLException

Since:

2.0.2

evaluateCurrentTimestamp

java.lang.String evaluateCurrentTimestamp(java.lang.String sql,
                                          java.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:

java.sql.SQLException

Since:

2.0.2

evaluateRand

java.lang.String evaluateRand(java.lang.String sql)

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

Parameters:

sql - an SQL statement

Returns:

an equivalent deterministic SQL statement

Throws:

java.sql.SQLException

Since:

2.0.2