io.ebean.config.dbplatform

Class DatabasePlatform

java.lang.Object

io.ebean.config.dbplatform.DatabasePlatform

Direct Known Subclasses:

DB2Platform, H2Platform, HsqldbPlatform, MySqlPlatform, OraclePlatform, PostgresPlatform, SqlAnywherePlatform, SQLitePlatform, SqlServerPlatform

public class DatabasePlatform
extends Object

Database platform specific settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabasePlatform.OnQueryOnly Behavior used when ending a query only transaction (at read committed isolation level).

Constructor Summary

Constructors

Constructor and Description
DatabasePlatform() Instantiates a new database platform.

Method Summary

Modifier and Type	Method and Description
String	completeSql(String sql, Query<?> query)
void	configure(DbTypeConfig config) Configure UUID Storage etc based on ServerConfig settings.
String	convertQuotedIdentifiers(String dbName) Convert backticks to the platform specific open quote and close quote
io.ebean.dbmigration.ddlgeneration.DdlHandler	createDdlHandler(ServerConfig serverConfig) Create and return a DDL handler for generating DDL scripts.
PlatformIdGenerator	createSequenceIdGenerator(BackgroundExecutor be, DataSource ds, String seqName, int batchSize) Return a DB Sequence based IdGenerator.
BasicSqlLimiter	getBasicSqlLimiter() Return the BasicSqlLimiter for limit/offset of SqlQuery queries.
int	getBlobDbType() Return the data type that should be used for Blob.
int	getBooleanDbType() Return the JDBC type used to store booleans.
int	getClobDbType() Return the data type that should be used for Clob.
String	getCloseQuote() Return the close quote for quoted identifiers.
String	getColumnAliasPrefix() Return the column alias prefix.
DbDefaultValue	getDbDefaultValue() Return the mapping for DB column default values.
DbEncrypt	getDbEncrypt() Return the DbEncrypt handler for this DB platform.
DbIdentity	getDbIdentity() Return the DB identity/sequence features for this platform.
DbPlatformTypeMapping	getDbTypeMap() Return the mapping of JDBC to DB types.
DbHistorySupport	getHistorySupport() Return the history support for this database platform.
String	getLikeClause() Returns the like clause used by this database platform.
int	getMaxConstraintNameLength() Return the maximum constraint name allowed for the platform.
int	getMaxTableNameLength() Return the maximum table name length.
String	getName() Return the name of the underlying Platform in lowercase.
DatabasePlatform.OnQueryOnly	getOnQueryOnly() Return the behaviour to use when ending a read only transaction.
String	getOpenQuote() Return the open quote for quoted identifiers.
io.ebean.PersistBatch	getPersistBatchOnCascade() Return the platform default JDBC batch mode for persist cascade.
io.ebean.Platform	getPlatform() Return the platform key.
io.ebean.dbmigration.ddlgeneration.platform.PlatformDdl	getPlatformDdl() Return the platform specific DDL.
SqlLimiter	getSqlLimiter() Return the SqlLimiter used to apply additional sql around a query to limit its results.
String	getTableAliasPlaceHolder() Return the table alias placeholder.
boolean	isForwardOnlyHintOnFindIterate() Return true if the ResultSet TYPE_FORWARD_ONLY Hint should be used on findIterate() and findVisit() PreparedStatements.
boolean	isIdInExpandedForm() Return true if a compound ID in (...) type expression needs to be in expanded form of (a=? and b=?) or (a=? and b=?) or ...
boolean	isNativeUuidType() Return true if the DB supports native UUID.
boolean	isPlatform(io.ebean.Platform platform) Return true if this matches the given platform.
boolean	isSelectCountWithAlias() Set to true if select count against anonymous view requires an alias.
boolean	isSupportsNativeIlike() Return true if this database platform supports native ILIKE expression.
boolean	isTreatEmptyStringsAsNull() Return true if empty strings should be treated as null.
void	setColumnAliasPrefix(String columnAliasPrefix) Set the column alias prefix.
void	setDbEncrypt(DbEncrypt dbEncrypt) Set the DbEncrypt handler for this DB platform.
void	setDbFalseLiteral(String dbFalseLiteral) Set the DB FALSE literal (from the registered boolean ScalarType)
void	setDbTrueLiteral(String dbTrueLiteral) Set the DB TRUE literal (from the registered boolean ScalarType)
void	setForwardOnlyHintOnFindIterate(boolean forwardOnlyHintOnFindIterate) Set to true if the ResultSet TYPE_FORWARD_ONLY Hint should be used by default on findIterate PreparedStatements.
void	setHistorySupport(DbHistorySupport historySupport) Set the history support for this database platform.
void	setOnQueryOnly(DatabasePlatform.OnQueryOnly onQueryOnly) Set the behaviour to use when ending a read only transaction.
void	setTableAliasPlaceHolder(String tableAliasPlaceHolder) Set the table alias placeholder.
boolean	tableExists(Connection connection, String catalog, String schema, String table) Return true if the table exists.
javax.persistence.PersistenceException	translate(String message, SQLException e) Translate the SQLException into a specific persistence exception if possible.
boolean	useExtraTransactionOnIterateSecondaryQueries() Return true if the JDBC driver does not allow additional queries to execute when a resultSet is being 'streamed' as is the case with findEach() etc.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabasePlatform

