DatabasePlatform (avaje-ebeanorm 8.1.1 API)

java.lang.Object
- com.avaje.ebean.config.dbplatform.DatabasePlatform

Direct Known Subclasses:

DB2Platform, H2Platform, HsqldbPlatform, MsSqlServer2000Platform, MsSqlServer2005Platform, MySqlPlatform, OraclePlatform, PostgresPlatform, SqlAnywherePlatform, SQLitePlatform
```
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).

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).

Field Summary

Fields
Modifier and Type	Field and Description
`protected BasicSqlLimiter`	`basicSqlLimiter` Limit/offset support for SqlQuery only.
`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 String`	`columnAliasPrefix`
`protected DbDefaultValue`	`dbDefaultValue` Default values for DB columns.
`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 DbHistorySupport`	`historySupport` The history support for this database platform.
`protected boolean`	`idInExpandedForm`
`protected String`	`likeClause` The like clause.
`protected int`	`maxConstraintNameLength` A value of 60 is a reasonable default for all databases except Oracle (limited to 30) and DB2 (limited to 18).
`protected int`	`maxTableNameLength` The maximum length of table names - used specifically when derived default table names for intersection tables.
`protected String`	`name` The database platform name.
`protected boolean`	`nativeUuidType` Set to true if the DB has native UUID type support.
`protected DatabasePlatform.OnQueryOnly`	`onQueryOnly` The behaviour used when ending a read only transaction at read committed isolation level.
`protected String`	`openQuote` The open quote used by quoted identifiers.
`protected PersistBatch`	`persistBatchOnCascade` By default we use JDBC batch when cascading (except for SQL Server).
`protected com.avaje.ebean.dbmigration.ddlgeneration.platform.PlatformDdl`	`platformDdl`
`protected boolean`	`selectCountWithAlias`
`protected SqlLimiter`	`sqlLimiter` For limit/offset, row_number etc limiting of SQL queries.
`protected boolean`	`supportsNativeIlike`
`protected String`	`tableAliasPlaceHolder`
`protected boolean`	`treatEmptyStringsAsNull` For Oracle treat empty strings as null.
`protected boolean`	`useExtraTransactionOnIterateSecondaryQueries` Set to true for MySql, no other jdbc drivers need this workaround.

Constructor Summary

Constructors
Constructor and Description

DatabasePlatform()
Instantiates a new database platform.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`close(ResultSet resultSet)` Close the resultSet.
`String`	`completeSql(String sql, Query<?> query)`
`void`	`configure(ServerConfig serverConfig)` Configure UUID Storage etc based on ServerConfig settings.
`String`	`convertQuotedIdentifiers(String dbName)` Convert backticks to the platform specific open quote and close quote
`com.avaje.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.
`DbTypeMap`	`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 DatabasePlatform.
`DatabasePlatform.OnQueryOnly`	`getOnQueryOnly()` Return the behaviour to use when ending a read only transaction.
`String`	`getOpenQuote()` Return the open quote for quoted identifiers.
`PersistBatch`	`getPersistBatchOnCascade()` Return the platform default JDBC batch mode for persist cascade.
`com.avaje.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`	`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.
`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.
`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
  - useExtraTransactionOnIterateSecondaryQueries
```
protected boolean useExtraTransactionOnIterateSecondaryQueries
```
    Set to true for MySql, no other jdbc drivers need this workaround.
  - onQueryOnly
```
protected DatabasePlatform.OnQueryOnly onQueryOnly
```
    The behaviour used when ending a read only transaction at read committed isolation level.
  - 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.
  - basicSqlLimiter
```
protected BasicSqlLimiter basicSqlLimiter
```
    Limit/offset support for SqlQuery only.
  - dbTypeMap
```
protected DbTypeMap dbTypeMap
```
    Mapping of JDBC to Database types.
  - dbDefaultValue
```
protected DbDefaultValue dbDefaultValue
```
    Default values for DB columns.
  - nativeUuidType
