Dialect (doma-core 2.60.1 API)

All Known Implementing Classes:

Db2Dialect, H212126Dialect, H214199Dialect, H2Dialect, HsqldbDialect, Mssql2008Dialect, MssqlDialect, MysqlDialect, Oracle11Dialect, OracleDialect, PostgresDialect, SqliteDialect, StandardDialect
```
public interface Dialect
```
A RDBMS dialect.
This interface absorb the difference between RDBMSs.
The implementation instance must be thread safe.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.lang.String`	`applyQuote(java.lang.String name)` Enclose the name with quotation marks.
`ScriptBlockContext`	`createScriptBlockContext()` Creates the context object to process an SQL block in a script.
`AutoGeneratedKeysType`	`getAutoGeneratedKeysType()` Returns the type of the auto generated keys.
`CriteriaBuilder`	`getCriteriaBuilder()`
`ExpressionFunctions`	`getExpressionFunctions()` Returns the aggregation of the expression functions that are available in the SQL templates.
`Sql<?>`	`getIdentityReservationSql(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, boolean isQuoteRequired, boolean isIdColumnQuoteRequired, int reservationSize)` Returns an SQL object to reserve identity in the database.
`Sql<?>`	`getIdentitySelectSql(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, boolean isQuoteRequired, boolean isIdColumnQuoteRequired)` Returns an SQL object to get IDENTITY values that are generated in the database.
`JdbcMappingVisitor`	`getJdbcMappingVisitor()` Returns the visitor that maps `Wrapper` to `JdbcType`.
`java.lang.String`	`getName()` The dialect name.
`JdbcType<java.sql.ResultSet>`	`getResultSetType()` Returns the `JdbcType` object that corresponds to the `ResultSet` class.
`java.lang.Throwable`	`getRootCause(java.sql.SQLException sqlException)` Returns the root cause of the SQL exception.
`java.lang.String`	`getScriptBlockDelimiter()` Return the delimiter that is used as the end of an SQL block in a script.
`Sql<?>`	`getSequenceNextValSql(java.lang.String qualifiedSequenceName, long allocationSize)` Returns an SQL object to get next sequence values.
`SqlLogFormattingVisitor`	`getSqlLogFormattingVisitor()` Return the visitor that maps `Wrapper` to `SqlLogFormatter`.
`UpsertAssembler`	`getUpsertAssembler(UpsertAssemblerContext context)` Returns the UpsertAssembler implementation for the given context.
`boolean`	`includesIdentityColumn()` Whether this object includes the IDENTITY column in SQL INSERT statements.
`boolean`	`isUniqueConstraintViolated(java.sql.SQLException sqlException)` Whether the `sqlException` represents an unique violation.
`java.lang.String`	`removeQuote(java.lang.String name)` Remove quotation marks from the name
`default boolean`	`supportsAliasInDeleteClause()` Whether this object supports alias reference in DELETE clause as follows:
`default boolean`	`supportsAliasInUpdateClause()` Whether this object supports alias reference in UPDATE clause as follows:
`boolean`	`supportsAutoGeneratedKeys()` Whether this object supports `Statement.getGeneratedKeys()`.
`default boolean`	`supportsBatchExecutionReturningGeneratedValues()`
`boolean`	`supportsBatchUpdateResults()` Whether this object supports the result of `Statement.executeBatch()`.
`boolean`	`supportsIdentity()` Whether this object supports the IDENTITY column.
`boolean`	`supportsIdentityReservation()` Whether this object supports a reservation of identity.
`default boolean`	`supportsModOperator()` Whether this object supports mod operator `%`.
`boolean`	`supportsResultSetReturningAsOutParameter()` Whether this object supports an out parameter that is mapped to a result set in stored functions or stored procedures .
`boolean`	`supportsSelectForUpdate(SelectForUpdateType type, boolean withTargets)` Whether this object supports pessimistic locking.
`boolean`	`supportsSequence()` Whether this object supports the SEQUENCE.
`SqlNode`	`transformSelectSqlNode(SqlNode sqlNode, SelectOptions options)` Transforms the SQL node.
`SqlNode`	`transformSelectSqlNodeForGettingCount(SqlNode sqlNode)` Transforms the SQL node to get a row count.

- Method Detail
  - getName
```
java.lang.String getName()
```
    The dialect name.
    
    Returns:
    
    the name
  - transformSelectSqlNode
```
SqlNode transformSelectSqlNode(SqlNode sqlNode,
                               SelectOptions options)