public DatabasePlatform()

Instantiates a new database platform.

Method Detail

translate

public javax.persistence.PersistenceException translate(String message,
                                                        SQLException e)

Translate the SQLException into a specific persistence exception if possible.

configure

public void configure(DbTypeConfig config)

Configure UUID Storage etc based on ServerConfig settings.

isPlatform

public boolean isPlatform(io.ebean.Platform platform)

Return true if this matches the given platform.

getPlatform

public io.ebean.Platform getPlatform()

Return the platform key.

getName

public String getName()

Return the name of the underlying Platform in lowercase.

"generic" is returned when no specific database platform has been set or found.

isSupportsNativeIlike

public boolean isSupportsNativeIlike()

Return true if this database platform supports native ILIKE expression.

getMaxTableNameLength

public int getMaxTableNameLength()

Return the maximum table name length.

This is used when deriving names of intersection tables.

getMaxConstraintNameLength

public int getMaxConstraintNameLength()

Return the maximum constraint name allowed for the platform.

getPlatformDdl

public io.ebean.dbmigration.ddlgeneration.platform.PlatformDdl getPlatformDdl()

Return the platform specific DDL.

createDdlHandler

public io.ebean.dbmigration.ddlgeneration.DdlHandler createDdlHandler(ServerConfig serverConfig)

Create and return a DDL handler for generating DDL scripts.

useExtraTransactionOnIterateSecondaryQueries

public boolean useExtraTransactionOnIterateSecondaryQueries()

Return true if the JDBC driver does not allow additional queries to execute when a resultSet is being 'streamed' as is the case with findEach() etc.

Honestly, this is a workaround for a stupid MySql JDBC driver limitation.

createSequenceIdGenerator

public PlatformIdGenerator createSequenceIdGenerator(BackgroundExecutor be,
                                                     DataSource ds,
                                                     String seqName,
                                                     int batchSize)

Return a DB Sequence based IdGenerator.

Parameters:

be - the BackgroundExecutor that can be used to load the sequence if desired

ds - the DataSource

seqName - the name of the sequence

batchSize - the number of sequences that should be loaded

getOnQueryOnly

public DatabasePlatform.OnQueryOnly getOnQueryOnly()

Return the behaviour to use when ending a read only transaction.

setOnQueryOnly

public void setOnQueryOnly(DatabasePlatform.OnQueryOnly onQueryOnly)

Set the behaviour to use when ending a read only transaction.

getDbEncrypt

public DbEncrypt getDbEncrypt()

Return the DbEncrypt handler for this DB platform.

setDbEncrypt

public void setDbEncrypt(DbEncrypt dbEncrypt)

Set the DbEncrypt handler for this DB platform.

getHistorySupport

public DbHistorySupport getHistorySupport()

Return the history support for this database platform.

setHistorySupport

public void setHistorySupport(DbHistorySupport historySupport)

Set the history support for this database platform.

isNativeUuidType

public boolean isNativeUuidType()