```
protected boolean nativeUuidType
```
    Set to true if the DB has native UUID type support.
  - dbIdentity
```
protected DbIdentity dbIdentity
```
    Defines DB identity/sequence features.
  - historySupport
```
protected DbHistorySupport historySupport
```
    The history support for this database platform.
  - 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 database platform name.
  - columnAliasPrefix
```
protected String columnAliasPrefix
```
  - tableAliasPlaceHolder
```
protected String tableAliasPlaceHolder
```
  - likeClause
```
protected String likeClause
```
    The like clause. Can be overridden to disable default escape character.
  - 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().
  - persistBatchOnCascade
```
protected PersistBatch persistBatchOnCascade
```
    By default we use JDBC batch when cascading (except for SQL Server).
  - platformDdl
```
protected com.avaje.ebean.dbmigration.ddlgeneration.platform.PlatformDdl platformDdl
```
  - maxTableNameLength
```
protected int maxTableNameLength
```
    The maximum length of table names - used specifically when derived default table names for intersection tables.
  - maxConstraintNameLength
```
protected int maxConstraintNameLength
```
    A value of 60 is a reasonable default for all databases except Oracle (limited to 30) and DB2 (limited to 18).
  - supportsNativeIlike
```
protected boolean supportsNativeIlike
```
- Constructor Detail
  - DatabasePlatform
```
public DatabasePlatform()
```
    Instantiates a new database platform.
- Method Detail
  - configure
```
public void configure(ServerConfig serverConfig)
```
    Configure UUID Storage etc based on ServerConfig settings.
  - getName
```
public String getName()
```
    Return the name of the DatabasePlatform.
    "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 com.avaje.ebean.dbmigration.ddlgeneration.platform.PlatformDdl getPlatformDdl()
```
    Return the platform specific DDL.
  - createDdlHandler
```
public com.avaje.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 DbTypeMap 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)
```
  - withForUpdate
```
protected String withForUpdate(String sql)
```
  - 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 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
  - close
```
protected void close(ResultSet resultSet)
```
    Close the resultSet.

Class DatabasePlatform

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

useExtraTransactionOnIterateSecondaryQueries

onQueryOnly

openQuote

closeQuote

sqlLimiter

basicSqlLimiter

dbTypeMap

dbDefaultValue

nativeUuidType

dbIdentity

historySupport

booleanDbType

blobDbType

clobDbType

treatEmptyStringsAsNull

name

columnAliasPrefix

tableAliasPlaceHolder

likeClause

dbEncrypt

idInExpandedForm

selectCountWithAlias

forwardOnlyHintOnFindIterate

persistBatchOnCascade

platformDdl

maxTableNameLength

maxConstraintNameLength

supportsNativeIlike

Constructor Detail

DatabasePlatform

Method Detail

configure

getName

isSupportsNativeIlike

getMaxTableNameLength

getMaxConstraintNameLength

getPlatformDdl

createDdlHandler

useExtraTransactionOnIterateSecondaryQueries

createSequenceIdGenerator

getOnQueryOnly

setOnQueryOnly

getDbEncrypt

setDbEncrypt

getHistorySupport

setHistorySupport

isNativeUuidType

getDbTypeMap

getDbDefaultValue

getColumnAliasPrefix

setColumnAliasPrefix

getTableAliasPlaceHolder

setTableAliasPlaceHolder

getCloseQuote

getOpenQuote

getBooleanDbType

getBlobDbType

getClobDbType

isTreatEmptyStringsAsNull

isIdInExpandedForm

isForwardOnlyHintOnFindIterate

setForwardOnlyHintOnFindIterate

getDbIdentity

getSqlLimiter

getBasicSqlLimiter

setDbTrueLiteral

setDbFalseLiteral

convertQuotedIdentifiers

isSelectCountWithAlias

completeSql

withForUpdate

getLikeClause

getPersistBatchOnCascade