Interface Dialect
- All Known Implementing Classes:
AbstractDialect,AnsiDialect,Db2Dialect,H2Dialect,HsqlDbDialect,MariaDbDialect,MySqlDialect,OracleDialect,PostgresDialect,SqlServerDialect
public interface Dialect
Represents a dialect that is implemented by a particular database. Please note that not all features are supported by
all vendors. Dialects typically express this with feature flags. Methods for unsupported functionality may throw
UnsupportedOperationException.- Since:
- 1.1
- Author:
- Mark Paluch, Jens Schauder, Myeonghyeon Lee, Christoph Strobl, Mikhail Polivakha, Chirag Tailor
-
Method Summary
Modifier and TypeMethodDescriptiondefault ArrayColumnsReturns the array support object that describes how array-typed columns are supported by this dialect.default Collection<Object>Return a collection of converters for this dialect.default SimpleFunctionProvide a SQL function that is suitable for implementing an exists-query.default IdentifierProcessingReturns theIdentifierProcessingused for processingSqlIdentifierwhen converting them to SQL snippets or parameter names.default IdGenerationdefault InsertRenderContextdefault EscaperReturns theEscaperused forLIKEvalue escaping.Obtain theSelectRenderContext.limit()Return theLimitClauseused by this dialect.lock()Return theLockClauseused by this dialect.default OrderByNullPrecedenceReturn theOrderByNullPrecedenceused by this dialect.Return theSetof types considered store native types that can be handeled by the driver.
-
Method Details
-
limit
LimitClause limit()Return theLimitClauseused by this dialect.- Returns:
- the
LimitClauseused by this dialect.
-
lock
LockClause lock()Return theLockClauseused by this dialect.- Returns:
- the
LockClauseused by this dialect.
-
getArraySupport
Returns the array support object that describes how array-typed columns are supported by this dialect.- Returns:
- the array support object that describes how array-typed columns are supported by this dialect.
-
getSelectContext
SelectRenderContext getSelectContext()Obtain theSelectRenderContext.- Returns:
- the
SelectRenderContext.
-
getIdentifierProcessing
Returns theIdentifierProcessingused for processingSqlIdentifierwhen converting them to SQL snippets or parameter names.- Returns:
- the
IdentifierProcessing. Guaranteed to be not null. - Since:
- 2.0
-
getLikeEscaper
Returns theEscaperused forLIKEvalue escaping.- Returns:
- the
Escaperused forLIKEvalue escaping. - Since:
- 2.0
-
getIdGeneration
-
getConverters
Return a collection of converters for this dialect.- Returns:
- a collection of converters for this dialect.
-
simpleTypes
Return theSetof types considered store native types that can be handeled by the driver.- Returns:
- never null.
- Since:
- 2.3
-
getInsertRenderContext
- Returns:
- an appropriate
InsertRenderContextfor that specific dialect. for most of the Dialects the default implementation will be valid, but, for example, in case ofSqlServerDialectit is not. - Since:
- 2.4
-
orderByNullHandling
Return theOrderByNullPrecedenceused by this dialect.- Returns:
- the
OrderByNullPrecedenceused by this dialect. - Since:
- 2.4
-
getExistsFunction
Provide a SQL function that is suitable for implementing an exists-query. The default is `COUNT(1)`, but for some database a `LEAST(COUNT(1), 1)` might be required, which doesn't get accepted by other databases.- Since:
- 3.0
-