Return true if the DB supports native UUID.

getDbTypeMap

public DbPlatformTypeMapping getDbTypeMap()

Return the mapping of JDBC to DB types.

Returns:

the db type map

getDbDefaultValue

public DbDefaultValue getDbDefaultValue()

Return the mapping for DB column default values.

getColumnAliasPrefix

public String getColumnAliasPrefix()

Return the column alias prefix.

setColumnAliasPrefix

public void setColumnAliasPrefix(String columnAliasPrefix)

Set the column alias prefix.

getTableAliasPlaceHolder

public String getTableAliasPlaceHolder()

Return the table alias placeholder.

setTableAliasPlaceHolder

public void setTableAliasPlaceHolder(String tableAliasPlaceHolder)

Set the table alias placeholder.

getCloseQuote

public String getCloseQuote()

Return the close quote for quoted identifiers.

Returns:

the close quote

getOpenQuote

public String getOpenQuote()

Return the open quote for quoted identifiers.

Returns:

the open quote

getBooleanDbType

public int getBooleanDbType()

Return the JDBC type used to store booleans.

Returns:

the boolean db type

getBlobDbType

public int getBlobDbType()

Return the data type that should be used for Blob.

This is typically Types.BLOB but for Postgres is Types.LONGVARBINARY for example.

getClobDbType

public int getClobDbType()

Return the data type that should be used for Clob.

This is typically Types.CLOB but for Postgres is Types.VARCHAR.

isTreatEmptyStringsAsNull

public boolean isTreatEmptyStringsAsNull()

Return true if empty strings should be treated as null.

Returns:

true, if checks if is treat empty strings as null

isIdInExpandedForm

public boolean isIdInExpandedForm()

Return true if a compound ID in (...) type expression needs to be in expanded form of (a=? and b=?) or (a=? and b=?) or ... rather than (a,b) in ((?,?),(?,?),...);

isForwardOnlyHintOnFindIterate

public boolean isForwardOnlyHintOnFindIterate()

Return true if the ResultSet TYPE_FORWARD_ONLY Hint should be used on findIterate() and findVisit() PreparedStatements.

This specifically is required for MySql when processing large results.

setForwardOnlyHintOnFindIterate

public void setForwardOnlyHintOnFindIterate(boolean forwardOnlyHintOnFindIterate)

Set to true if the ResultSet TYPE_FORWARD_ONLY Hint should be used by default on findIterate PreparedStatements.

getDbIdentity

public DbIdentity getDbIdentity()

Return the DB identity/sequence features for this platform.

Returns:

the db identity

getSqlLimiter

public SqlLimiter getSqlLimiter()

Return the SqlLimiter used to apply additional sql around a query to limit its results.

Basically add the clauses for limit/offset, rownum, row_number().

Returns:

the sql limiter

getBasicSqlLimiter

public BasicSqlLimiter getBasicSqlLimiter()

Return the BasicSqlLimiter for limit/offset of SqlQuery queries.

setDbTrueLiteral

public void setDbTrueLiteral(String dbTrueLiteral)

Set the DB TRUE literal (from the registered boolean ScalarType)

setDbFalseLiteral

public void setDbFalseLiteral(String dbFalseLiteral)

Set the DB FALSE literal (from the registered boolean ScalarType)

convertQuotedIdentifiers

public String convertQuotedIdentifiers(String dbName)

Convert backticks to the platform specific open quote and close quote

Specific plugins may implement this method to cater for platform specific naming rules.

Parameters:

dbName - the db name

Returns:

the string

isSelectCountWithAlias

public boolean isSelectCountWithAlias()

Set to true if select count against anonymous view requires an alias.

completeSql

public String completeSql(String sql,
                          Query<?> query)

getLikeClause

public String getLikeClause()

Returns the like clause used by this database platform.

This may include an escape clause to disable a default escape character.

getPersistBatchOnCascade

public io.ebean.PersistBatch getPersistBatchOnCascade()

Return the platform default JDBC batch mode for persist cascade.

tableExists

public boolean tableExists(Connection connection,
                           String catalog,
                           String schema,
                           String table)
                    throws SQLException

Return true if the table exists.

Throws:

SQLException