```
    Transforms the SQL node.
    
    Parameters:
    
    sqlNode - the SQL node
    
    options - the options
    
    Returns:
    
    the transformed node
    
    Throws:
    
    DomaNullPointerException - if any argument is null
    
    JdbcException - if unsupported options are specified
  - transformSelectSqlNodeForGettingCount
```
SqlNode transformSelectSqlNodeForGettingCount(SqlNode sqlNode)
```
    Transforms the SQL node to get a row count.
    
    Parameters:
    
    sqlNode - the SQL node
    
    Returns:
    
    the transformed node
    
    Throws:
    
    DomaNullPointerException - if any argument is null
  - isUniqueConstraintViolated
```
boolean isUniqueConstraintViolated(java.sql.SQLException sqlException)
```
    Whether the sqlException represents an unique violation.
    
    Parameters:
    
    sqlException - the SQL exception
    
    Returns:
    
    true, if the sqlException represents an unique violation
    
    Throws:
    
    DomaNullPointerException - if sqlException is null
  - includesIdentityColumn
```
boolean includesIdentityColumn()
```
    Whether this object includes the IDENTITY column in SQL INSERT statements.
    
    Returns:
    
    true, if this object includes it
  - supportsIdentity
```
boolean supportsIdentity()
```
    Whether this object supports the IDENTITY column.
    
    Returns:
    
    true, if this object supports it
  - supportsSequence
```
boolean supportsSequence()
```
    Whether this object supports the SEQUENCE.
    
    Returns:
    
    true, if this object supports it
  - supportsAutoGeneratedKeys
```
boolean supportsAutoGeneratedKeys()
```
    Whether this object supports Statement.getGeneratedKeys().
    
    Returns:
    
    true, if this object supports it
  - supportsBatchUpdateResults
```
boolean supportsBatchUpdateResults()
```
    Whether this object supports the result of Statement.executeBatch().
    
    Returns:
    
    true, if this object supports it
  - supportsBatchExecutionReturningGeneratedValues
```
default boolean supportsBatchExecutionReturningGeneratedValues()
```
  - supportsSelectForUpdate
```
boolean supportsSelectForUpdate(SelectForUpdateType type,
                                boolean withTargets)
```
    Whether this object supports pessimistic locking.
    
    Parameters:
    
    type - a kind of pessimistic locking
    
    withTargets - true if a lock target is specified
    
    Returns:
    
    true, if this object supports it
  - supportsResultSetReturningAsOutParameter
```
boolean supportsResultSetReturningAsOutParameter()
```
    Whether this object supports an out parameter that is mapped to a result set in stored functions or stored procedures .
    
    Returns:
    
    true, if this object supports it
  - supportsIdentityReservation
```
boolean supportsIdentityReservation()
```
    Whether this object supports a reservation of identity.
    
    Returns:
    
    true, if this object supports it
  - supportsAliasInDeleteClause
```
default boolean supportsAliasInDeleteClause()
```
    Whether this object supports alias reference in DELETE clause as follows:
```
 DELETE t FROM employee t
 
```
    Returns:
    
    true, if this object supports it
  - supportsAliasInUpdateClause
```
default boolean supportsAliasInUpdateClause()
```
    Whether this object supports alias reference in UPDATE clause as follows:
```
 UPDATE t SET t.age = 30 FROM employee t
 
```
    Returns:
    
    true, if this object supports it
  - supportsModOperator
```
default boolean supportsModOperator()
```
    Whether this object supports mod operator %.
    
    Returns:
    
    true, if this object supports it
  - getIdentitySelectSql
```
Sql<?> getIdentitySelectSql(java.lang.String catalogName,
                            java.lang.String schemaName,
                            java.lang.String tableName,
                            java.lang.String columnName,
                            boolean isQuoteRequired,
                            boolean isIdColumnQuoteRequired)
```
    Returns an SQL object to get IDENTITY values that are generated in the database.
    This method is available, only if supportsIdentity() returns true.
    
    Parameters:
    
    catalogName - the catalog name
    
    schemaName - the schema name
    
    tableName - the table name
    
    columnName - the IDENTITY column name
    
    isQuoteRequired - whether the quotation marks are required
    
    isIdColumnQuoteRequired - whether the quotation marks are required for the IDENTITY column
    
    Returns:
    
    the SQL object
    
    Throws:
    
    DomaNullPointerException - if either the tableName or the columnName is null
  - getIdentityReservationSql
```
Sql<?> getIdentityReservationSql(java.lang.String catalogName,
                                 java.lang.String schemaName,
                                 java.lang.String tableName,
                                 java.lang.String columnName,
                                 boolean isQuoteRequired,
                                 boolean isIdColumnQuoteRequired,
                                 int reservationSize)
