Module io.ebean.api

Package io.ebean.config

Class DatabaseConfig

java.lang.Object

io.ebean.config.DatabaseConfig

All Implemented Interfaces:

DatabaseBuilder, DatabaseBuilder.Settings

public class DatabaseConfig
extends Object
implements DatabaseBuilder.Settings

The configuration used for creating a Database.

Used to programmatically construct an Database and optionally register it with the DB singleton.

If you just use DB thout this programmatic configuration Ebean will read the application.properties file and take the configuration from there. This usually includes searching the class path and automatically registering any entity classes and listeners etc.

 DatabaseConfig config = new DatabaseConfig();

 // read the ebean.properties and load
 // those settings into this DatabaseConfig object
 config.loadFromProperties();

 // explicitly register the entity beans to avoid classpath scanning
 config.addClass(Customer.class);
 config.addClass(User.class);

 Database db = DatabaseFactory.create(config);

 

Note that DatabaseConfigProvider provides a standard Java ServiceLoader mechanism that can be used to apply configuration to the DatabaseConfig.

Author:

emcgreal, rbygrave

See Also:

• DatabaseFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DatabaseConfig.UuidVersion

Nested classes/interfaces inherited from interface io.ebean.DatabaseBuilder

DatabaseBuilder.Settings

Constructor Summary

Constructors

Constructor	Description
DatabaseConfig()	Construct a Database Configuration for programmatically creating an Database.

Method Summary

