com.avaje.ebean.config.dbplatform

Class DatabasePlatform

java.lang.Object

com.avaje.ebean.config.dbplatform.DatabasePlatform

Direct Known Subclasses:

DB2Platform, H2Platform, HsqldbPlatform, MsSqlServer2000Platform, MsSqlServer2005Platform, MySqlPlatform, Oracle10Platform, PostgresPlatform, SqlAnywherePlatform, SQLitePlatform

public class DatabasePlatform
extends Object

Database platform specific settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	blobDbType The JDBC type to map Blob to.
protected int	booleanDbType The JDBC type to map booleans to (by default).
protected int	clobDbType The JDBC type to map Clob to.
protected String	closeQuote The close quote used by quoted identifiers.
protected DbDdlSyntax	dbDdlSyntax DB specific DDL syntax.
protected DbEncrypt	dbEncrypt
protected DbIdentity	dbIdentity Defines DB identity/sequence features.
protected DbTypeMap	dbTypeMap Mapping of JDBC to Database types.
protected boolean	forwardOnlyHintOnFindIterate If set then use the FORWARD ONLY hint when creating ResultSets for findIterate() and findVisit().
protected boolean	idInExpandedForm
protected String	name The name.
protected String	openQuote The open quote used by quoted identifiers.
protected boolean	selectCountWithAlias
protected SqlLimiter	sqlLimiter For limit/offset, row_number etc limiting of SQL queries.
protected boolean	treatEmptyStringsAsNull For Oracle treat empty strings as null.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	completeSql(String sql, Query<?> query)
String	convertQuotedIdentifiers(String dbName) Convert backticks to the platform specific open quote and close quote
IdGenerator	createSequenceIdGenerator(BackgroundExecutor be, DataSource ds, String seqName, int batchSize) Return a DB Sequence based IdGenerator.
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.
DbDdlSyntax	getDbDdlSyntax() Return the DDL syntax for this platform.
DbEncrypt	getDbEncrypt() Return the DbEncrypt handler for this DB platform.
DbIdentity	getDbIdentity() Return the DB identity/sequence features for this platform.
DbTypeMap	getDbTypeMap() Return the mapping of JDBC to DB types.
String	getName() Return the name of the DatabasePlatform.
String	getOpenQuote() Return the open quote for quoted identifiers.
SqlLimiter	getSqlLimiter() Return the SqlLimiter used to apply additional sql around a query to limit its results.
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	isSelectCountWithAlias() Set to true if select count against anonymous view requires an alias.
boolean	isTreatEmptyStringsAsNull() Return true if empty strings should be treated as null.
void	setDbEncrypt(DbEncrypt dbEncrypt) Set the DbEncrypt handler for this DB platform.
void	setForwardOnlyHintOnFindIterate(boolean forwardOnlyHintOnFindIterate) Set to true if the ResultSet TYPE_FORWARD_ONLY Hint should be used by default on findIterate PreparedStatements.
protected String	withForUpdate(String sql)

Methods inherited from class java.lang.Object

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

Field Detail

openQuote

protected String openQuote

The open quote used by quoted identifiers.

closeQuote

protected String closeQuote

The close quote used by quoted identifiers.

sqlLimiter

protected SqlLimiter sqlLimiter

For limit/offset, row_number etc limiting of SQL queries.

dbTypeMap

protected DbTypeMap dbTypeMap

Mapping of JDBC to Database types.

dbDdlSyntax

protected DbDdlSyntax dbDdlSyntax

DB specific DDL syntax.

dbIdentity

protected DbIdentity dbIdentity

Defines DB identity/sequence features.

booleanDbType

protected int booleanDbType

The JDBC type to map booleans to (by default).

blobDbType

protected int blobDbType

The JDBC type to map Blob to.

clobDbType

protected int clobDbType

The JDBC type to map Clob to.

treatEmptyStringsAsNull

protected boolean treatEmptyStringsAsNull

For Oracle treat empty strings as null.

name

protected String name

The name.

dbEncrypt

protected DbEncrypt dbEncrypt

idInExpandedForm

protected boolean idInExpandedForm

selectCountWithAlias

protected boolean selectCountWithAlias

forwardOnlyHintOnFindIterate

protected boolean forwardOnlyHintOnFindIterate

If set then use the FORWARD ONLY hint when creating ResultSets for findIterate() and findVisit().

Constructor Detail

DatabasePlatform

public DatabasePlatform()

Instantiates a new database platform.

Method Detail

getName

public String getName()

Return the name of the DatabasePlatform.

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

Returns:

the name

createSequenceIdGenerator

public IdGenerator 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

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.

getDbTypeMap

public DbTypeMap getDbTypeMap()

Return the mapping of JDBC to DB types.

Returns:

the db type map

getDbDdlSyntax

public DbDdlSyntax getDbDdlSyntax()

Return the DDL syntax for this platform.

Returns:

the db ddl syntax

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

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)

withForUpdate

protected String withForUpdate(String sql)