```
    Returns an SQL object to reserve identity in the database.
    This method is available, only if supportsIdentityReservation() returns true.
    
    Parameters:
    
    catalogName - the catalog name
    
    schemaName - the schema name
    
    tableName - the table name
    
    columnName - the IDENTITY column name
    
    isQuoteRequired - whether the quotation marks are required
    
    isIdColumnQuoteRequired - whether the quotation marks are required for the IDENTITY column
    
    reservationSize - the size of the reservation
    
    Returns:
    
    the SQL object
    
    Throws:
    
    DomaNullPointerException - if either the tableName or the columnName is null
  - getSequenceNextValSql
```
Sql<?> getSequenceNextValSql(java.lang.String qualifiedSequenceName,
                             long allocationSize)
```
    Returns an SQL object to get next sequence values.
    This method is available, only if supportsSequence() returns true.
    
    Parameters:
    
    qualifiedSequenceName - the qualified sequence name
    
    allocationSize - the allocation size of the sequence
    
    Returns:
    
    the SQL object
    
    Throws:
    
    DomaNullPointerException - if qualifiedSequenceName is null
  - getResultSetType
```
JdbcType<java.sql.ResultSet> getResultSetType()
```
    Returns the JdbcType object that corresponds to the ResultSet class.
    This method is available, only if supportsResultSetReturningAsOutParameter() is true.
    
    Returns:
    
    the JdbcType object for the ResultSet class
  - applyQuote
```
java.lang.String applyQuote(java.lang.String name)
```
    Enclose the name with quotation marks.
    
    Parameters:
    
    name - the name of a database object such as a table, a column, and so on
    
    Returns:
    
    the name that is enclosed with quotation marks
  - removeQuote
```
java.lang.String removeQuote(java.lang.String name)
```
    Remove quotation marks from the name
    
    Parameters:
    
    name - the name of a database object such as a table, a column, and so on
    
    Returns:
    
    the name that has no enclosing quotation marks
  - getRootCause
```
java.lang.Throwable getRootCause(java.sql.SQLException sqlException)
```
    Returns the root cause of the SQL exception.
    
    Parameters:
    
    sqlException - the SQL exception
    
    Returns:
    
    the root cause
    
    Throws:
    
    DomaNullPointerException - if the sqlException is null
  - getJdbcMappingVisitor
```
JdbcMappingVisitor getJdbcMappingVisitor()
```
    Returns the visitor that maps Wrapper to JdbcType.
    
    Returns:
    
    the visitor
  - getSqlLogFormattingVisitor
```
SqlLogFormattingVisitor getSqlLogFormattingVisitor()
```
    Return the visitor that maps Wrapper to SqlLogFormatter.
    
    Returns:
    
    the visitor
  - getExpressionFunctions
```
ExpressionFunctions getExpressionFunctions()
```
    Returns the aggregation of the expression functions that are available in the SQL templates.
    
    Returns:
    
    the aggregation of the expression functions
  - createScriptBlockContext
```
ScriptBlockContext createScriptBlockContext()
```
    Creates the context object to process an SQL block in a script.
    
    Returns:
    
    the context object
  - getScriptBlockDelimiter
```
java.lang.String getScriptBlockDelimiter()
```
    Return the delimiter that is used as the end of an SQL block in a script.
    
    Returns:
    
    the delimiter
  - getAutoGeneratedKeysType
```
AutoGeneratedKeysType getAutoGeneratedKeysType()
```
    Returns the type of the auto generated keys.
    
    Returns:
    
    the type of the auto generated keys
  - getCriteriaBuilder
```
CriteriaBuilder getCriteriaBuilder()
```
  - getUpsertAssembler
```
UpsertAssembler getUpsertAssembler(UpsertAssemblerContext context)
```
    Returns the UpsertAssembler implementation for the given context.
    
    Parameters:
    
    context - the UpsertAssemblerContext object
    
    Returns:
    
    the UpsertAssembler object for the given context

Interface Dialect

Method Summary

Method Detail

getName

transformSelectSqlNode

transformSelectSqlNodeForGettingCount

isUniqueConstraintViolated

includesIdentityColumn

supportsIdentity

supportsSequence

supportsAutoGeneratedKeys

supportsBatchUpdateResults

supportsBatchExecutionReturningGeneratedValues

supportsSelectForUpdate

supportsResultSetReturningAsOutParameter

supportsIdentityReservation

supportsAliasInDeleteClause

supportsAliasInUpdateClause

supportsModOperator

getIdentitySelectSql

getIdentityReservationSql

getSequenceNextValSql

getResultSetType

applyQuote

removeQuote

getRootCause

getJdbcMappingVisitor

getSqlLogFormattingVisitor

getExpressionFunctions

createScriptBlockContext

getScriptBlockDelimiter

getAutoGeneratedKeysType

getCriteriaBuilder

getUpsertAssembler