Modifier and Type	Method	Description
DatabaseConfig	add(IdGenerator idGenerator)	Register a customer IdGenerator instance.
DatabaseConfig	add(BeanPersistController beanPersistController)	Register a BeanPersistController instance.
DatabaseConfig	add(BeanPersistListener beanPersistListener)	Register a BeanPersistListener instance.
DatabaseConfig	add(BeanPostConstructListener listener)	Register a BeanPostConstructListener instance.
DatabaseConfig	add(BeanPostLoad postLoad)	Register a BeanPostLoad instance.
DatabaseConfig	add(BeanQueryAdapter beanQueryAdapter)	Register a BeanQueryAdapter instance.
DatabaseConfig	add(BulkTableEventListener bulkTableEventListener)	Add a BulkTableEventListener
DatabaseConfig	addAll(Collection<Class<?>> classList)	Register all the classes (typically entity classes).
DatabaseConfig	addClass(Class<?> cls)	Programmatically add classes (typically entities) that this server should use.
DatabaseConfig	addCustomMapping(DbType type, String columnDefinition)	Add a custom type mapping that applies to all platforms.
DatabaseConfig	addCustomMapping(DbType type, String columnDefinition, io.ebean.annotation.Platform platform)	Add a custom type mapping.
DatabaseConfig	addMappingLocation(String mappingLocation)	Add a mapping location to search for xml mapping via class path search.
DatabaseConfig	addPackage(String packageName)	Add a package to search for entities via class path search.
DatabaseConfig	addServerConfigStartup(ServerConfigStartup configStartupListener)	Add a ServerConfigStartup.
io.ebean.annotation.PersistBatch	appliedPersistBatchOnCascade()	Return the PersistBatch mode to use for 'batchOnCascade' taking into account if the database platform supports getGeneratedKeys in batch mode.
DatabaseBuilder	apply(Consumer<DatabaseBuilder.Settings> applyConfiguration)	Apply configuration to this builder using a lambda.
Database	build()	Build and return the Database instance.
Set<Class<?>>	classes()	Return the classes registered for this database.
DatabaseConfig	classes(Collection<Class<?>> classes)	Set the list of classes (entities, listeners, scalarTypes etc) that should be used for this database.
String	getAsOfSysPeriod()	Return the database column used to support history and 'As of' queries.
String	getAsOfViewSuffix()	Return the suffix appended to the base table to derive the view that contains the union of the base table and the history table in order to support asOf queries.
AutoTuneConfig	getAutoTuneConfig()	Return the configuration for AutoTune.
int	getBackgroundExecutorSchedulePoolSize()	Return the Background executor schedule pool size.
int	getBackgroundExecutorShutdownSecs()	Return the Background executor shutdown seconds.
BackgroundExecutorWrapper	getBackgroundExecutorWrapper()	Return the background executor wrapper.
List<BulkTableEventListener>	getBulkTableEventListeners()	Return the list of BulkTableEventListener instances.
int	getCacheMaxIdleTime()	Return the L2 cache default max idle time in seconds.
int	getCacheMaxSize()	Return the L2 cache default max size.
int	getCacheMaxTimeToLive()	Return the L2 cache default max time to live in seconds.
ChangeLogListener	getChangeLogListener()	Return the ChangeLogListener which actually performs the logging of change sets in the background.
ChangeLogPrepare	getChangeLogPrepare()	Return the ChangeLogPrepare.
ChangeLogRegister	getChangeLogRegister()	Return the ChangeLogRegister which controls which ChangeLogFilter is used for each bean type and in this way provide fine grained control over which persist requests are included in the change log.
Set<Class<?>>	getClasses()	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to classes().
ClassLoadConfig	getClassLoadConfig()	Return the ClassLoadConfig which is used to detect Joda, Java8 types etc and also create new instances of plugins given a className.
Clock	getClock()	Get the clock used for setting the timestamps (e.g.
DbConstraintNaming	getConstraintNaming()	Return the constraint naming convention used in DDL generation.
ContainerConfig	getContainerConfig()	Return the container / clustering configuration.
CurrentTenantProvider	getCurrentTenantProvider()	Return the current tenant provider.
CurrentUserProvider	getCurrentUserProvider()	Return the CurrentUserProvider.
String	getDatabaseBooleanFalse()	Return a value used to represent FALSE in the database.
String	getDatabaseBooleanTrue()	Return a value used to represent TRUE in the database.
DatabasePlatform	getDatabasePlatform()	Return the database platform to use for this database.
String	getDatabasePlatformName()	Return the database platform name (can be null).
int	getDatabaseSequenceBatchSize()	Return the number of DB sequence values that should be preallocated.
DataSource	getDataSource()	Return the DataSource.
io.ebean.datasource.DataSourceBuilder.Settings	getDataSourceConfig()	Return the configuration to build a DataSource using Ebean's own DataSource implementation.
String	getDataTimeZone()	Return the time zone to use when reading/writing Timestamps via JDBC.
DbEncrypt	getDbEncrypt()	Return the DbEncrypt used to encrypt and decrypt properties.
String	getDbSchema()	Return the DB schema to use.
String	getDdlHeader()	Return the header to use with DDL generation.
String	getDdlInitSql()	Return a SQL script to execute before the "create all" DDL has been run.
Map<String,String>	getDdlPlaceholderMap()	Return a map of placeholder values that are substituted in DDL scripts.
String	getDdlPlaceholders()	Return a comma and equals delimited placeholders that are substituted in DDL scripts.
String	getDdlSeedSql()	Return SQL script to execute after the "create all" DDL has been run.
jakarta.persistence.EnumType	getDefaultEnumType()
String	getDumpMetricsOptions()	Return the options for dumping metrics.
String	getEnabledL2Regions()	Return the enabled L2 cache regions.
EncryptDeployManager	getEncryptDeployManager()	Return the EncryptDeployManager.
EncryptKeyManager	getEncryptKeyManager()	Return the EncryptKeyManager.
Encryptor	getEncryptor()	Return the Encryptor used to encrypt data on the java client side (as opposed to DB encryption functions).
ExternalTransactionManager	getExternalTransactionManager()	Return the external transaction manager.
List<BeanFindController>	getFindControllers()	Return the list of BeanFindController instances.
int	getGeometrySRID()	Return the Geometry SRID.
String	getHistoryTableSuffix()	Return the history table suffix (defaults to _history).
List<IdGenerator>	getIdGenerators()	Return the custom IdGenerator instances.
IdType	getIdType()	Return the preferred DB platform IdType.
int	getJdbcFetchSizeFindEach()	Return the default JDBC fetchSize hint for findEach/findEachWhile queries.
int	getJdbcFetchSizeFindList()	Return the default JDBC fetchSize hint for findList queries.
String	getJodaLocalTimeMode()	Return the mode to use for Joda LocalTime support 'normal' or 'utc'.
JsonConfig.Date	getJsonDate()	Return the JSON format used for Date types.
JsonConfig.DateTime	getJsonDateTime()	Return the JSON format used for DateTime types.
com.fasterxml.jackson.core.JsonFactory	getJsonFactory()	Return the Jackson JsonFactory to use.
JsonConfig.Include	getJsonInclude()	Return the JSON include mode used when writing JSON.
io.ebean.annotation.MutationDetection	getJsonMutationDetection()	Return the default MutableDetection to use with @DbJson using Jackson.
int	getLazyLoadBatchSize()	Return the default batch size for lazy loading of beans and collections.
LengthCheck	getLengthCheck()	Returns the length check mode.
List<String>	getMappingLocations()	Return mapping locations to search for xml mapping via class path search.
int	getMaxCallStack()	Return the max call stack to use for origin location.
Function<String,String>	getMetricNaming()	Return the naming convention to apply to metrics names.
String	getName()	Return the name of the Database.
NamingConvention	getNamingConvention()	Return the NamingConvention.
Object	getObjectMapper()	Return the Jackson ObjectMapper.
List<String>	getPackages()	Return packages to search for entities via class path search.
io.ebean.annotation.PersistBatch	getPersistBatch()	Return the PersistBatch mode to use by default at the transaction level.
io.ebean.annotation.PersistBatch	getPersistBatchOnCascade()	Return the JDBC batch mode to use per save(), delete(), insert() or update() request.
int	getPersistBatchSize()	Return the batch size used for JDBC batching.
List<BeanPersistController>	getPersistControllers()	Return the BeanPersistController instances.
PersistenceContextScope	getPersistenceContextScope()	Return the default PersistenceContextScope to be used if one is not explicitly set on a query.
List<BeanPersistListener>	getPersistListeners()	Return the BeanPersistListener instances.
PlatformConfig	getPlatformConfig()	Return the configuration for DB types (such as UUID and custom mappings).
List<BeanPostConstructListener>	getPostConstructListeners()	Return the list of BeanPostLoader instances.
List<BeanPostLoad>	getPostLoaders()	Return the list of BeanPostLoader instances.
ProfilingConfig	getProfilingConfig()	Return the configuration for profiling.
Properties	getProperties()	Return the properties that we used for configuration and were set via a call to loadFromProperties().
List<BeanQueryAdapter>	getQueryAdapters()	Return the BeanQueryAdapter instances.
int	getQueryBatchSize()	Gets the query batch size.
int	getQueryCacheMaxIdleTime()	Return the L2 query cache default max idle time in seconds.
int	getQueryCacheMaxSize()	Return the L2 query cache default max size.
int	getQueryCacheMaxTimeToLive()	Return the L2 query cache default max time to live in seconds.
int	getQueryPlanCaptureMaxCount()	Return the max number of query plans captured per request.
long	getQueryPlanCaptureMaxTimeMillis()	Return the time after which a capture query plans request will stop capturing more query plans.
long	getQueryPlanCapturePeriodSecs()	Return the frequency to capture query plans.
QueryPlanListener	getQueryPlanListener()	Return the listener used to process captured query plans.
long	getQueryPlanThresholdMicros()	Return the query plan collection threshold in microseconds.
int	getQueryPlanTTLSeconds()	Return the time to live for ebean's internal query plan.
DataSource	getReadOnlyDataSource()	Return the read only DataSource.
io.ebean.datasource.DataSourceBuilder.Settings	getReadOnlyDataSourceConfig()	Return the configuration for the read only DataSource.
String	getResourceDirectory()	Returns the resource directory.
ServerCachePlugin	getServerCachePlugin()	Return the ServerCachePlugin.
List<ServerConfigStartup>	getServerConfigStartupListeners()	Return the list of ServerConfigStartup instances.
<P> P	getServiceObject(Class<P> cls)	Used by ebean or plugins to obtain service objects.
Object	getServiceObject(String key)	Return the service object given the key.
SlowQueryListener	getSlowQueryListener()	Return the slow query event listener.
long	getSlowQueryMillis()	Return the slow query time in millis.
TenantCatalogProvider	getTenantCatalogProvider()	Return the tenancy catalog provider.
TenantDataSourceProvider	getTenantDataSourceProvider()	Return the tenancy datasource provider.
TenantMode	getTenantMode()	Return the tenancy mode used.
String	getTenantPartitionColumn()	Return the column name used for TenantMode.PARTITION.
TenantSchemaProvider	getTenantSchemaProvider()	Return the tenancy schema provider.
String	getUuidNodeId()	Returns the V1-UUID-NodeId
String	getUuidStateFile()	Return the UUID state file.
DatabaseConfig.UuidVersion	getUuidVersion()	Returns the UUID version mode.
DatabaseConfig	includeLabelInSql(boolean includeLabelInSql)	Set if generated SQL SELECT should include the query label as an inline SQL comment (to help reference back from the SQL to the code that executed the query.
boolean	isAllQuotedIdentifiers()	Return true if all DB column and table names should use quoted identifiers.
boolean	isAutoLoadModuleInfo()	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to isLoadModuleInfo().
boolean	isAutoPersistUpdates()	Return true if dirty beans are automatically persisted.
boolean	isAutoReadOnlyDataSource()	Return true if Ebean should create a DataSource for use with implicit read only transactions.
boolean	isChangeLogAsync()	Return true (default) if the changelog should be written async.
boolean	isChangeLogIncludeInserts()	Return true if inserts should be included in the change log by default.
boolean	isDbOffline()	Return true if the Database instance should be created in offline mode.
boolean	isDdlCreateOnly()	Return true if the "drop all ddl" should be skipped.
boolean	isDdlExtra()	Return true, if extra-ddl.xml should be executed.
boolean	isDdlGenerate()	Return true if the DDL should be generated.
boolean	isDdlRun()	Return true if the DDL should be run.
boolean	isDdlStrictMode()	Return true if strict mode is used which includes a check that non-null columns have a default value.
boolean	isDefaultServer()	Return true if this server should be registered as the "default" server with the Ebean singleton.
boolean	isDisableClasspathSearch()	Return true if the class path search should be disabled.
boolean	isDisableL2Cache()	Return true if L2 cache is disabled.
boolean	isDisableLazyLoading()	Return true if lazy loading is disabled on queries by default.
boolean	isDumpMetricsOnShutdown()	Return true if metrics should be dumped when the server is shutdown.
boolean	isDurationWithNanos()	Return true if Duration should be persisted with nanos precision (SQL DECIMAL).
boolean	isEagerFetchLobs()	Return true if LOB's should default to fetch eager.
boolean	isExpressionEqualsWithNullAsNoop()	Return true if eq("someProperty", null) should to generate "1=1" rather than "is null" sql expression.
boolean	isExpressionNativeIlike()	Return true if native ILIKE expression should be used if supported by the database platform (e.g.
boolean	isIdGeneratorAutomatic()	When false we need explicit @GeneratedValue mapping to assign Identity or Sequence generated values.
boolean	isIncludeLabelInSql()	Return true if generated sql select query should include an inline sql comment with the query label or profile location label.
boolean	isLoadModuleInfo()	Return true if entity classes should be loaded and registered via EntityClassRegister.
boolean	isLocalOnlyL2Cache()	Return true to use local only L2 cache.
boolean	isLocalTimeWithNanos()	Return true if LocalTime should be persisted with nanos precision.
boolean	isNotifyL2CacheInForeground()	Return true if L2 cache notification should run in the foreground.
boolean	isQueryPlanCapture()	Return true if periodic capture of query plans is enabled.
boolean	isQueryPlanEnable()	Return true if query plan capture is enabled.
boolean	isRegister()	Return true if this server should be registered with the Ebean singleton when it is created.
boolean	isRunMigration()	Return true if the DB migration should run on server start.
boolean	isSkipCacheAfterWrite()	Return true if L2 bean cache should be skipped once writes have occurred on a transaction.
boolean	isTransactionRollbackOnChecked()	Return true if transactions should rollback on checked exceptions.
boolean	isUpdateAllPropertiesInBatch()	Returns true if updates in JDBC batch default to include all properties by default.
boolean	isUseJtaTransactionManager()	Return true if we are running in a JTA Transaction manager.
boolean	isUseValidationNotNull()	Returns if we use javax.validation.constraints.NotNull
DatabaseConfig	lengthCheck(LengthCheck lengthCheck)	Sets the length check mode.
protected void	loadAutoTuneSettings(PropertiesWrapper p)	This is broken out to allow overridden behaviour.
protected void	loadDataSourceSettings(PropertiesWrapper p)	loads the data source settings to preserve existing behaviour.
DatabaseConfig	loadFromProperties()	Load settings from application.properties, application.yaml and other sources.
DatabaseConfig	loadFromProperties(Properties properties)	Load the settings from the given properties
protected void	loadSettings(PropertiesWrapper p)	Load the configuration settings from the properties file.
PlatformConfig	newPlatformConfig(String propertiesPath, String platformPrefix)	Create a new PlatformConfig based of the one held but with overridden properties by reading properties with the given path and prefix.
<T> DatabaseConfig	putServiceObject(Class<T> iface, T configObject)	Put a service object into configuration such that it can be used by ebean or a plugin.
DatabaseConfig	putServiceObject(Object configObject)	Put a service object into configuration such that it can be used by ebean or a plugin.
DatabaseConfig	putServiceObject(String key, Object configObject)	Put a service object into configuration such that it can be used by ebean or a plugin.
boolean	readOnlyDatabase()	Return true if this database is used in a read only way.
DatabaseBuilder	readOnlyDatabase(boolean readOnlyDatabase)	Set to true if this database is used in a read only way.
DatabaseConfig	setAllQuotedIdentifiers(boolean allQuotedIdentifiers)
DatabaseConfig	setAsOfSysPeriod(String asOfSysPeriod)
DatabaseConfig	setAsOfViewSuffix(String asOfViewSuffix)
DatabaseConfig	setAutoPersistUpdates(boolean autoPersistUpdates)
DatabaseConfig	setAutoReadOnlyDataSource(boolean autoReadOnlyDataSource)
DatabaseConfig	setAutoTuneConfig(AutoTuneConfig autoTuneConfig)
DatabaseConfig	setBackgroundExecutorSchedulePoolSize(int backgroundExecutorSchedulePoolSize)
DatabaseConfig	setBackgroundExecutorShutdownSecs(int backgroundExecutorShutdownSecs)
DatabaseConfig	setBackgroundExecutorWrapper(BackgroundExecutorWrapper backgroundExecutorWrapper)
DatabaseConfig	setCacheMaxIdleTime(int cacheMaxIdleTime)
DatabaseConfig	setCacheMaxSize(int cacheMaxSize)
DatabaseConfig	setCacheMaxTimeToLive(int cacheMaxTimeToLive)
DatabaseConfig	setChangeLogAsync(boolean changeLogAsync)
DatabaseConfig	setChangeLogIncludeInserts(boolean changeLogIncludeInserts)
DatabaseConfig	setChangeLogListener(ChangeLogListener changeLogListener)
DatabaseConfig	setChangeLogPrepare(ChangeLogPrepare changeLogPrepare)
DatabaseConfig	setChangeLogRegister(ChangeLogRegister changeLogRegister)
void	setClasses(Collection<Class<?>> classes)	Set the list of classes (entities, listeners, scalarTypes etc) that should be used for this database.
DatabaseConfig	setClassLoadConfig(ClassLoadConfig classLoadConfig)
DatabaseConfig	setClock(Clock clock)
DatabaseConfig	setConstraintNaming(DbConstraintNaming constraintNaming)
DatabaseConfig	setContainerConfig(ContainerConfig containerConfig)
DatabaseConfig	setCurrentTenantProvider(CurrentTenantProvider currentTenantProvider)
DatabaseConfig	setCurrentUserProvider(CurrentUserProvider currentUserProvider)
DatabaseConfig	setDatabaseBooleanFalse(String databaseFalse)
DatabaseConfig	setDatabaseBooleanTrue(String databaseTrue)
DatabaseConfig	setDatabasePlatform(DatabasePlatform databasePlatform)
DatabaseConfig	setDatabasePlatformName(String databasePlatformName)
DatabaseConfig	setDatabaseSequenceBatch(int databaseSequenceBatchSize)
DatabaseConfig	setDatabaseSequenceBatchSize(int databaseSequenceBatchSize)
DatabaseConfig	setDataSource(DataSource dataSource)
DatabaseConfig	setDataSourceConfig(io.ebean.datasource.DataSourceBuilder dataSourceConfig)
DatabaseConfig	setDataTimeZone(String dataTimeZone)
DatabaseConfig	setDbEncrypt(DbEncrypt dbEncrypt)
DatabaseConfig	setDbOffline(boolean dbOffline)
DatabaseConfig	setDbSchema(String dbSchema)
DatabaseConfig	setDbUuid(PlatformConfig.DbUuid dbUuid)
DatabaseConfig	setDdlCreateOnly(boolean ddlCreateOnly)
DatabaseConfig	setDdlExtra(boolean ddlExtra)
DatabaseConfig	setDdlGenerate(boolean ddlGenerate)
DatabaseConfig	setDdlHeader(String ddlHeader)
DatabaseConfig	setDdlInitSql(String ddlInitSql)
DatabaseConfig	setDdlPlaceholderMap(Map<String,String> ddlPlaceholderMap)
DatabaseConfig	setDdlPlaceholders(String ddlPlaceholders)
DatabaseConfig	setDdlRun(boolean ddlRun)
DatabaseConfig	setDdlSeedSql(String ddlSeedSql)
DatabaseConfig	setDdlStrictMode(boolean ddlStrictMode)
DatabaseConfig	setDefaultEnumType(jakarta.persistence.EnumType defaultEnumType)
DatabaseConfig	setDefaultServer(boolean defaultServer)
DatabaseConfig	setDisableClasspathSearch(boolean disableClasspathSearch)
DatabaseConfig	setDisableL2Cache(boolean disableL2Cache)
DatabaseConfig	setDisableLazyLoading(boolean disableLazyLoading)
DatabaseConfig	setDumpMetricsOnShutdown(boolean dumpMetricsOnShutdown)
DatabaseConfig	setDumpMetricsOptions(String dumpMetricsOptions)
DatabaseConfig	setDurationWithNanos(boolean durationWithNanos)
DatabaseConfig	setEagerFetchLobs(boolean eagerFetchLobs)
DatabaseConfig	setEnabledL2Regions(String enabledL2Regions)
DatabaseConfig	setEncryptDeployManager(EncryptDeployManager encryptDeployManager)
DatabaseConfig	setEncryptKeyManager(EncryptKeyManager encryptKeyManager)
DatabaseConfig	setEncryptor(Encryptor encryptor)
DatabaseConfig	setExpressionEqualsWithNullAsNoop(boolean expressionEqualsWithNullAsNoop)
DatabaseConfig	setExpressionNativeIlike(boolean expressionNativeIlike)
DatabaseConfig	setExternalTransactionManager(ExternalTransactionManager externalTransactionManager)
DatabaseConfig	setFindControllers(List<BeanFindController> findControllers)	Set the list of BeanFindController instances.
DatabaseConfig	setGeometrySRID(int geometrySRID)
DatabaseConfig	setHistoryTableSuffix(String historyTableSuffix)
DatabaseConfig	setIdGeneratorAutomatic(boolean idGeneratorAutomatic)
DatabaseConfig	setIdGenerators(List<IdGenerator> idGenerators)	Set the custom IdGenerator instances.
DatabaseConfig	setIdType(IdType idType)
DatabaseConfig	setJdbcFetchSizeFindEach(int jdbcFetchSizeFindEach)
DatabaseConfig	setJdbcFetchSizeFindList(int jdbcFetchSizeFindList)
DatabaseConfig	setJodaLocalTimeMode(String jodaLocalTimeMode)
DatabaseConfig	setJsonDate(JsonConfig.Date jsonDate)
DatabaseConfig	setJsonDateTime(JsonConfig.DateTime jsonDateTime)
DatabaseConfig	setJsonFactory(com.fasterxml.jackson.core.JsonFactory jsonFactory)
DatabaseConfig	setJsonInclude(JsonConfig.Include jsonInclude)
DatabaseConfig	setJsonMutationDetection(io.ebean.annotation.MutationDetection jsonMutationDetection)
DatabaseConfig	setLazyLoadBatchSize(int lazyLoadBatchSize)
DatabaseConfig	setLoadModuleInfo(boolean loadModuleInfo)
DatabaseConfig	setLocalOnlyL2Cache(boolean localOnlyL2Cache)
DatabaseConfig	setLocalTimeWithNanos(boolean localTimeWithNanos)
DatabaseConfig	setMappingLocations(List<String> mappingLocations)
DatabaseConfig	setMaxCallStack(int maxCallStack)
DatabaseConfig	setMetricNaming(Function<String,String> metricNaming)
DatabaseConfig	setName(String name)
DatabaseConfig	setNamingConvention(NamingConvention namingConvention)
DatabaseConfig	setNotifyL2CacheInForeground(boolean notifyL2CacheInForeground)
DatabaseConfig	setObjectMapper(Object objectMapper)
DatabaseConfig	setPackages(List<String> packages)	Set packages to search for entities via class path search.
DatabaseConfig	setPersistBatch(io.ebean.annotation.PersistBatch persistBatch)
DatabaseConfig	setPersistBatching(boolean persistBatching)
DatabaseConfig	setPersistBatchOnCascade(io.ebean.annotation.PersistBatch persistBatchOnCascade)
DatabaseConfig	setPersistBatchSize(int persistBatchSize)
DatabaseConfig	setPersistControllers(List<BeanPersistController> persistControllers)	Register all the BeanPersistController instances.
DatabaseConfig	setPersistenceContextScope(PersistenceContextScope persistenceContextScope)
DatabaseConfig	setPersistListeners(List<BeanPersistListener> persistListeners)	Register all the BeanPersistListener instances.
DatabaseConfig	setPlatformConfig(PlatformConfig platformConfig)
DatabaseConfig	setPostConstructListeners(List<BeanPostConstructListener> listeners)	Set the list of BeanPostLoader instances.
DatabaseConfig	setPostLoaders(List<BeanPostLoad> postLoaders)	Set the list of BeanPostLoader instances.
DatabaseConfig	setProfilingConfig(ProfilingConfig profilingConfig)
DatabaseConfig	setQueryAdapters(List<BeanQueryAdapter> queryAdapters)	Register all the BeanQueryAdapter instances.
DatabaseConfig	setQueryBatchSize(int queryBatchSize)
DatabaseConfig	setQueryCacheMaxIdleTime(int queryCacheMaxIdleTime)
DatabaseConfig	setQueryCacheMaxSize(int queryCacheMaxSize)
DatabaseConfig	setQueryCacheMaxTimeToLive(int queryCacheMaxTimeToLive)
DatabaseConfig	setQueryPlanCapture(boolean queryPlanCapture)
DatabaseConfig	setQueryPlanCaptureMaxCount(int queryPlanCaptureMaxCount)
DatabaseConfig	setQueryPlanCaptureMaxTimeMillis(long queryPlanCaptureMaxTimeMillis)
DatabaseConfig	setQueryPlanCapturePeriodSecs(long queryPlanCapturePeriodSecs)
DatabaseConfig	setQueryPlanEnable(boolean queryPlanEnable)
DatabaseConfig	setQueryPlanListener(QueryPlanListener queryPlanListener)
DatabaseConfig	setQueryPlanThresholdMicros(long queryPlanThresholdMicros)
DatabaseConfig	setQueryPlanTTLSeconds(int queryPlanTTLSeconds)
DatabaseConfig	setReadOnlyDataSource(DataSource readOnlyDataSource)
DatabaseConfig	setReadOnlyDataSourceConfig(io.ebean.datasource.DataSourceBuilder readOnly)
DatabaseConfig	setRegister(boolean register)
DatabaseConfig	setResourceDirectory(String resourceDirectory)
DatabaseConfig	setRunMigration(boolean runMigration)
DatabaseConfig	setServerCachePlugin(ServerCachePlugin serverCachePlugin)
DatabaseConfig	setSkipCacheAfterWrite(boolean skipCacheAfterWrite)
DatabaseConfig	setSkipDataSourceCheck(boolean skipDataSourceCheck)
DatabaseConfig	setSlowQueryListener(SlowQueryListener slowQueryListener)
DatabaseConfig	setSlowQueryMillis(long slowQueryMillis)
DatabaseConfig	setTenantCatalogProvider(TenantCatalogProvider tenantCatalogProvider)
DatabaseConfig	setTenantDataSourceProvider(TenantDataSourceProvider tenantDataSourceProvider)
DatabaseConfig	setTenantMode(TenantMode tenantMode)
DatabaseConfig	setTenantPartitionColumn(String tenantPartitionColumn)
DatabaseConfig	setTenantSchemaProvider(TenantSchemaProvider tenantSchemaProvider)
DatabaseBuilder.Settings	settings()	Return the settings to read the configuration that has been set.
DatabaseConfig	setTransactionRollbackOnChecked(boolean transactionRollbackOnChecked)
DatabaseConfig	setUpdateAllPropertiesInBatch(boolean updateAllPropertiesInBatch)
DatabaseConfig	setUseJtaTransactionManager(boolean useJtaTransactionManager)
DatabaseConfig	setUseValidationNotNull(boolean useValidationNotNull)
DatabaseConfig	setUuidNodeId(String uuidNodeId)
DatabaseConfig	setUuidStateFile(String uuidStateFile)
DatabaseConfig	setUuidVersion(DatabaseConfig.UuidVersion uuidVersion)
boolean	skipDataSourceCheck()	Return true if the startup DataSource check should be skipped.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.DatabaseBuilder

allQuotedIdentifiers, alsoIf, asOfSysPeriod, asOfViewSuffix, autoPersistUpdates, autoReadOnlyDataSource, autoTuneConfig, backgroundExecutorSchedulePoolSize, backgroundExecutorShutdownSecs, backgroundExecutorWrapper, cacheMaxIdleTime, cacheMaxSize, cacheMaxTimeToLive, changeLogAsync, changeLogIncludeInserts, changeLogListener, changeLogPrepare, changeLogRegister, classLoadConfig, clock, constraintNaming, containerConfig, currentTenantProvider, currentUserProvider, databaseBooleanFalse, databaseBooleanTrue, databasePlatform, databasePlatformName, databaseSequenceBatch, databaseSequenceBatchSize, dataSource, dataSourceBuilder, dataTimeZone, dbEncrypt, dbSchema, dbUuid, ddlCreateOnly, ddlExtra, ddlGenerate, ddlHeader, ddlInitSql, ddlPlaceholderMap, ddlPlaceholders, ddlRun, ddlSeedSql, ddlStrictMode, defaultDatabase, defaultEnumType, disableClasspathSearch, disableL2Cache, disableLazyLoading, dumpMetricsOnShutdown, dumpMetricsOptions, durationWithNanos, eagerFetchLobs, enabledL2Regions, encryptDeployManager, encryptKeyManager, encryptor, expressionEqualsWithNullAsNoop, expressionNativeIlike, externalTransactionManager, geometrySRID, historyTableSuffix, idGeneratorAutomatic, idType, jdbcFetchSizeFindEach, jdbcFetchSizeFindList, jodaLocalTimeMode, jsonDate, jsonDateTime, jsonFactory, jsonInclude, jsonMutationDetection, lazyLoadBatchSize, loadModuleInfo, localOnlyL2Cache, localTimeWithNanos, mappingLocations, maxCallStack, metricNaming, name, namingConvention, notifyL2CacheInForeground, objectMapper, offline, persistBatch, persistBatching, persistBatchOnCascade, persistBatchSize, persistenceContextScope, platformConfig, profilingConfig, queryBatchSize, queryCacheMaxIdleTime, queryCacheMaxSize, queryCacheMaxTimeToLive, queryPlanCapture, queryPlanCaptureMaxCount, queryPlanCaptureMaxTimeMillis, queryPlanCapturePeriodSecs, queryPlanEnable, queryPlanListener, queryPlanThresholdMicros, queryPlanTTLSeconds, readOnlyDataSource, readOnlyDataSourceBuilder, register, resourceDirectory, runMigration, serverCachePlugin, skipCacheAfterWrite, skipDataSourceCheck, slowQueryListener, slowQueryMillis, tenantCatalogProvider, tenantDataSourceProvider, tenantMode, tenantPartitionColumn, tenantSchemaProvider, transactionRollbackOnChecked, updateAllPropertiesInBatch, useJtaTransactionManager, useValidationNotNull, uuidNodeId, uuidStateFile, uuidVersion

Constructor Details

DatabaseConfig

public DatabaseConfig()

Construct a Database Configuration for programmatically creating an Database.

Method Details

build

public Database build()

Description copied from interface: DatabaseBuilder

Build and return the Database instance.

Specified by:

build in interface DatabaseBuilder

settings

public DatabaseBuilder.Settings settings()

Description copied from interface: DatabaseBuilder

Return the settings to read the configuration that has been set. This provides the getters/accessors to read the configuration properties.

Specified by:

settings in interface DatabaseBuilder

apply

public DatabaseBuilder apply(Consumer<DatabaseBuilder.Settings> applyConfiguration)

Description copied from interface: DatabaseBuilder

Apply configuration to this builder using a lambda.

Specified by:

apply in interface DatabaseBuilder

getClock

public Clock getClock()

Description copied from interface: DatabaseBuilder.Settings

Get the clock used for setting the timestamps (e.g. @UpdatedTimestamp) on objects.

Specified by:

getClock in interface DatabaseBuilder.Settings

setClock

public DatabaseConfig setClock(Clock clock)

Specified by:

setClock in interface DatabaseBuilder

getSlowQueryMillis

public long getSlowQueryMillis()

Description copied from interface: DatabaseBuilder.Settings

Return the slow query time in millis.

Specified by:

getSlowQueryMillis in interface DatabaseBuilder.Settings

setSlowQueryMillis

public DatabaseConfig setSlowQueryMillis(long slowQueryMillis)

Specified by:

setSlowQueryMillis in interface DatabaseBuilder

getSlowQueryListener

public SlowQueryListener getSlowQueryListener()

Description copied from interface: DatabaseBuilder.Settings

Return the slow query event listener.

Specified by:

getSlowQueryListener in interface DatabaseBuilder.Settings

setSlowQueryListener

public DatabaseConfig setSlowQueryListener(SlowQueryListener slowQueryListener)

Specified by:

setSlowQueryListener in interface DatabaseBuilder

putServiceObject

public DatabaseConfig putServiceObject(String key,
 Object configObject)

Description copied from interface: DatabaseBuilder

Put a service object into configuration such that it can be used by ebean or a plugin.

For example, put IgniteConfiguration in to be passed to the Ignite plugin.

Specified by:

putServiceObject in interface DatabaseBuilder

putServiceObject

public <T> DatabaseConfig putServiceObject(Class<T> iface,
 T configObject)

Description copied from interface: DatabaseBuilder

Put a service object into configuration such that it can be used by ebean or a plugin.

For example, put IgniteConfiguration in to be passed to the Ignite plugin. You can also override some SPI objects that should be used for that Database. Currently, the following objects are possible.

• DataSourceAlertFactory (e.g. add different alert factories for different ebean instances)
• DocStoreFactory
• SlowQueryListener (e.g. add custom query listener for a certain ebean instance)
• ServerCacheNotifyPlugin

Specified by:

putServiceObject in interface DatabaseBuilder

getServiceObject

public Object getServiceObject(String key)

Description copied from interface: DatabaseBuilder.Settings

Return the service object given the key.

Specified by:

getServiceObject in interface DatabaseBuilder.Settings

putServiceObject

public DatabaseConfig putServiceObject(Object configObject)

Description copied from interface: DatabaseBuilder

Put a service object into configuration such that it can be used by ebean or a plugin.

   JedisPool jedisPool = ..

   config.putServiceObject(jedisPool);

 

Specified by:

putServiceObject in interface DatabaseBuilder

getServiceObject

public <P> P getServiceObject(Class<P> cls)

Description copied from interface: DatabaseBuilder.Settings

Used by ebean or plugins to obtain service objects.

   JedisPool jedisPool = config.getServiceObject(JedisPool.class);

 

Specified by:

getServiceObject in interface DatabaseBuilder.Settings

Parameters:

cls - The type of the service object to obtain

Returns:

The service object given the class type

getJsonFactory

public com.fasterxml.jackson.core.JsonFactory getJsonFactory()

Description copied from interface: DatabaseBuilder.Settings

Return the Jackson JsonFactory to use.

If not set a default implementation will be used.

Specified by:

getJsonFactory in interface DatabaseBuilder.Settings

setJsonFactory

public DatabaseConfig setJsonFactory(com.fasterxml.jackson.core.JsonFactory jsonFactory)

Specified by:

setJsonFactory in interface DatabaseBuilder

getJsonDateTime

public JsonConfig.DateTime getJsonDateTime()

Description copied from interface: DatabaseBuilder.Settings

Return the JSON format used for DateTime types.

Specified by:

getJsonDateTime in interface DatabaseBuilder.Settings

setJsonDateTime

public DatabaseConfig setJsonDateTime(JsonConfig.DateTime jsonDateTime)

Specified by:

setJsonDateTime in interface DatabaseBuilder

getJsonDate

public JsonConfig.Date getJsonDate()

Description copied from interface: DatabaseBuilder.Settings

Return the JSON format used for Date types.

Specified by:

getJsonDate in interface DatabaseBuilder.Settings

setJsonDate

public DatabaseConfig setJsonDate(JsonConfig.Date jsonDate)

Specified by:

setJsonDate in interface DatabaseBuilder

getJsonInclude

public JsonConfig.Include getJsonInclude()

Description copied from interface: DatabaseBuilder.Settings

Return the JSON include mode used when writing JSON.

Specified by:

getJsonInclude in interface DatabaseBuilder.Settings

setJsonInclude

public DatabaseConfig setJsonInclude(JsonConfig.Include jsonInclude)

Specified by:

setJsonInclude in interface DatabaseBuilder

getJsonMutationDetection

public io.ebean.annotation.MutationDetection getJsonMutationDetection()

Description copied from interface: DatabaseBuilder.Settings

Return the default MutableDetection to use with @DbJson using Jackson.

Specified by:

getJsonMutationDetection in interface DatabaseBuilder.Settings

See Also:

• DbJson.mutationDetection()

setJsonMutationDetection

public DatabaseConfig setJsonMutationDetection(io.ebean.annotation.MutationDetection jsonMutationDetection)

Specified by:

setJsonMutationDetection in interface DatabaseBuilder

getName

public String getName()

Description copied from interface: DatabaseBuilder.Settings

Return the name of the Database.

Specified by:

getName in interface DatabaseBuilder.Settings

setName

public DatabaseConfig setName(String name)

Specified by:

setName in interface DatabaseBuilder

getContainerConfig

public ContainerConfig getContainerConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the container / clustering configuration.

The container holds all the Database instances and provides clustering communication services to all the Database instances.

Specified by:

getContainerConfig in interface DatabaseBuilder.Settings

setContainerConfig

public DatabaseConfig setContainerConfig(ContainerConfig containerConfig)

Specified by:

setContainerConfig in interface DatabaseBuilder

isRegister

public boolean isRegister()

Description copied from interface: DatabaseBuilder.Settings

Return true if this server should be registered with the Ebean singleton when it is created.

By default this is set to true.

Specified by:

isRegister in interface DatabaseBuilder.Settings

setRegister

public DatabaseConfig setRegister(boolean register)

Specified by:

setRegister in interface DatabaseBuilder

isDefaultServer

public boolean isDefaultServer()

Description copied from interface: DatabaseBuilder.Settings

Return true if this server should be registered as the "default" server with the Ebean singleton.

This is only used when DatabaseBuilder.setRegister(boolean) is also true.

Specified by:

isDefaultServer in interface DatabaseBuilder.Settings

setDefaultServer

public DatabaseConfig setDefaultServer(boolean defaultServer)

Specified by:

setDefaultServer in interface DatabaseBuilder

getCurrentUserProvider

public CurrentUserProvider getCurrentUserProvider()

Description copied from interface: DatabaseBuilder.Settings

Return the CurrentUserProvider. This is used to populate @WhoCreated, @WhoModified and support other audit features (who executed a query etc).

Specified by:

getCurrentUserProvider in interface DatabaseBuilder.Settings

setCurrentUserProvider

public DatabaseConfig setCurrentUserProvider(CurrentUserProvider currentUserProvider)

Specified by:

setCurrentUserProvider in interface DatabaseBuilder

getTenantMode

public TenantMode getTenantMode()

Description copied from interface: DatabaseBuilder.Settings

Return the tenancy mode used.

Specified by:

getTenantMode in interface DatabaseBuilder.Settings

setTenantMode

public DatabaseConfig setTenantMode(TenantMode tenantMode)

Specified by:

setTenantMode in interface DatabaseBuilder

getTenantPartitionColumn

public String getTenantPartitionColumn()

Description copied from interface: DatabaseBuilder.Settings

Return the column name used for TenantMode.PARTITION.

Specified by:

getTenantPartitionColumn in interface DatabaseBuilder.Settings

setTenantPartitionColumn

public DatabaseConfig setTenantPartitionColumn(String tenantPartitionColumn)

Specified by:

setTenantPartitionColumn in interface DatabaseBuilder

getCurrentTenantProvider

public CurrentTenantProvider getCurrentTenantProvider()

Description copied from interface: DatabaseBuilder.Settings

Return the current tenant provider.

Specified by:

getCurrentTenantProvider in interface DatabaseBuilder.Settings

setCurrentTenantProvider

public DatabaseConfig setCurrentTenantProvider(CurrentTenantProvider currentTenantProvider)

Specified by:

setCurrentTenantProvider in interface DatabaseBuilder

getTenantDataSourceProvider

public TenantDataSourceProvider getTenantDataSourceProvider()

Description copied from interface: DatabaseBuilder.Settings

Return the tenancy datasource provider.

Specified by:

getTenantDataSourceProvider in interface DatabaseBuilder.Settings

setTenantDataSourceProvider

public DatabaseConfig setTenantDataSourceProvider(TenantDataSourceProvider tenantDataSourceProvider)

Specified by:

setTenantDataSourceProvider in interface DatabaseBuilder

getTenantSchemaProvider

public TenantSchemaProvider getTenantSchemaProvider()

Description copied from interface: DatabaseBuilder.Settings

Return the tenancy schema provider.

Specified by:

getTenantSchemaProvider in interface DatabaseBuilder.Settings

setTenantSchemaProvider

public DatabaseConfig setTenantSchemaProvider(TenantSchemaProvider tenantSchemaProvider)

Specified by:

setTenantSchemaProvider in interface DatabaseBuilder

getTenantCatalogProvider

public TenantCatalogProvider getTenantCatalogProvider()

Description copied from interface: DatabaseBuilder.Settings

Return the tenancy catalog provider.

Specified by:

getTenantCatalogProvider in interface DatabaseBuilder.Settings

setTenantCatalogProvider

public DatabaseConfig setTenantCatalogProvider(TenantCatalogProvider tenantCatalogProvider)

Specified by:

setTenantCatalogProvider in interface DatabaseBuilder

isAutoPersistUpdates

public boolean isAutoPersistUpdates()

Description copied from interface: DatabaseBuilder.Settings

Return true if dirty beans are automatically persisted.

Specified by:

isAutoPersistUpdates in interface DatabaseBuilder.Settings

setAutoPersistUpdates

public DatabaseConfig setAutoPersistUpdates(boolean autoPersistUpdates)

Specified by:

setAutoPersistUpdates in interface DatabaseBuilder

getPersistBatch

public io.ebean.annotation.PersistBatch getPersistBatch()

Description copied from interface: DatabaseBuilder.Settings

Return the PersistBatch mode to use by default at the transaction level.

When INSERT or ALL is used then save(), delete() etc do not execute immediately but instead go into a JDBC batch execute buffer that is flushed. The buffer is flushed if a query is executed, transaction ends or the batch size is meet.

Specified by:

getPersistBatch in interface DatabaseBuilder.Settings

setPersistBatch

public DatabaseConfig setPersistBatch(io.ebean.annotation.PersistBatch persistBatch)

Specified by:

setPersistBatch in interface DatabaseBuilder

getPersistBatchOnCascade

public io.ebean.annotation.PersistBatch getPersistBatchOnCascade()

Description copied from interface: DatabaseBuilder.Settings

Return the JDBC batch mode to use per save(), delete(), insert() or update() request.

This makes sense when a save() or delete() cascades and executes multiple child statements. The best case for this is when saving a master/parent bean this cascade inserts many detail/child beans.

This only takes effect when the persistBatch mode at the transaction level does not take effect.

Specified by:

getPersistBatchOnCascade in interface DatabaseBuilder.Settings

setPersistBatchOnCascade

public DatabaseConfig setPersistBatchOnCascade(io.ebean.annotation.PersistBatch persistBatchOnCascade)

Specified by:

setPersistBatchOnCascade in interface DatabaseBuilder

setPersistBatching

public DatabaseConfig setPersistBatching(boolean persistBatching)

Specified by:

setPersistBatching in interface DatabaseBuilder

getPersistBatchSize

public int getPersistBatchSize()

Description copied from interface: DatabaseBuilder.Settings

Return the batch size used for JDBC batching. This defaults to 20.

Specified by:

getPersistBatchSize in interface DatabaseBuilder.Settings

setPersistBatchSize

public DatabaseConfig setPersistBatchSize(int persistBatchSize)

Specified by:

setPersistBatchSize in interface DatabaseBuilder

getQueryBatchSize

public int getQueryBatchSize()

Description copied from interface: DatabaseBuilder.Settings

Gets the query batch size. This defaults to 100.

Specified by:

getQueryBatchSize in interface DatabaseBuilder.Settings

Returns:

the query batch size

setQueryBatchSize

public DatabaseConfig setQueryBatchSize(int queryBatchSize)

Specified by:

setQueryBatchSize in interface DatabaseBuilder

getDefaultEnumType

public jakarta.persistence.EnumType getDefaultEnumType()

Specified by:

getDefaultEnumType in interface DatabaseBuilder.Settings

setDefaultEnumType

public DatabaseConfig setDefaultEnumType(jakarta.persistence.EnumType defaultEnumType)

Specified by:

setDefaultEnumType in interface DatabaseBuilder

isDisableLazyLoading

public boolean isDisableLazyLoading()

Description copied from interface: DatabaseBuilder.Settings

Return true if lazy loading is disabled on queries by default.

Specified by:

isDisableLazyLoading in interface DatabaseBuilder.Settings

setDisableLazyLoading

public DatabaseConfig setDisableLazyLoading(boolean disableLazyLoading)

Specified by:

setDisableLazyLoading in interface DatabaseBuilder

getLazyLoadBatchSize

public int getLazyLoadBatchSize()

Description copied from interface: DatabaseBuilder.Settings

Return the default batch size for lazy loading of beans and collections.

Specified by:

getLazyLoadBatchSize in interface DatabaseBuilder.Settings

setLazyLoadBatchSize

public DatabaseConfig setLazyLoadBatchSize(int lazyLoadBatchSize)

Specified by:

setLazyLoadBatchSize in interface DatabaseBuilder

setDatabaseSequenceBatchSize

public DatabaseConfig setDatabaseSequenceBatchSize(int databaseSequenceBatchSize)

Specified by:

setDatabaseSequenceBatchSize in interface DatabaseBuilder

getJdbcFetchSizeFindList

public int getJdbcFetchSizeFindList()

Description copied from interface: DatabaseBuilder.Settings

Return the default JDBC fetchSize hint for findList queries.

Specified by:

getJdbcFetchSizeFindList in interface DatabaseBuilder.Settings

setJdbcFetchSizeFindList

public DatabaseConfig setJdbcFetchSizeFindList(int jdbcFetchSizeFindList)

Specified by:

setJdbcFetchSizeFindList in interface DatabaseBuilder

getJdbcFetchSizeFindEach

public int getJdbcFetchSizeFindEach()

Description copied from interface: DatabaseBuilder.Settings

Return the default JDBC fetchSize hint for findEach/findEachWhile queries.

Specified by:

getJdbcFetchSizeFindEach in interface DatabaseBuilder.Settings

setJdbcFetchSizeFindEach

public DatabaseConfig setJdbcFetchSizeFindEach(int jdbcFetchSizeFindEach)

Specified by:

setJdbcFetchSizeFindEach in interface DatabaseBuilder

getChangeLogPrepare

public ChangeLogPrepare getChangeLogPrepare()

Description copied from interface: DatabaseBuilder.Settings

Return the ChangeLogPrepare.

This is used to set user context information to the ChangeSet in the foreground thread prior to the logging occurring in a background thread.

Specified by:

getChangeLogPrepare in interface DatabaseBuilder.Settings

setChangeLogPrepare

public DatabaseConfig setChangeLogPrepare(ChangeLogPrepare changeLogPrepare)

Specified by:

setChangeLogPrepare in interface DatabaseBuilder

getChangeLogListener

public ChangeLogListener getChangeLogListener()

Description copied from interface: DatabaseBuilder.Settings

Return the ChangeLogListener which actually performs the logging of change sets in the background.

Specified by:

getChangeLogListener in interface DatabaseBuilder.Settings

setChangeLogListener

public DatabaseConfig setChangeLogListener(ChangeLogListener changeLogListener)

Specified by:

setChangeLogListener in interface DatabaseBuilder

getChangeLogRegister

public ChangeLogRegister getChangeLogRegister()

Description copied from interface: DatabaseBuilder.Settings

Return the ChangeLogRegister which controls which ChangeLogFilter is used for each bean type and in this way provide fine grained control over which persist requests are included in the change log.

Specified by:

getChangeLogRegister in interface DatabaseBuilder.Settings

setChangeLogRegister

public DatabaseConfig setChangeLogRegister(ChangeLogRegister changeLogRegister)

Specified by:

setChangeLogRegister in interface DatabaseBuilder

isChangeLogIncludeInserts

public boolean isChangeLogIncludeInserts()

Description copied from interface: DatabaseBuilder.Settings

Return true if inserts should be included in the change log by default.

Specified by:

isChangeLogIncludeInserts in interface DatabaseBuilder.Settings

setChangeLogIncludeInserts

public DatabaseConfig setChangeLogIncludeInserts(boolean changeLogIncludeInserts)

Specified by:

setChangeLogIncludeInserts in interface DatabaseBuilder

isChangeLogAsync

public boolean isChangeLogAsync()

Description copied from interface: DatabaseBuilder.Settings

Return true (default) if the changelog should be written async.

Specified by:

isChangeLogAsync in interface DatabaseBuilder.Settings

setChangeLogAsync

public DatabaseConfig setChangeLogAsync(boolean changeLogAsync)

Specified by:

setChangeLogAsync in interface DatabaseBuilder

getProfilingConfig

public ProfilingConfig getProfilingConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the configuration for profiling.

Specified by:

getProfilingConfig in interface DatabaseBuilder.Settings

setProfilingConfig

public DatabaseConfig setProfilingConfig(ProfilingConfig profilingConfig)

Specified by:

setProfilingConfig in interface DatabaseBuilder

getDbSchema

public String getDbSchema()

Description copied from interface: DatabaseBuilder.Settings

Return the DB schema to use.

Specified by:

getDbSchema in interface DatabaseBuilder.Settings

setDbSchema

public DatabaseConfig setDbSchema(String dbSchema)

Specified by:

setDbSchema in interface DatabaseBuilder

getGeometrySRID

public int getGeometrySRID()

Description copied from interface: DatabaseBuilder.Settings

Return the Geometry SRID.

Specified by:

getGeometrySRID in interface DatabaseBuilder.Settings

setGeometrySRID

public DatabaseConfig setGeometrySRID(int geometrySRID)

Specified by:

setGeometrySRID in interface DatabaseBuilder

getDataTimeZone

public String getDataTimeZone()

Description copied from interface: DatabaseBuilder.Settings

Return the time zone to use when reading/writing Timestamps via JDBC.

When set a Calendar object is used in JDBC calls when reading/writing Timestamp objects.

Specified by:

getDataTimeZone in interface DatabaseBuilder.Settings

setDataTimeZone

public DatabaseConfig setDataTimeZone(String dataTimeZone)

Specified by:

setDataTimeZone in interface DatabaseBuilder

getAsOfViewSuffix

public String getAsOfViewSuffix()

Description copied from interface: DatabaseBuilder.Settings

Return the suffix appended to the base table to derive the view that contains the union of the base table and the history table in order to support asOf queries.

Specified by:

getAsOfViewSuffix in interface DatabaseBuilder.Settings

setAsOfViewSuffix

public DatabaseConfig setAsOfViewSuffix(String asOfViewSuffix)

Specified by:

setAsOfViewSuffix in interface DatabaseBuilder

getAsOfSysPeriod

public String getAsOfSysPeriod()

Description copied from interface: DatabaseBuilder.Settings

Return the database column used to support history and 'As of' queries. This column is a timestamp range or equivalent.

Specified by:

getAsOfSysPeriod in interface DatabaseBuilder.Settings

setAsOfSysPeriod

public DatabaseConfig setAsOfSysPeriod(String asOfSysPeriod)

Specified by:

setAsOfSysPeriod in interface DatabaseBuilder

getHistoryTableSuffix

public String getHistoryTableSuffix()

Description copied from interface: DatabaseBuilder.Settings

Return the history table suffix (defaults to _history).

Specified by:

getHistoryTableSuffix in interface DatabaseBuilder.Settings

setHistoryTableSuffix

public DatabaseConfig setHistoryTableSuffix(String historyTableSuffix)

Specified by:

setHistoryTableSuffix in interface DatabaseBuilder

isUseJtaTransactionManager

public boolean isUseJtaTransactionManager()

Description copied from interface: DatabaseBuilder.Settings

Return true if we are running in a JTA Transaction manager.

Specified by:

isUseJtaTransactionManager in interface DatabaseBuilder.Settings

setUseJtaTransactionManager

public DatabaseConfig setUseJtaTransactionManager(boolean useJtaTransactionManager)

Specified by:

setUseJtaTransactionManager in interface DatabaseBuilder

getExternalTransactionManager

public ExternalTransactionManager getExternalTransactionManager()

Description copied from interface: DatabaseBuilder.Settings

Return the external transaction manager.

Specified by:

getExternalTransactionManager in interface DatabaseBuilder.Settings

setExternalTransactionManager

public DatabaseConfig setExternalTransactionManager(ExternalTransactionManager externalTransactionManager)

Specified by:

setExternalTransactionManager in interface DatabaseBuilder

getServerCachePlugin

public ServerCachePlugin getServerCachePlugin()

Description copied from interface: DatabaseBuilder.Settings

Return the ServerCachePlugin.

Specified by:

getServerCachePlugin in interface DatabaseBuilder.Settings

setServerCachePlugin

public DatabaseConfig setServerCachePlugin(ServerCachePlugin serverCachePlugin)

Specified by:

setServerCachePlugin in interface DatabaseBuilder

isEagerFetchLobs

public boolean isEagerFetchLobs()

Description copied from interface: DatabaseBuilder.Settings

Return true if LOB's should default to fetch eager. By default this is set to false and LOB's must be explicitly fetched.

Specified by:

isEagerFetchLobs in interface DatabaseBuilder.Settings

setEagerFetchLobs

public DatabaseConfig setEagerFetchLobs(boolean eagerFetchLobs)

Specified by:

setEagerFetchLobs in interface DatabaseBuilder

getMaxCallStack

public int getMaxCallStack()

Description copied from interface: DatabaseBuilder.Settings

Return the max call stack to use for origin location.

Specified by:

getMaxCallStack in interface DatabaseBuilder.Settings

setMaxCallStack

public DatabaseConfig setMaxCallStack(int maxCallStack)

Specified by:

setMaxCallStack in interface DatabaseBuilder

isTransactionRollbackOnChecked

public boolean isTransactionRollbackOnChecked()

Description copied from interface: DatabaseBuilder.Settings

Return true if transactions should rollback on checked exceptions.

Specified by:

isTransactionRollbackOnChecked in interface DatabaseBuilder.Settings

setTransactionRollbackOnChecked

public DatabaseConfig setTransactionRollbackOnChecked(boolean transactionRollbackOnChecked)

Specified by:

setTransactionRollbackOnChecked in interface DatabaseBuilder

getBackgroundExecutorSchedulePoolSize

public int getBackgroundExecutorSchedulePoolSize()

Description copied from interface: DatabaseBuilder.Settings

Return the Background executor schedule pool size. Defaults to 1.

Specified by:

getBackgroundExecutorSchedulePoolSize in interface DatabaseBuilder.Settings

setBackgroundExecutorSchedulePoolSize

public DatabaseConfig setBackgroundExecutorSchedulePoolSize(int backgroundExecutorSchedulePoolSize)

Specified by:

setBackgroundExecutorSchedulePoolSize in interface DatabaseBuilder

getBackgroundExecutorShutdownSecs

public int getBackgroundExecutorShutdownSecs()

Description copied from interface: DatabaseBuilder.Settings

Return the Background executor shutdown seconds. This is the time allowed for the pool to shutdown nicely before it is forced shutdown.

Specified by:

getBackgroundExecutorShutdownSecs in interface DatabaseBuilder.Settings

setBackgroundExecutorShutdownSecs

public DatabaseConfig setBackgroundExecutorShutdownSecs(int backgroundExecutorShutdownSecs)

Specified by:

setBackgroundExecutorShutdownSecs in interface DatabaseBuilder

getBackgroundExecutorWrapper

public BackgroundExecutorWrapper getBackgroundExecutorWrapper()

Description copied from interface: DatabaseBuilder.Settings

Return the background executor wrapper.

Specified by:

getBackgroundExecutorWrapper in interface DatabaseBuilder.Settings

setBackgroundExecutorWrapper

public DatabaseConfig setBackgroundExecutorWrapper(BackgroundExecutorWrapper backgroundExecutorWrapper)

Specified by:

setBackgroundExecutorWrapper in interface DatabaseBuilder

getCacheMaxSize

public int getCacheMaxSize()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 cache default max size.

Specified by:

getCacheMaxSize in interface DatabaseBuilder.Settings

setCacheMaxSize

public DatabaseConfig setCacheMaxSize(int cacheMaxSize)

Specified by:

setCacheMaxSize in interface DatabaseBuilder

getCacheMaxIdleTime

public int getCacheMaxIdleTime()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 cache default max idle time in seconds.

Specified by:

getCacheMaxIdleTime in interface DatabaseBuilder.Settings

setCacheMaxIdleTime

public DatabaseConfig setCacheMaxIdleTime(int cacheMaxIdleTime)

Specified by:

setCacheMaxIdleTime in interface DatabaseBuilder

getCacheMaxTimeToLive

public int getCacheMaxTimeToLive()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 cache default max time to live in seconds.

Specified by:

getCacheMaxTimeToLive in interface DatabaseBuilder.Settings

setCacheMaxTimeToLive

public DatabaseConfig setCacheMaxTimeToLive(int cacheMaxTimeToLive)

Specified by:

setCacheMaxTimeToLive in interface DatabaseBuilder

getQueryCacheMaxSize

public int getQueryCacheMaxSize()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 query cache default max size.

Specified by:

getQueryCacheMaxSize in interface DatabaseBuilder.Settings

setQueryCacheMaxSize

public DatabaseConfig setQueryCacheMaxSize(int queryCacheMaxSize)

Specified by:

setQueryCacheMaxSize in interface DatabaseBuilder

getQueryCacheMaxIdleTime

public int getQueryCacheMaxIdleTime()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 query cache default max idle time in seconds.

Specified by:

getQueryCacheMaxIdleTime in interface DatabaseBuilder.Settings

setQueryCacheMaxIdleTime

public DatabaseConfig setQueryCacheMaxIdleTime(int queryCacheMaxIdleTime)

Specified by:

setQueryCacheMaxIdleTime in interface DatabaseBuilder

getQueryCacheMaxTimeToLive

public int getQueryCacheMaxTimeToLive()

Description copied from interface: DatabaseBuilder.Settings

Return the L2 query cache default max time to live in seconds.

Specified by:

getQueryCacheMaxTimeToLive in interface DatabaseBuilder.Settings

setQueryCacheMaxTimeToLive

public DatabaseConfig setQueryCacheMaxTimeToLive(int queryCacheMaxTimeToLive)

Specified by:

setQueryCacheMaxTimeToLive in interface DatabaseBuilder

getNamingConvention

public NamingConvention getNamingConvention()

Description copied from interface: DatabaseBuilder.Settings

Return the NamingConvention.

If none has been set the default UnderscoreNamingConvention is used.

Specified by:

getNamingConvention in interface DatabaseBuilder.Settings

setNamingConvention

public DatabaseConfig setNamingConvention(NamingConvention namingConvention)

Specified by:

setNamingConvention in interface DatabaseBuilder

isAllQuotedIdentifiers

public boolean isAllQuotedIdentifiers()

Description copied from interface: DatabaseBuilder.Settings

Return true if all DB column and table names should use quoted identifiers.

Specified by:

isAllQuotedIdentifiers in interface DatabaseBuilder.Settings

setAllQuotedIdentifiers

public DatabaseConfig setAllQuotedIdentifiers(boolean allQuotedIdentifiers)

Specified by:

setAllQuotedIdentifiers in interface DatabaseBuilder

getConstraintNaming

public DbConstraintNaming getConstraintNaming()

Description copied from interface: DatabaseBuilder.Settings

Return the constraint naming convention used in DDL generation.

Specified by:

getConstraintNaming in interface DatabaseBuilder.Settings

setConstraintNaming

public DatabaseConfig setConstraintNaming(DbConstraintNaming constraintNaming)

Specified by:

setConstraintNaming in interface DatabaseBuilder

getAutoTuneConfig

public AutoTuneConfig getAutoTuneConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the configuration for AutoTune.

Specified by:

getAutoTuneConfig in interface DatabaseBuilder.Settings

setAutoTuneConfig

public DatabaseConfig setAutoTuneConfig(AutoTuneConfig autoTuneConfig)

Specified by:

setAutoTuneConfig in interface DatabaseBuilder

skipDataSourceCheck

public boolean skipDataSourceCheck()

Description copied from interface: DatabaseBuilder.Settings

Return true if the startup DataSource check should be skipped.

Specified by:

skipDataSourceCheck in interface DatabaseBuilder.Settings

setSkipDataSourceCheck

public DatabaseConfig setSkipDataSourceCheck(boolean skipDataSourceCheck)

Specified by:

setSkipDataSourceCheck in interface DatabaseBuilder

readOnlyDatabase

public DatabaseBuilder readOnlyDatabase(boolean readOnlyDatabase)

Description copied from interface: DatabaseBuilder

Set to true if this database is used in a read only way.

The DataSource and read-only DataSource are expected to be the same and use readOnly=true and autoCommit=true.

Specified by:

readOnlyDatabase in interface DatabaseBuilder

readOnlyDatabase

public boolean readOnlyDatabase()

Description copied from interface: DatabaseBuilder.Settings

Return true if this database is used in a read only way.

The DataSource and read-only DataSource are expected to be the same and use readOnly=true and autoCommit=true.

Specified by:

readOnlyDatabase in interface DatabaseBuilder.Settings

getDataSource

public DataSource getDataSource()

Description copied from interface: DatabaseBuilder.Settings

Return the DataSource.

Specified by:

getDataSource in interface DatabaseBuilder.Settings

setDataSource

public DatabaseConfig setDataSource(DataSource dataSource)

Specified by:

setDataSource in interface DatabaseBuilder

getReadOnlyDataSource

public DataSource getReadOnlyDataSource()

Description copied from interface: DatabaseBuilder.Settings

Return the read only DataSource.

Specified by:

getReadOnlyDataSource in interface DatabaseBuilder.Settings

setReadOnlyDataSource

public DatabaseConfig setReadOnlyDataSource(DataSource readOnlyDataSource)

Specified by:

setReadOnlyDataSource in interface DatabaseBuilder

getDataSourceConfig

public io.ebean.datasource.DataSourceBuilder.Settings getDataSourceConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the configuration to build a DataSource using Ebean's own DataSource implementation.

Specified by:

getDataSourceConfig in interface DatabaseBuilder.Settings

setDataSourceConfig

public DatabaseConfig setDataSourceConfig(io.ebean.datasource.DataSourceBuilder dataSourceConfig)

Specified by:

setDataSourceConfig in interface DatabaseBuilder

isAutoReadOnlyDataSource

public boolean isAutoReadOnlyDataSource()

Description copied from interface: DatabaseBuilder.Settings

Return true if Ebean should create a DataSource for use with implicit read only transactions.

Specified by:

isAutoReadOnlyDataSource in interface DatabaseBuilder.Settings

setAutoReadOnlyDataSource

public DatabaseConfig setAutoReadOnlyDataSource(boolean autoReadOnlyDataSource)

Specified by:

setAutoReadOnlyDataSource in interface DatabaseBuilder

getReadOnlyDataSourceConfig

public io.ebean.datasource.DataSourceBuilder.Settings getReadOnlyDataSourceConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the configuration for the read only DataSource.

This is only used if autoReadOnlyDataSource is true.

The driver, url, username and password default to the configuration for the main DataSource if they are not set on this configuration. This means there is actually no need to set any configuration here and we only set configuration for url, username and password etc if it is different from the main DataSource.

Specified by:

getReadOnlyDataSourceConfig in interface DatabaseBuilder.Settings

setReadOnlyDataSourceConfig

public DatabaseConfig setReadOnlyDataSourceConfig(io.ebean.datasource.DataSourceBuilder readOnly)

Specified by:

setReadOnlyDataSourceConfig in interface DatabaseBuilder

getDatabaseBooleanTrue

public String getDatabaseBooleanTrue()

Description copied from interface: DatabaseBuilder.Settings

Return a value used to represent TRUE in the database.

This is used for databases that do not support boolean natively.

The value returned is either a Integer or a String (e.g. "1", or "T").

Specified by:

getDatabaseBooleanTrue in interface DatabaseBuilder.Settings

setDatabaseBooleanTrue

public DatabaseConfig setDatabaseBooleanTrue(String databaseTrue)

Specified by:

setDatabaseBooleanTrue in interface DatabaseBuilder

getDatabaseBooleanFalse

public String getDatabaseBooleanFalse()

Description copied from interface: DatabaseBuilder.Settings

Return a value used to represent FALSE in the database.

This is used for databases that do not support boolean natively.

The value returned is either a Integer or a String (e.g. "0", or "F").

Specified by:

getDatabaseBooleanFalse in interface DatabaseBuilder.Settings

setDatabaseBooleanFalse

public DatabaseConfig setDatabaseBooleanFalse(String databaseFalse)

Specified by:

setDatabaseBooleanFalse in interface DatabaseBuilder

getDatabaseSequenceBatchSize

public int getDatabaseSequenceBatchSize()

Description copied from interface: DatabaseBuilder.Settings

Return the number of DB sequence values that should be preallocated.

Specified by:

getDatabaseSequenceBatchSize in interface DatabaseBuilder.Settings

setDatabaseSequenceBatch

public DatabaseConfig setDatabaseSequenceBatch(int databaseSequenceBatchSize)

Specified by:

setDatabaseSequenceBatch in interface DatabaseBuilder

getDatabasePlatformName

public String getDatabasePlatformName()

Description copied from interface: DatabaseBuilder.Settings

Return the database platform name (can be null).

If null then the platform is determined automatically via the JDBC driver information.

Specified by:

getDatabasePlatformName in interface DatabaseBuilder.Settings

setDatabasePlatformName

public DatabaseConfig setDatabasePlatformName(String databasePlatformName)

Specified by:

setDatabasePlatformName in interface DatabaseBuilder

getDatabasePlatform

public DatabasePlatform getDatabasePlatform()

Description copied from interface: DatabaseBuilder.Settings

Return the database platform to use for this database.

Specified by:

getDatabasePlatform in interface DatabaseBuilder.Settings

setDatabasePlatform

public DatabaseConfig setDatabasePlatform(DatabasePlatform databasePlatform)

Specified by:

setDatabasePlatform in interface DatabaseBuilder

getIdType

public IdType getIdType()

Description copied from interface: DatabaseBuilder.Settings

Return the preferred DB platform IdType.

Specified by:

getIdType in interface DatabaseBuilder.Settings

setIdType

public DatabaseConfig setIdType(IdType idType)

Specified by:

setIdType in interface DatabaseBuilder

getEncryptKeyManager

public EncryptKeyManager getEncryptKeyManager()

Description copied from interface: DatabaseBuilder.Settings

Return the EncryptKeyManager.

Specified by:

getEncryptKeyManager in interface DatabaseBuilder.Settings

setEncryptKeyManager

public DatabaseConfig setEncryptKeyManager(EncryptKeyManager encryptKeyManager)

Specified by:

setEncryptKeyManager in interface DatabaseBuilder

getEncryptDeployManager

public EncryptDeployManager getEncryptDeployManager()

Description copied from interface: DatabaseBuilder.Settings

Return the EncryptDeployManager.

This is optionally used to programmatically define which columns are encrypted instead of using the Encrypted Annotation.

Specified by:

getEncryptDeployManager in interface DatabaseBuilder.Settings

setEncryptDeployManager

public DatabaseConfig setEncryptDeployManager(EncryptDeployManager encryptDeployManager)

Specified by:

setEncryptDeployManager in interface DatabaseBuilder

getEncryptor

public Encryptor getEncryptor()

Description copied from interface: DatabaseBuilder.Settings

Return the Encryptor used to encrypt data on the java client side (as opposed to DB encryption functions).

Specified by:

getEncryptor in interface DatabaseBuilder.Settings

setEncryptor

public DatabaseConfig setEncryptor(Encryptor encryptor)

Specified by:

setEncryptor in interface DatabaseBuilder

isDbOffline

public boolean isDbOffline()

Description copied from interface: DatabaseBuilder.Settings

Return true if the Database instance should be created in offline mode.

Specified by:

isDbOffline in interface DatabaseBuilder.Settings

setDbOffline

public DatabaseConfig setDbOffline(boolean dbOffline)

Specified by:

setDbOffline in interface DatabaseBuilder

getDbEncrypt

public DbEncrypt getDbEncrypt()

Description copied from interface: DatabaseBuilder.Settings

Return the DbEncrypt used to encrypt and decrypt properties.

Note that if this is not set then the DbPlatform may already have a DbEncrypt set and that will be used.

Specified by:

getDbEncrypt in interface DatabaseBuilder.Settings

setDbEncrypt

public DatabaseConfig setDbEncrypt(DbEncrypt dbEncrypt)

Specified by:

setDbEncrypt in interface DatabaseBuilder

getPlatformConfig

public PlatformConfig getPlatformConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the configuration for DB types (such as UUID and custom mappings).

Specified by:

getPlatformConfig in interface DatabaseBuilder.Settings

setPlatformConfig

public DatabaseConfig setPlatformConfig(PlatformConfig platformConfig)

Specified by:

setPlatformConfig in interface DatabaseBuilder

setDbUuid

public DatabaseConfig setDbUuid(PlatformConfig.DbUuid dbUuid)

Specified by:

setDbUuid in interface DatabaseBuilder

getUuidVersion

public DatabaseConfig.UuidVersion getUuidVersion()

Description copied from interface: DatabaseBuilder.Settings

Returns the UUID version mode.

Specified by:

getUuidVersion in interface DatabaseBuilder.Settings

setUuidVersion

public DatabaseConfig setUuidVersion(DatabaseConfig.UuidVersion uuidVersion)

Specified by:

setUuidVersion in interface DatabaseBuilder

getUuidStateFile

public String getUuidStateFile()

Description copied from interface: DatabaseBuilder.Settings

Return the UUID state file.

Specified by:

getUuidStateFile in interface DatabaseBuilder.Settings

setUuidStateFile

public DatabaseConfig setUuidStateFile(String uuidStateFile)

Specified by:

setUuidStateFile in interface DatabaseBuilder

getUuidNodeId

public String getUuidNodeId()

Description copied from interface: DatabaseBuilder.Settings

Returns the V1-UUID-NodeId

Specified by:

getUuidNodeId in interface DatabaseBuilder.Settings

setUuidNodeId

public DatabaseConfig setUuidNodeId(String uuidNodeId)

Specified by:

setUuidNodeId in interface DatabaseBuilder

isLocalTimeWithNanos

public boolean isLocalTimeWithNanos()

Description copied from interface: DatabaseBuilder.Settings

Return true if LocalTime should be persisted with nanos precision.

Specified by:

isLocalTimeWithNanos in interface DatabaseBuilder.Settings

setLocalTimeWithNanos

public DatabaseConfig setLocalTimeWithNanos(boolean localTimeWithNanos)

Specified by:

setLocalTimeWithNanos in interface DatabaseBuilder

isDurationWithNanos

public boolean isDurationWithNanos()

Description copied from interface: DatabaseBuilder.Settings

Return true if Duration should be persisted with nanos precision (SQL DECIMAL).

Otherwise it is persisted with second precision (SQL INTEGER).

Specified by:

isDurationWithNanos in interface DatabaseBuilder.Settings

setDurationWithNanos

public DatabaseConfig setDurationWithNanos(boolean durationWithNanos)

Specified by:

setDurationWithNanos in interface DatabaseBuilder

setRunMigration

public DatabaseConfig setRunMigration(boolean runMigration)

Specified by:

setRunMigration in interface DatabaseBuilder

isRunMigration

public boolean isRunMigration()

Description copied from interface: DatabaseBuilder.Settings

Return true if the DB migration should run on server start.

Specified by:

isRunMigration in interface DatabaseBuilder.Settings

setDdlGenerate

public DatabaseConfig setDdlGenerate(boolean ddlGenerate)

Specified by:

setDdlGenerate in interface DatabaseBuilder

setDdlRun

public DatabaseConfig setDdlRun(boolean ddlRun)

Specified by:

setDdlRun in interface DatabaseBuilder

setDdlExtra

public DatabaseConfig setDdlExtra(boolean ddlExtra)

Specified by:

setDdlExtra in interface DatabaseBuilder

isDdlCreateOnly

public boolean isDdlCreateOnly()

Description copied from interface: DatabaseBuilder.Settings

Return true if the "drop all ddl" should be skipped.

Typically we want to do this when using H2 (in memory) as our test database and the drop statements are not required so skipping the drop table statements etc makes it faster with less noise in the logs.

Specified by:

isDdlCreateOnly in interface DatabaseBuilder.Settings

setDdlCreateOnly

public DatabaseConfig setDdlCreateOnly(boolean ddlCreateOnly)

Specified by:

setDdlCreateOnly in interface DatabaseBuilder

getDdlSeedSql

public String getDdlSeedSql()

Description copied from interface: DatabaseBuilder.Settings

Return SQL script to execute after the "create all" DDL has been run.

Typically this is a sql script that inserts test seed data when running tests. Place a sql script in src/test/resources that inserts test seed data.

Specified by:

getDdlSeedSql in interface DatabaseBuilder.Settings

setDdlSeedSql

public DatabaseConfig setDdlSeedSql(String ddlSeedSql)

Specified by:

setDdlSeedSql in interface DatabaseBuilder

getDdlInitSql

public String getDdlInitSql()

Description copied from interface: DatabaseBuilder.Settings

Return a SQL script to execute before the "create all" DDL has been run.

Specified by:

getDdlInitSql in interface DatabaseBuilder.Settings

setDdlInitSql

public DatabaseConfig setDdlInitSql(String ddlInitSql)

Specified by:

setDdlInitSql in interface DatabaseBuilder

isDdlGenerate

public boolean isDdlGenerate()

Description copied from interface: DatabaseBuilder.Settings

Return true if the DDL should be generated.

Specified by:

isDdlGenerate in interface DatabaseBuilder.Settings

isDdlRun

public boolean isDdlRun()

Description copied from interface: DatabaseBuilder.Settings

Return true if the DDL should be run.

Specified by:

isDdlRun in interface DatabaseBuilder.Settings

isDdlExtra

public boolean isDdlExtra()

Description copied from interface: DatabaseBuilder.Settings

Return true, if extra-ddl.xml should be executed.

Specified by:

isDdlExtra in interface DatabaseBuilder.Settings

setDdlHeader

public DatabaseConfig setDdlHeader(String ddlHeader)

Specified by:

setDdlHeader in interface DatabaseBuilder

getDdlHeader

public String getDdlHeader()

Description copied from interface: DatabaseBuilder.Settings

Return the header to use with DDL generation.

Specified by:

getDdlHeader in interface DatabaseBuilder.Settings

isDdlStrictMode

public boolean isDdlStrictMode()

Description copied from interface: DatabaseBuilder.Settings

Return true if strict mode is used which includes a check that non-null columns have a default value.

Specified by:

isDdlStrictMode in interface DatabaseBuilder.Settings

setDdlStrictMode

public DatabaseConfig setDdlStrictMode(boolean ddlStrictMode)

Specified by:

setDdlStrictMode in interface DatabaseBuilder

getDdlPlaceholders

public String getDdlPlaceholders()

Description copied from interface: DatabaseBuilder.Settings

Return a comma and equals delimited placeholders that are substituted in DDL scripts.

Specified by:

getDdlPlaceholders in interface DatabaseBuilder.Settings

setDdlPlaceholders

public DatabaseConfig setDdlPlaceholders(String ddlPlaceholders)

Specified by:

setDdlPlaceholders in interface DatabaseBuilder

getDdlPlaceholderMap

public Map<String,String> getDdlPlaceholderMap()

Description copied from interface: DatabaseBuilder.Settings

Return a map of placeholder values that are substituted in DDL scripts.

Specified by:

getDdlPlaceholderMap in interface DatabaseBuilder.Settings

setDdlPlaceholderMap

public DatabaseConfig setDdlPlaceholderMap(Map<String,String> ddlPlaceholderMap)

Specified by:

setDdlPlaceholderMap in interface DatabaseBuilder

isDisableClasspathSearch

public boolean isDisableClasspathSearch()

Description copied from interface: DatabaseBuilder.Settings

Return true if the class path search should be disabled.

Specified by:

isDisableClasspathSearch in interface DatabaseBuilder.Settings

setDisableClasspathSearch

public DatabaseConfig setDisableClasspathSearch(boolean disableClasspathSearch)

Specified by:

setDisableClasspathSearch in interface DatabaseBuilder

getJodaLocalTimeMode

public String getJodaLocalTimeMode()

Description copied from interface: DatabaseBuilder.Settings

Return the mode to use for Joda LocalTime support 'normal' or 'utc'.

Specified by:

getJodaLocalTimeMode in interface DatabaseBuilder.Settings

setJodaLocalTimeMode

public DatabaseConfig setJodaLocalTimeMode(String jodaLocalTimeMode)

Specified by:

setJodaLocalTimeMode in interface DatabaseBuilder

addClass

public DatabaseConfig addClass(Class<?> cls)

Description copied from interface: DatabaseBuilder

Programmatically add classes (typically entities) that this server should use.

The class can be an Entity, Embedded type, ScalarType, BeanPersistListener, BeanFinder or BeanPersistController.

If no classes are specified then the classes are found automatically via searching the class path.

Specified by:

addClass in interface DatabaseBuilder

Parameters:

cls - the entity type (or other type) that should be registered by this database.

addAll

public DatabaseConfig addAll(Collection<Class<?>> classList)

Description copied from interface: DatabaseBuilder

Register all the classes (typically entity classes).

Specified by:

addAll in interface DatabaseBuilder

addPackage

public DatabaseConfig addPackage(String packageName)

Description copied from interface: DatabaseBuilder

Add a package to search for entities via class path search.

This is only used if classes have not been explicitly specified.

Specified by:

addPackage in interface DatabaseBuilder

getPackages

public List<String> getPackages()

Description copied from interface: DatabaseBuilder.Settings

Return packages to search for entities via class path search.

This is only used if classes have not been explicitly specified.

Specified by:

getPackages in interface DatabaseBuilder.Settings

setPackages

public DatabaseConfig setPackages(List<String> packages)

Description copied from interface: DatabaseBuilder

Set packages to search for entities via class path search.

This is only used if classes have not been explicitly specified.

Specified by:

setPackages in interface DatabaseBuilder

setClasses

public void setClasses(Collection<Class<?>> classes)

Set the list of classes (entities, listeners, scalarTypes etc) that should be used for this database.

Leaving void for spring xml wiring for now.

classes

public DatabaseConfig classes(Collection<Class<?>> classes)

Description copied from interface: DatabaseBuilder

Set the list of classes (entities, listeners, scalarTypes etc) that should be used for this database.

If no classes are specified then the classes are found automatically via searching the class path.

Alternatively the classes can contain added via DatabaseBuilder.addClass(Class).

Specified by:

classes in interface DatabaseBuilder

classes

public Set<Class<?>> classes()

Description copied from interface: DatabaseBuilder.Settings

Return the classes registered for this database. Typically, this includes entities and perhaps listeners.

Specified by:

classes in interface DatabaseBuilder.Settings

getClasses

@Deprecated(forRemoval=true)
public Set<Class<?>> getClasses()

Deprecated, for removal: This API element is subject to removal in a future version.

- migrate to classes().

Specified by:

getClasses in interface DatabaseBuilder.Settings

isSkipCacheAfterWrite

public boolean isSkipCacheAfterWrite()

Description copied from interface: DatabaseBuilder.Settings

Return true if L2 bean cache should be skipped once writes have occurred on a transaction.

This defaults to true and means that for "find by id" and "find by natural key" queries that normally hit L2 bean cache automatically will not do so after a write/persist on the transaction.

   // assume Customer has L2 bean caching enabled ...

   try (Transaction transaction = DB.beginTransaction()) {

     // this uses L2 bean cache as the transaction
     // ... is considered "query only" at this point
     Customer.find.byId(42);

     // transaction no longer "query only" once
     // ... a bean has been saved etc
     DB.save(someBean);

     // will NOT use L2 bean cache as the transaction
     // ... is no longer considered "query only"
     Customer.find.byId(55);



     // explicit control - please use L2 bean cache

     transaction.setSkipCache(false);
     Customer.find.byId(77); // hit the l2 bean cache


     // explicit control - please don't use L2 bean cache

     transaction.setSkipCache(true);
     Customer.find.byId(99); // skips l2 bean cache

   }

 

Specified by:

isSkipCacheAfterWrite in interface DatabaseBuilder.Settings

See Also:

• Transaction.setSkipCache(boolean)

setSkipCacheAfterWrite

public DatabaseConfig setSkipCacheAfterWrite(boolean skipCacheAfterWrite)

Specified by:

setSkipCacheAfterWrite in interface DatabaseBuilder

isUpdateAllPropertiesInBatch

public boolean isUpdateAllPropertiesInBatch()

Description copied from interface: DatabaseBuilder.Settings

Returns true if updates in JDBC batch default to include all properties by default.

Specified by:

isUpdateAllPropertiesInBatch in interface DatabaseBuilder.Settings

setUpdateAllPropertiesInBatch

public DatabaseConfig setUpdateAllPropertiesInBatch(boolean updateAllPropertiesInBatch)

Specified by:

setUpdateAllPropertiesInBatch in interface DatabaseBuilder

getResourceDirectory

public String getResourceDirectory()

Description copied from interface: DatabaseBuilder.Settings

Returns the resource directory.

Specified by:

getResourceDirectory in interface DatabaseBuilder.Settings

setResourceDirectory

public DatabaseConfig setResourceDirectory(String resourceDirectory)

Specified by:

setResourceDirectory in interface DatabaseBuilder

addCustomMapping

public DatabaseConfig addCustomMapping(DbType type,
 String columnDefinition,
 io.ebean.annotation.Platform platform)

Description copied from interface: DatabaseBuilder

Add a custom type mapping.

   // set the default mapping for BigDecimal.class/decimal
   config.addCustomMapping(DbType.DECIMAL, "decimal(18,6)");

   // set the default mapping for String.class/varchar but only for Postgres
   config.addCustomMapping(DbType.VARCHAR, "text", Platform.POSTGRES);

 

Specified by:

addCustomMapping in interface DatabaseBuilder

Parameters:

type - The DB type this mapping should apply to

columnDefinition - The column definition that should be used

platform - Optionally specify the platform this mapping should apply to.

addCustomMapping

public DatabaseConfig addCustomMapping(DbType type,
 String columnDefinition)

Description copied from interface: DatabaseBuilder

Add a custom type mapping that applies to all platforms.

   // set the default mapping for BigDecimal/decimal
   config.addCustomMapping(DbType.DECIMAL, "decimal(18,6)");

   // set the default mapping for String/varchar
   config.addCustomMapping(DbType.VARCHAR, "text");

 

Specified by:

addCustomMapping in interface DatabaseBuilder

Parameters:

type - The DB type this mapping should apply to

columnDefinition - The column definition that should be used

add

public DatabaseConfig add(BeanQueryAdapter beanQueryAdapter)

Description copied from interface: DatabaseBuilder

Register a BeanQueryAdapter instance.

Note alternatively you can use DatabaseBuilder.setQueryAdapters(List) to set all the BeanQueryAdapter instances.

Specified by:

add in interface DatabaseBuilder

getQueryAdapters

public List<BeanQueryAdapter> getQueryAdapters()

Description copied from interface: DatabaseBuilder.Settings

Return the BeanQueryAdapter instances.

Specified by:

getQueryAdapters in interface DatabaseBuilder.Settings

setQueryAdapters

public DatabaseConfig setQueryAdapters(List<BeanQueryAdapter> queryAdapters)

Description copied from interface: DatabaseBuilder

Register all the BeanQueryAdapter instances.

Note alternatively you can use DatabaseBuilder.add(BeanQueryAdapter) to add BeanQueryAdapter instances one at a time.

Specified by:

setQueryAdapters in interface DatabaseBuilder

getIdGenerators

public List<IdGenerator> getIdGenerators()

Description copied from interface: DatabaseBuilder.Settings

Return the custom IdGenerator instances.

Specified by:

getIdGenerators in interface DatabaseBuilder.Settings

setIdGenerators

public DatabaseConfig setIdGenerators(List<IdGenerator> idGenerators)

Description copied from interface: DatabaseBuilder

Set the custom IdGenerator instances.

Specified by:

setIdGenerators in interface DatabaseBuilder

add

public DatabaseConfig add(IdGenerator idGenerator)

Description copied from interface: DatabaseBuilder

Register a customer IdGenerator instance.

Specified by:

add in interface DatabaseBuilder

add

public DatabaseConfig add(BeanPersistController beanPersistController)

Description copied from interface: DatabaseBuilder

Register a BeanPersistController instance.

Note alternatively you can use DatabaseBuilder.setPersistControllers(List) to set all the BeanPersistController instances.

Specified by:

add in interface DatabaseBuilder

add

public DatabaseConfig add(BeanPostLoad postLoad)

Description copied from interface: DatabaseBuilder

Register a BeanPostLoad instance.

Note alternatively you can use DatabaseBuilder.setPostLoaders(List) to set all the BeanPostLoad instances.

Specified by:

add in interface DatabaseBuilder

add

public DatabaseConfig add(BeanPostConstructListener listener)

Description copied from interface: DatabaseBuilder

Register a BeanPostConstructListener instance.

Note alternatively you can use DatabaseBuilder.setPostConstructListeners(List) to set all the BeanPostConstructListener instances.

Specified by:

add in interface DatabaseBuilder

getFindControllers

public List<BeanFindController> getFindControllers()

Description copied from interface: DatabaseBuilder.Settings

Return the list of BeanFindController instances.

Specified by:

getFindControllers in interface DatabaseBuilder.Settings

setFindControllers

public DatabaseConfig setFindControllers(List<BeanFindController> findControllers)

Description copied from interface: DatabaseBuilder

Set the list of BeanFindController instances.

Specified by:

setFindControllers in interface DatabaseBuilder

getPostLoaders

public List<BeanPostLoad> getPostLoaders()

Description copied from interface: DatabaseBuilder.Settings

Return the list of BeanPostLoader instances.

Specified by:

getPostLoaders in interface DatabaseBuilder.Settings

setPostLoaders

public DatabaseConfig setPostLoaders(List<BeanPostLoad> postLoaders)

Description copied from interface: DatabaseBuilder

Set the list of BeanPostLoader instances.

Specified by:

setPostLoaders in interface DatabaseBuilder

getPostConstructListeners

public List<BeanPostConstructListener> getPostConstructListeners()

Description copied from interface: DatabaseBuilder.Settings

Return the list of BeanPostLoader instances.

Specified by:

getPostConstructListeners in interface DatabaseBuilder.Settings

setPostConstructListeners

public DatabaseConfig setPostConstructListeners(List<BeanPostConstructListener> listeners)

Description copied from interface: DatabaseBuilder

Set the list of BeanPostLoader instances.

Specified by:

setPostConstructListeners in interface DatabaseBuilder

getPersistControllers

public List<BeanPersistController> getPersistControllers()

Description copied from interface: DatabaseBuilder.Settings

Return the BeanPersistController instances.

Specified by:

getPersistControllers in interface DatabaseBuilder.Settings

setPersistControllers

public DatabaseConfig setPersistControllers(List<BeanPersistController> persistControllers)

Description copied from interface: DatabaseBuilder

Register all the BeanPersistController instances.

Note alternatively you can use DatabaseBuilder.add(BeanPersistController) to add BeanPersistController instances one at a time.

Specified by:

setPersistControllers in interface DatabaseBuilder

add

public DatabaseConfig add(BeanPersistListener beanPersistListener)

Description copied from interface: DatabaseBuilder

Register a BeanPersistListener instance.

Note alternatively you can use DatabaseBuilder.setPersistListeners(List) to set all the BeanPersistListener instances.

Specified by:

add in interface DatabaseBuilder

getPersistListeners

public List<BeanPersistListener> getPersistListeners()

Description copied from interface: DatabaseBuilder.Settings

Return the BeanPersistListener instances.

Specified by:

getPersistListeners in interface DatabaseBuilder.Settings

add

public DatabaseConfig add(BulkTableEventListener bulkTableEventListener)

Description copied from interface: DatabaseBuilder

Add a BulkTableEventListener

Specified by:

add in interface DatabaseBuilder

getBulkTableEventListeners

public List<BulkTableEventListener> getBulkTableEventListeners()

Description copied from interface: DatabaseBuilder.Settings

Return the list of BulkTableEventListener instances.

Specified by:

getBulkTableEventListeners in interface DatabaseBuilder.Settings

addServerConfigStartup

public DatabaseConfig addServerConfigStartup(ServerConfigStartup configStartupListener)

Description copied from interface: DatabaseBuilder

Add a ServerConfigStartup.

Specified by:

addServerConfigStartup in interface DatabaseBuilder

getServerConfigStartupListeners

public List<ServerConfigStartup> getServerConfigStartupListeners()

Description copied from interface: DatabaseBuilder.Settings

Return the list of ServerConfigStartup instances.

Specified by:

getServerConfigStartupListeners in interface DatabaseBuilder.Settings

setPersistListeners

public DatabaseConfig setPersistListeners(List<BeanPersistListener> persistListeners)

Description copied from interface: DatabaseBuilder

Register all the BeanPersistListener instances.

Note alternatively you can use DatabaseBuilder.add(BeanPersistListener) to add BeanPersistListener instances one at a time.

Specified by:

setPersistListeners in interface DatabaseBuilder

getPersistenceContextScope

public PersistenceContextScope getPersistenceContextScope()

Description copied from interface: DatabaseBuilder.Settings

Return the default PersistenceContextScope to be used if one is not explicitly set on a query.

The PersistenceContextScope can specified on each query via .Query#setPersistenceContextScope(io.ebean.PersistenceContextScope). If it is not set on the query this default scope is used.

Specified by:

getPersistenceContextScope in interface DatabaseBuilder.Settings

See Also:

• QueryBuilder.setPersistenceContextScope(PersistenceContextScope)

setPersistenceContextScope

public DatabaseConfig setPersistenceContextScope(PersistenceContextScope persistenceContextScope)

Specified by:

setPersistenceContextScope in interface DatabaseBuilder

getClassLoadConfig

public ClassLoadConfig getClassLoadConfig()

Description copied from interface: DatabaseBuilder.Settings

Return the ClassLoadConfig which is used to detect Joda, Java8 types etc and also create new instances of plugins given a className.

Specified by:

getClassLoadConfig in interface DatabaseBuilder.Settings

setClassLoadConfig

public DatabaseConfig setClassLoadConfig(ClassLoadConfig classLoadConfig)

Specified by:

setClassLoadConfig in interface DatabaseBuilder

loadFromProperties

public DatabaseConfig loadFromProperties()

Description copied from interface: DatabaseBuilder

Load settings from application.properties, application.yaml and other sources.

Uses avaje-config to load configuration properties. Goto https://avaje.io/config for detail on how and where properties are loaded from.

Specified by:

loadFromProperties in interface DatabaseBuilder

loadFromProperties

public DatabaseConfig loadFromProperties(Properties properties)

Description copied from interface: DatabaseBuilder

Load the settings from the given properties

Specified by:

loadFromProperties in interface DatabaseBuilder

getProperties

public Properties getProperties()

Description copied from interface: DatabaseBuilder.Settings

Return the properties that we used for configuration and were set via a call to loadFromProperties().

Specified by:

getProperties in interface DatabaseBuilder.Settings

loadDataSourceSettings

protected void loadDataSourceSettings(PropertiesWrapper p)

loads the data source settings to preserve existing behaviour. IMHO, if someone has set the datasource config already, they don't want the settings to be reloaded and reset. This allows a descending class to override this behaviour and prevent it from happening.

Parameters:

p - - The defined property source passed to load settings

loadAutoTuneSettings

protected void loadAutoTuneSettings(PropertiesWrapper p)

This is broken out to allow overridden behaviour.

loadSettings

protected void loadSettings(PropertiesWrapper p)

Load the configuration settings from the properties file.

appliedPersistBatchOnCascade

public io.ebean.annotation.PersistBatch appliedPersistBatchOnCascade()

Description copied from interface: DatabaseBuilder.Settings

Return the PersistBatch mode to use for 'batchOnCascade' taking into account if the database platform supports getGeneratedKeys in batch mode.

Specified by:

appliedPersistBatchOnCascade in interface DatabaseBuilder.Settings

getObjectMapper

public Object getObjectMapper()

Description copied from interface: DatabaseBuilder.Settings

Return the Jackson ObjectMapper.

Note that this is not strongly typed as Jackson ObjectMapper is an optional dependency.

Specified by:

getObjectMapper in interface DatabaseBuilder.Settings

setObjectMapper

public DatabaseConfig setObjectMapper(Object objectMapper)

Specified by:

setObjectMapper in interface DatabaseBuilder

isExpressionEqualsWithNullAsNoop

public boolean isExpressionEqualsWithNullAsNoop()

Description copied from interface: DatabaseBuilder.Settings

Return true if eq("someProperty", null) should to generate "1=1" rather than "is null" sql expression.

Specified by:

isExpressionEqualsWithNullAsNoop in interface DatabaseBuilder.Settings

setExpressionEqualsWithNullAsNoop

public DatabaseConfig setExpressionEqualsWithNullAsNoop(boolean expressionEqualsWithNullAsNoop)

Specified by:

setExpressionEqualsWithNullAsNoop in interface DatabaseBuilder

isExpressionNativeIlike

public boolean isExpressionNativeIlike()

Description copied from interface: DatabaseBuilder.Settings

Return true if native ILIKE expression should be used if supported by the database platform (e.g. Postgres).

Specified by:

isExpressionNativeIlike in interface DatabaseBuilder.Settings

setExpressionNativeIlike

public DatabaseConfig setExpressionNativeIlike(boolean expressionNativeIlike)

Specified by:

setExpressionNativeIlike in interface DatabaseBuilder

getEnabledL2Regions

public String getEnabledL2Regions()

Description copied from interface: DatabaseBuilder.Settings

Return the enabled L2 cache regions.

Specified by:

getEnabledL2Regions in interface DatabaseBuilder.Settings

setEnabledL2Regions

public DatabaseConfig setEnabledL2Regions(String enabledL2Regions)

Specified by:

setEnabledL2Regions in interface DatabaseBuilder

isDisableL2Cache

public boolean isDisableL2Cache()

Description copied from interface: DatabaseBuilder.Settings

Return true if L2 cache is disabled.

Specified by:

isDisableL2Cache in interface DatabaseBuilder.Settings

setDisableL2Cache

public DatabaseConfig setDisableL2Cache(boolean disableL2Cache)

Specified by:

setDisableL2Cache in interface DatabaseBuilder

isLocalOnlyL2Cache

public boolean isLocalOnlyL2Cache()

Description copied from interface: DatabaseBuilder.Settings

Return true to use local only L2 cache. Effectively ignore l2 cache plugin like ebean-redis etc.

Specified by:

isLocalOnlyL2Cache in interface DatabaseBuilder.Settings

setLocalOnlyL2Cache

public DatabaseConfig setLocalOnlyL2Cache(boolean localOnlyL2Cache)

Specified by:

setLocalOnlyL2Cache in interface DatabaseBuilder

isUseValidationNotNull

public boolean isUseValidationNotNull()

Description copied from interface: DatabaseBuilder.Settings

Returns if we use javax.validation.constraints.NotNull

Specified by:

isUseValidationNotNull in interface DatabaseBuilder.Settings

setUseValidationNotNull

public DatabaseConfig setUseValidationNotNull(boolean useValidationNotNull)

Specified by:

setUseValidationNotNull in interface DatabaseBuilder

isNotifyL2CacheInForeground

public boolean isNotifyL2CacheInForeground()

Description copied from interface: DatabaseBuilder.Settings

Return true if L2 cache notification should run in the foreground.

Specified by:

isNotifyL2CacheInForeground in interface DatabaseBuilder.Settings

setNotifyL2CacheInForeground

public DatabaseConfig setNotifyL2CacheInForeground(boolean notifyL2CacheInForeground)

Specified by:

setNotifyL2CacheInForeground in interface DatabaseBuilder

getQueryPlanTTLSeconds

public int getQueryPlanTTLSeconds()

Description copied from interface: DatabaseBuilder.Settings

Return the time to live for ebean's internal query plan.

Specified by:

getQueryPlanTTLSeconds in interface DatabaseBuilder.Settings

setQueryPlanTTLSeconds

public DatabaseConfig setQueryPlanTTLSeconds(int queryPlanTTLSeconds)

Specified by:

setQueryPlanTTLSeconds in interface DatabaseBuilder

newPlatformConfig

public PlatformConfig newPlatformConfig(String propertiesPath,
 String platformPrefix)

Description copied from interface: DatabaseBuilder

Create a new PlatformConfig based of the one held but with overridden properties by reading properties with the given path and prefix.

Typically used in Db Migration generation for many platform targets that might have different configuration for IdType, UUID, quoted identifiers etc.

Specified by:

newPlatformConfig in interface DatabaseBuilder

Parameters:

propertiesPath - The properties path used for loading and setting properties

platformPrefix - The prefix used for loading and setting properties

Returns:

A copy of the PlatformConfig with overridden properties

addMappingLocation

public DatabaseConfig addMappingLocation(String mappingLocation)

Description copied from interface: DatabaseBuilder

Add a mapping location to search for xml mapping via class path search.

Specified by:

addMappingLocation in interface DatabaseBuilder

getMappingLocations

public List<String> getMappingLocations()

Description copied from interface: DatabaseBuilder.Settings

Return mapping locations to search for xml mapping via class path search.

Specified by:

getMappingLocations in interface DatabaseBuilder.Settings

setMappingLocations

public DatabaseConfig setMappingLocations(List<String> mappingLocations)

Specified by:

setMappingLocations in interface DatabaseBuilder

isIdGeneratorAutomatic

public boolean isIdGeneratorAutomatic()

Description copied from interface: DatabaseBuilder.Settings

When false we need explicit @GeneratedValue mapping to assign Identity or Sequence generated values. When true Id properties are automatically assigned Identity or Sequence without the GeneratedValue mapping.

Specified by:

isIdGeneratorAutomatic in interface DatabaseBuilder.Settings

setIdGeneratorAutomatic

public DatabaseConfig setIdGeneratorAutomatic(boolean idGeneratorAutomatic)

Specified by:

setIdGeneratorAutomatic in interface DatabaseBuilder

isQueryPlanEnable

public boolean isQueryPlanEnable()

Description copied from interface: DatabaseBuilder.Settings

Return true if query plan capture is enabled.

Specified by:

isQueryPlanEnable in interface DatabaseBuilder.Settings

setQueryPlanEnable

public DatabaseConfig setQueryPlanEnable(boolean queryPlanEnable)

Specified by:

setQueryPlanEnable in interface DatabaseBuilder

getQueryPlanThresholdMicros

public long getQueryPlanThresholdMicros()

Description copied from interface: DatabaseBuilder.Settings

Return the query plan collection threshold in microseconds.

Specified by:

getQueryPlanThresholdMicros in interface DatabaseBuilder.Settings

setQueryPlanThresholdMicros

public DatabaseConfig setQueryPlanThresholdMicros(long queryPlanThresholdMicros)

Specified by:

setQueryPlanThresholdMicros in interface DatabaseBuilder

isQueryPlanCapture

public boolean isQueryPlanCapture()

Description copied from interface: DatabaseBuilder.Settings

Return true if periodic capture of query plans is enabled.

Specified by:

isQueryPlanCapture in interface DatabaseBuilder.Settings

setQueryPlanCapture

public DatabaseConfig setQueryPlanCapture(boolean queryPlanCapture)

Specified by:

setQueryPlanCapture in interface DatabaseBuilder

getQueryPlanCapturePeriodSecs

public long getQueryPlanCapturePeriodSecs()

Description copied from interface: DatabaseBuilder.Settings

Return the frequency to capture query plans.

Specified by:

getQueryPlanCapturePeriodSecs in interface DatabaseBuilder.Settings

setQueryPlanCapturePeriodSecs

public DatabaseConfig setQueryPlanCapturePeriodSecs(long queryPlanCapturePeriodSecs)

Specified by:

setQueryPlanCapturePeriodSecs in interface DatabaseBuilder

getQueryPlanCaptureMaxTimeMillis

public long getQueryPlanCaptureMaxTimeMillis()

Description copied from interface: DatabaseBuilder.Settings

Return the time after which a capture query plans request will stop capturing more query plans.

Effectively this controls the amount of load/time we want to allow for query plan capture.

Specified by:

getQueryPlanCaptureMaxTimeMillis in interface DatabaseBuilder.Settings

setQueryPlanCaptureMaxTimeMillis

public DatabaseConfig setQueryPlanCaptureMaxTimeMillis(long queryPlanCaptureMaxTimeMillis)

Specified by:

setQueryPlanCaptureMaxTimeMillis in interface DatabaseBuilder

getQueryPlanCaptureMaxCount

public int getQueryPlanCaptureMaxCount()

Description copied from interface: DatabaseBuilder.Settings

Return the max number of query plans captured per request.

Specified by:

getQueryPlanCaptureMaxCount in interface DatabaseBuilder.Settings

setQueryPlanCaptureMaxCount

public DatabaseConfig setQueryPlanCaptureMaxCount(int queryPlanCaptureMaxCount)

Specified by:

setQueryPlanCaptureMaxCount in interface DatabaseBuilder

getQueryPlanListener

public QueryPlanListener getQueryPlanListener()

Description copied from interface: DatabaseBuilder.Settings

Return the listener used to process captured query plans.

Specified by:

getQueryPlanListener in interface DatabaseBuilder.Settings

setQueryPlanListener

public DatabaseConfig setQueryPlanListener(QueryPlanListener queryPlanListener)

Specified by:

setQueryPlanListener in interface DatabaseBuilder

isDumpMetricsOnShutdown

public boolean isDumpMetricsOnShutdown()

Description copied from interface: DatabaseBuilder.Settings

Return true if metrics should be dumped when the server is shutdown.

Specified by:

isDumpMetricsOnShutdown in interface DatabaseBuilder.Settings

setDumpMetricsOnShutdown

public DatabaseConfig setDumpMetricsOnShutdown(boolean dumpMetricsOnShutdown)

Specified by:

setDumpMetricsOnShutdown in interface DatabaseBuilder

getDumpMetricsOptions

public String getDumpMetricsOptions()

Description copied from interface: DatabaseBuilder.Settings

Return the options for dumping metrics.

Specified by:

getDumpMetricsOptions in interface DatabaseBuilder.Settings

setDumpMetricsOptions

public DatabaseConfig setDumpMetricsOptions(String dumpMetricsOptions)

Specified by:

setDumpMetricsOptions in interface DatabaseBuilder

isLoadModuleInfo

public boolean isLoadModuleInfo()

Description copied from interface: DatabaseBuilder.Settings

Return true if entity classes should be loaded and registered via EntityClassRegister.

When false we either register entity classes via application code or use classpath scanning to find and register entity classes.

Specified by:

isLoadModuleInfo in interface DatabaseBuilder.Settings

isIncludeLabelInSql

public boolean isIncludeLabelInSql()

Description copied from interface: DatabaseBuilder.Settings

Return true if generated sql select query should include an inline sql comment with the query label or profile location label.

Specified by:

isIncludeLabelInSql in interface DatabaseBuilder.Settings

isAutoLoadModuleInfo

@Deprecated(forRemoval=true)
public boolean isAutoLoadModuleInfo()

Deprecated, for removal: This API element is subject to removal in a future version.

- migrate to isLoadModuleInfo().

Specified by:

isAutoLoadModuleInfo in interface DatabaseBuilder.Settings

setLoadModuleInfo

public DatabaseConfig setLoadModuleInfo(boolean loadModuleInfo)

Specified by:

setLoadModuleInfo in interface DatabaseBuilder

includeLabelInSql

public DatabaseConfig includeLabelInSql(boolean includeLabelInSql)

Description copied from interface: DatabaseBuilder

Set if generated SQL SELECT should include the query label as an inline SQL comment (to help reference back from the SQL to the code that executed the query.

Specified by:

includeLabelInSql in interface DatabaseBuilder

Parameters:

includeLabelInSql - When true include a SQL inline comment in generated SELECT queries.

getMetricNaming

public Function<String,String> getMetricNaming()

Description copied from interface: DatabaseBuilder.Settings

Return the naming convention to apply to metrics names.

Specified by:

getMetricNaming in interface DatabaseBuilder.Settings

setMetricNaming

public DatabaseConfig setMetricNaming(Function<String,String> metricNaming)

Specified by:

setMetricNaming in interface DatabaseBuilder

getLengthCheck

public LengthCheck getLengthCheck()

Returns the length check mode.

Specified by:

getLengthCheck in interface DatabaseBuilder.Settings

lengthCheck

public DatabaseConfig lengthCheck(LengthCheck lengthCheck)

Description copied from interface: DatabaseBuilder

Sets the length check mode.

Specified by:

lengthCheck in interface DatabaseBuilder