Uses of Interface
io.ebean.DatabaseBuilder
Packages that use DatabaseBuilder
Package
Description
Server Cache Service
Configuration settings for Database construction
Persist and Query Event Controllers and Listeners
-
Uses of DatabaseBuilder in io.ebean
Subinterfaces of DatabaseBuilder in io.ebeanModifier and TypeInterfaceDescriptionstatic interface
Provides read access (getters) for the DatabaseBuilder configuration that has been set.Methods in io.ebean that return DatabaseBuilderModifier and TypeMethodDescriptionDatabaseBuilder.add
(IdGenerator idGenerator) Register a customer IdGenerator instance.DatabaseBuilder.add
(BeanPersistController beanPersistController) Register a BeanPersistController instance.DatabaseBuilder.add
(BeanPersistListener beanPersistListener) Register a BeanPersistListener instance.DatabaseBuilder.add
(BeanPostConstructListener listener) Register a BeanPostConstructListener instance.DatabaseBuilder.add
(BeanPostLoad postLoad) Register a BeanPostLoad instance.DatabaseBuilder.add
(BeanQueryAdapter beanQueryAdapter) Register a BeanQueryAdapter instance.DatabaseBuilder.add
(BulkTableEventListener bulkTableEventListener) Add a BulkTableEventListenerDatabaseBuilder.addAll
(Collection<Class<?>> classList) Register all the classes (typically entity classes).Programmatically add classes (typically entities) that this server should use.DatabaseBuilder.addCustomMapping
(DbType type, String columnDefinition) Add a custom type mapping that applies to all platforms.DatabaseBuilder.addCustomMapping
(DbType type, String columnDefinition, io.ebean.annotation.Platform platform) Add a custom type mapping.DatabaseBuilder.addMappingLocation
(String mappingLocation) Add a mapping location to search for xml mapping via class path search.DatabaseBuilder.addPackage
(String packageName) Add a package to search for entities via class path search.DatabaseBuilder.addServerConfigStartup
(ServerConfigStartup configStartupListener) Add a ServerConfigStartup.default DatabaseBuilder
DatabaseBuilder.allQuotedIdentifiers
(boolean allQuotedIdentifiers) Set to true if all DB column and table names should use quoted identifiers.default DatabaseBuilder
DatabaseBuilder.alsoIf
(BooleanSupplier predicate, Consumer<DatabaseBuilder.Settings> apply) Conditionally apply configuration to this builder via a lambda.DatabaseBuilder.apply
(Consumer<DatabaseBuilder.Settings> applyConfiguration) Apply configuration to this builder using a lambda.default DatabaseBuilder
DatabaseBuilder.asOfSysPeriod
(String asOfSysPeriod) Set the database column used to support history and 'As of' queries.default DatabaseBuilder
DatabaseBuilder.asOfViewSuffix
(String asOfViewSuffix) Set 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.default DatabaseBuilder
DatabaseBuilder.autoPersistUpdates
(boolean autoPersistUpdates) Set to true if dirty beans are automatically persisted.default DatabaseBuilder
DatabaseBuilder.autoReadOnlyDataSource
(boolean autoReadOnlyDataSource) Set to true if Ebean should create a DataSource for use with implicit read only transactions.default DatabaseBuilder
DatabaseBuilder.autoTuneConfig
(AutoTuneConfig autoTuneConfig) Set the configuration for AutoTune.default DatabaseBuilder
DatabaseBuilder.backgroundExecutorSchedulePoolSize
(int backgroundExecutorSchedulePoolSize) Set the Background executor schedule pool size.default DatabaseBuilder
DatabaseBuilder.backgroundExecutorShutdownSecs
(int backgroundExecutorShutdownSecs) Set the Background executor shutdown seconds.default DatabaseBuilder
DatabaseBuilder.backgroundExecutorWrapper
(BackgroundExecutorWrapper backgroundExecutorWrapper) Sets the background executor wrapper.static DatabaseBuilder
Database.builder()
Return a new database builder.default DatabaseBuilder
DatabaseBuilder.cacheMaxIdleTime
(int cacheMaxIdleTime) Set the L2 cache default max idle time in seconds.default DatabaseBuilder
DatabaseBuilder.cacheMaxSize
(int cacheMaxSize) Set the L2 cache default max size.default DatabaseBuilder
DatabaseBuilder.cacheMaxTimeToLive
(int cacheMaxTimeToLive) Set the L2 cache default max time to live in seconds.default DatabaseBuilder
DatabaseBuilder.changeLogAsync
(boolean changeLogAsync) Sets if the changelog should be written async (default = true).default DatabaseBuilder
DatabaseBuilder.changeLogIncludeInserts
(boolean changeLogIncludeInserts) Set if inserts should be included in the change log by default.default DatabaseBuilder
DatabaseBuilder.changeLogListener
(ChangeLogListener changeLogListener) Set the ChangeLogListener which actually performs the logging of change sets in the background.default DatabaseBuilder
DatabaseBuilder.changeLogPrepare
(ChangeLogPrepare changeLogPrepare) Set the ChangeLogPrepare.default DatabaseBuilder
DatabaseBuilder.changeLogRegister
(ChangeLogRegister changeLogRegister) Set 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.DatabaseBuilder.classes
(Collection<Class<?>> classes) Set the list of classes (entities, listeners, scalarTypes etc) that should be used for this database.default DatabaseBuilder
DatabaseBuilder.classLoadConfig
(ClassLoadConfig classLoadConfig) Set the ClassLoadConfig which is used to detect Joda, Java8 types etc and also create new instances of plugins given a className.default DatabaseBuilder
Set the clock used for setting the timestamps (e.g.default DatabaseBuilder
DatabaseBuilder.constraintNaming
(DbConstraintNaming constraintNaming) Set the constraint naming convention used in DDL generation.default DatabaseBuilder
DatabaseBuilder.containerConfig
(ContainerConfig containerConfig) Set the container / clustering configuration.default DatabaseBuilder
DatabaseBuilder.currentTenantProvider
(CurrentTenantProvider currentTenantProvider) Set the current tenant provider.default DatabaseBuilder
DatabaseBuilder.currentUserProvider
(CurrentUserProvider currentUserProvider) Set the CurrentUserProvider.default DatabaseBuilder
DatabaseBuilder.databaseBooleanFalse
(String databaseFalse) Set the value to represent FALSE in the database.default DatabaseBuilder
DatabaseBuilder.databaseBooleanTrue
(String databaseTrue) Set the value to represent TRUE in the database.default DatabaseBuilder
DatabaseBuilder.databasePlatform
(DatabasePlatform databasePlatform) Explicitly set the database platform to use.default DatabaseBuilder
DatabaseBuilder.databasePlatformName
(String databasePlatformName) Explicitly set the database platform namedefault DatabaseBuilder
DatabaseBuilder.databaseSequenceBatch
(int databaseSequenceBatchSize) Set the number of DB sequence values that should be preallocated and cached by Ebean.default DatabaseBuilder
DatabaseBuilder.databaseSequenceBatchSize
(int databaseSequenceBatchSize) Set the number of sequences to fetch/preallocate when using DB sequences.default DatabaseBuilder
DatabaseBuilder.dataSource
(DataSource dataSource) Set a DataSource.default DatabaseBuilder
DatabaseBuilder.dataSourceBuilder
(io.ebean.datasource.DataSourceBuilder dataSourceConfig) Set the configuration required to build a DataSource using Ebean's own DataSource implementation.default DatabaseBuilder
DatabaseBuilder.dataTimeZone
(String dataTimeZone) Set the time zone to use when reading/writing Timestamps via JDBC.default DatabaseBuilder
Set the DbEncrypt used to encrypt and decrypt properties.default DatabaseBuilder
Set the DB schema to use.default DatabaseBuilder
DatabaseBuilder.dbUuid
(PlatformConfig.DbUuid dbUuid) Set the DB type used to store UUID.default DatabaseBuilder
DatabaseBuilder.ddlCreateOnly
(boolean ddlCreateOnly) Set to true if the "drop all ddl" should be skipped.default DatabaseBuilder
DatabaseBuilder.ddlExtra
(boolean ddlExtra) Set to false if you not want to run the extra-ddl.xml scripts.default DatabaseBuilder
DatabaseBuilder.ddlGenerate
(boolean ddlGenerate) Set to true to generate the "create all" DDL on startup.default DatabaseBuilder
Set the header to use with DDL generation.default DatabaseBuilder
DatabaseBuilder.ddlInitSql
(String ddlInitSql) Set a SQL script to execute before the "create all" DDL has been run.default DatabaseBuilder
DatabaseBuilder.ddlPlaceholderMap
(Map<String, String> ddlPlaceholderMap) Set a map of placeholder values that are substituted in DDL scripts.default DatabaseBuilder
DatabaseBuilder.ddlPlaceholders
(String ddlPlaceholders) Set a comma and equals delimited placeholders that are substituted in DDL scripts.default DatabaseBuilder
DatabaseBuilder.ddlRun
(boolean ddlRun) Set to true to run the generated "create all DDL" on startup.default DatabaseBuilder
DatabaseBuilder.ddlSeedSql
(String ddlSeedSql) Set a SQL script to execute after the "create all" DDL has been run.default DatabaseBuilder
DatabaseBuilder.ddlStrictMode
(boolean ddlStrictMode) Set to false to turn off strict mode allowing non-null columns to not have a default value.default DatabaseBuilder
DatabaseBuilder.defaultDatabase
(boolean defaultServer) Set false if you do not want this Database to be registered as the "default" database with the DB singleton.default DatabaseBuilder
DatabaseBuilder.defaultEnumType
(jakarta.persistence.EnumType defaultEnumType) Set the default mapping for enum type.default DatabaseBuilder
DatabaseBuilder.disableClasspathSearch
(boolean disableClasspathSearch) Set to true to disable the class path search even for the case where no entity bean classes have been registered.default DatabaseBuilder
DatabaseBuilder.disableL2Cache
(boolean disableL2Cache) Set to true to disable L2 caching.default DatabaseBuilder
DatabaseBuilder.disableLazyLoading
(boolean disableLazyLoading) Set to true to disable lazy loading by default.default DatabaseBuilder
DatabaseBuilder.dumpMetricsOnShutdown
(boolean dumpMetricsOnShutdown) Set to true if metrics should be dumped when the server is shutdown.default DatabaseBuilder
DatabaseBuilder.dumpMetricsOptions
(String dumpMetricsOptions) Include 'sql' or 'hash' in options such that they are included in the output.default DatabaseBuilder
DatabaseBuilder.durationWithNanos
(boolean durationWithNanos) Set to true if Duration should be persisted with nanos precision (SQL DECIMAL).default DatabaseBuilder
DatabaseBuilder.eagerFetchLobs
(boolean eagerFetchLobs) Set to true if you want LOB's to be fetch eager by default.default DatabaseBuilder
DatabaseBuilder.enabledL2Regions
(String enabledL2Regions) Set the enabled L2 cache regions (comma delimited).default DatabaseBuilder
DatabaseBuilder.encryptDeployManager
(EncryptDeployManager encryptDeployManager) Set the EncryptDeployManager.default DatabaseBuilder
DatabaseBuilder.encryptKeyManager
(EncryptKeyManager encryptKeyManager) Set the EncryptKeyManager.default DatabaseBuilder
Set the Encryptor used to encrypt data on the java client side (as opposed to DB encryption functions).default DatabaseBuilder
DatabaseBuilder.expressionEqualsWithNullAsNoop
(boolean expressionEqualsWithNullAsNoop) Set to true if you want eq("someProperty", null) to generate "1=1" rather than "is null" sql expression.default DatabaseBuilder
DatabaseBuilder.expressionNativeIlike
(boolean expressionNativeIlike) Set to true to use native ILIKE expression if supported by the database platform (e.g.default DatabaseBuilder
DatabaseBuilder.externalTransactionManager
(ExternalTransactionManager externalTransactionManager) Set the external transaction manager.default DatabaseBuilder
DatabaseBuilder.geometrySRID
(int geometrySRID) Set the Geometry SRID.default DatabaseBuilder
DatabaseBuilder.historyTableSuffix
(String historyTableSuffix) Set the history table suffix.default DatabaseBuilder
DatabaseBuilder.idGeneratorAutomatic
(boolean idGeneratorAutomatic) Set to false such that Id properties require explicit@GeneratedValue
mapping before they are assigned Identity or Sequence generation based on platform.default DatabaseBuilder
Set the preferred DB platform IdType.default DatabaseBuilder
DatabaseBuilder.jdbcFetchSizeFindEach
(int jdbcFetchSizeFindEach) Set the default JDBC fetchSize hint for findEach/findEachWhile queries.default DatabaseBuilder
DatabaseBuilder.jdbcFetchSizeFindList
(int jdbcFetchSizeFindList) Set the default JDBC fetchSize hint for findList queries.default DatabaseBuilder
DatabaseBuilder.jodaLocalTimeMode
(String jodaLocalTimeMode) Set the mode to use for Joda LocalTime support 'normal' or 'utc'.default DatabaseBuilder
DatabaseBuilder.jsonDate
(JsonConfig.Date jsonDate) Set the JSON format to use for Date types.default DatabaseBuilder
DatabaseBuilder.jsonDateTime
(JsonConfig.DateTime jsonDateTime) Set the JSON format to use for DateTime types.default DatabaseBuilder
DatabaseBuilder.jsonFactory
(com.fasterxml.jackson.core.JsonFactory jsonFactory) Set the Jackson JsonFactory to use.default DatabaseBuilder
DatabaseBuilder.jsonInclude
(JsonConfig.Include jsonInclude) Set the JSON include mode used when writing JSON.default DatabaseBuilder
DatabaseBuilder.jsonMutationDetection
(io.ebean.annotation.MutationDetection jsonMutationDetection) Set the default MutableDetection to use with@DbJson
using Jackson.default DatabaseBuilder
DatabaseBuilder.lazyLoadBatchSize
(int lazyLoadBatchSize) Set the default batch size for lazy loading.DatabaseBuilder.loadFromProperties()
Load settings from application.properties, application.yaml and other sources.DatabaseBuilder.loadFromProperties
(Properties properties) Load the settings from the given propertiesdefault DatabaseBuilder
DatabaseBuilder.loadModuleInfo
(boolean loadModuleInfo) Set false to turn off automatic registration of entity beans.default DatabaseBuilder
DatabaseBuilder.localOnlyL2Cache
(boolean localOnlyL2Cache) Force the use of local only L2 cache.default DatabaseBuilder
DatabaseBuilder.localTimeWithNanos
(boolean localTimeWithNanos) Set to true if LocalTime should be persisted with nanos precision.default DatabaseBuilder
DatabaseBuilder.mappingLocations
(List<String> mappingLocations) Set mapping locations to search for xml mapping via class path search.default DatabaseBuilder
DatabaseBuilder.maxCallStack
(int maxCallStack) Set the max call stack to use for origin location.default DatabaseBuilder
DatabaseBuilder.metricNaming
(Function<String, String> metricNaming) Set the naming convention to apply to metrics names.default DatabaseBuilder
Set the name of the Database.default DatabaseBuilder
DatabaseBuilder.namingConvention
(NamingConvention namingConvention) Set the NamingConvention.default DatabaseBuilder
DatabaseBuilder.notifyL2CacheInForeground
(boolean notifyL2CacheInForeground) Set this to true to run L2 cache notification in the foreground.default DatabaseBuilder
DatabaseBuilder.objectMapper
(Object objectMapper) Set the Jackson ObjectMapper.default DatabaseBuilder
DatabaseBuilder.offline
(boolean dbOffline) Set to true if the Database instance should be created in offline mode.default DatabaseBuilder
DatabaseBuilder.persistBatch
(io.ebean.annotation.PersistBatch persistBatch) Set the JDBC batch mode to use at the transaction level.default DatabaseBuilder
DatabaseBuilder.persistBatching
(boolean persistBatching) Deprecated, please migrate to using setPersistBatch().default DatabaseBuilder
DatabaseBuilder.persistBatchOnCascade
(io.ebean.annotation.PersistBatch persistBatchOnCascade) Set the JDBC batch mode to use per save(), delete(), insert() or update() request.default DatabaseBuilder
DatabaseBuilder.persistBatchSize
(int persistBatchSize) Set the batch size used for JDBC batching.default DatabaseBuilder
DatabaseBuilder.persistenceContextScope
(PersistenceContextScope persistenceContextScope) Set the PersistenceContext scope to be used if one is not explicitly set on a query.default DatabaseBuilder
DatabaseBuilder.platformConfig
(PlatformConfig platformConfig) Set the configuration for DB platform (such as UUID and custom mappings).default DatabaseBuilder
DatabaseBuilder.profilingConfig
(ProfilingConfig profilingConfig) Set the configuration for profiling.<T> DatabaseBuilder
DatabaseBuilder.putServiceObject
(Class<T> iface, T configObject) Put a service object into configuration such that it can be used by ebean or a plugin.DatabaseBuilder.putServiceObject
(Object configObject) Put a service object into configuration such that it can be used by ebean or a plugin.DatabaseBuilder.putServiceObject
(String key, Object configObject) Put a service object into configuration such that it can be used by ebean or a plugin.default DatabaseBuilder
DatabaseBuilder.queryBatchSize
(int queryBatchSize) Sets the query batch size.default DatabaseBuilder
DatabaseBuilder.queryCacheMaxIdleTime
(int queryCacheMaxIdleTime) Set the L2 query cache default max idle time in seconds.default DatabaseBuilder
DatabaseBuilder.queryCacheMaxSize
(int queryCacheMaxSize) Set the L2 query cache default max size.default DatabaseBuilder
DatabaseBuilder.queryCacheMaxTimeToLive
(int queryCacheMaxTimeToLive) Set the L2 query cache default max time to live in seconds.default DatabaseBuilder
DatabaseBuilder.queryPlanCapture
(boolean queryPlanCapture) Set to true to turn on periodic capture of query plans.default DatabaseBuilder
DatabaseBuilder.queryPlanCaptureMaxCount
(int queryPlanCaptureMaxCount) Set the max number of query plans captured per request.default DatabaseBuilder
DatabaseBuilder.queryPlanCaptureMaxTimeMillis
(long queryPlanCaptureMaxTimeMillis) Set the time after which a capture query plans request will stop capturing more query plans.default DatabaseBuilder
DatabaseBuilder.queryPlanCapturePeriodSecs
(long queryPlanCapturePeriodSecs) Set the frequency in seconds to capture query plans.default DatabaseBuilder
DatabaseBuilder.queryPlanEnable
(boolean queryPlanEnable) Set to true to enable query plan capture.default DatabaseBuilder
DatabaseBuilder.queryPlanListener
(QueryPlanListener queryPlanListener) Set the listener used to process captured query plans.default DatabaseBuilder
DatabaseBuilder.queryPlanThresholdMicros
(long queryPlanThresholdMicros) Set the query plan collection threshold in microseconds.default DatabaseBuilder
DatabaseBuilder.queryPlanTTLSeconds
(int queryPlanTTLSeconds) Set the time to live for ebean's internal query plan.DatabaseBuilder.readOnlyDatabase
(boolean readOnlyDatabase) Set to true if this database is used in a read only way.default DatabaseBuilder
DatabaseBuilder.readOnlyDataSource
(DataSource readOnlyDataSource) Set the read only DataSource.default DatabaseBuilder
DatabaseBuilder.readOnlyDataSourceBuilder
(io.ebean.datasource.DataSourceBuilder readOnlyDataSourceConfig) Set the configuration for the read only DataSource.default DatabaseBuilder
DatabaseBuilder.register
(boolean register) Set to false if you do not want this server to be registered with the Ebean singleton when it is created.default DatabaseBuilder
DatabaseBuilder.resourceDirectory
(String resourceDirectory) Sets the resource directory.default DatabaseBuilder
DatabaseBuilder.runMigration
(boolean runMigration) Set to true to run DB migrations on server start.default DatabaseBuilder
DatabaseBuilder.serverCachePlugin
(ServerCachePlugin serverCachePlugin) Set the ServerCachePlugin to use.DatabaseBuilder.setAllQuotedIdentifiers
(boolean allQuotedIdentifiers) Deprecated.DatabaseBuilder.setAsOfSysPeriod
(String asOfSysPeriod) Deprecated.migrate toasOfSysPeriod(String)
.DatabaseBuilder.setAsOfViewSuffix
(String asOfViewSuffix) Deprecated.migrate toasOfViewSuffix(String)
.DatabaseBuilder.setAutoPersistUpdates
(boolean autoPersistUpdates) Deprecated.migrate toautoPersistUpdates(boolean)
.DatabaseBuilder.setAutoReadOnlyDataSource
(boolean autoReadOnlyDataSource) Deprecated.migrate toautoReadOnlyDataSource(boolean)
.DatabaseBuilder.setAutoTuneConfig
(AutoTuneConfig autoTuneConfig) Deprecated.migrate toautoTuneConfig(AutoTuneConfig)
.DatabaseBuilder.setBackgroundExecutorSchedulePoolSize
(int backgroundExecutorSchedulePoolSize) Deprecated.migrate tobackgroundExecutorSchedulePoolSize(int)
.DatabaseBuilder.setBackgroundExecutorShutdownSecs
(int backgroundExecutorShutdownSecs) Deprecated.migrate tobackgroundExecutorShutdownSecs(int)
.DatabaseBuilder.setBackgroundExecutorWrapper
(BackgroundExecutorWrapper backgroundExecutorWrapper) Deprecated.DatabaseBuilder.setCacheMaxIdleTime
(int cacheMaxIdleTime) Deprecated.migrate tocacheMaxIdleTime(int)
.DatabaseBuilder.setCacheMaxSize
(int cacheMaxSize) Deprecated.migrate tocacheMaxSize(int)
.DatabaseBuilder.setCacheMaxTimeToLive
(int cacheMaxTimeToLive) Deprecated.migrate tocacheMaxTimeToLive(int)
.DatabaseBuilder.setChangeLogAsync
(boolean changeLogAsync) Deprecated.migrate tochangeLogAsync(boolean)
.DatabaseBuilder.setChangeLogIncludeInserts
(boolean changeLogIncludeInserts) Deprecated.migrate tochangeLogIncludeInserts(boolean)
.DatabaseBuilder.setChangeLogListener
(ChangeLogListener changeLogListener) Deprecated.migrate tochangeLogListener(ChangeLogListener)
.DatabaseBuilder.setChangeLogPrepare
(ChangeLogPrepare changeLogPrepare) Deprecated.migrate tochangeLogPrepare(ChangeLogPrepare)
.DatabaseBuilder.setChangeLogRegister
(ChangeLogRegister changeLogRegister) Deprecated.migrate tochangeLogRegister(ChangeLogRegister)
.DatabaseBuilder.setClassLoadConfig
(ClassLoadConfig classLoadConfig) Deprecated.migrate toclassLoadConfig(ClassLoadConfig)
.Deprecated.migrate toclock(Clock)
.DatabaseBuilder.setConstraintNaming
(DbConstraintNaming constraintNaming) Deprecated.migrate toconstraintNaming(DbConstraintNaming)
.DatabaseBuilder.setContainerConfig
(ContainerConfig containerConfig) Deprecated.migrate tocontainerConfig(ContainerConfig)
.DatabaseBuilder.setCurrentTenantProvider
(CurrentTenantProvider currentTenantProvider) Deprecated.migrate tocurrentTenantProvider(CurrentTenantProvider)
.DatabaseBuilder.setCurrentUserProvider
(CurrentUserProvider currentUserProvider) Deprecated.migrate tocurrentUserProvider(CurrentUserProvider)
.DatabaseBuilder.setDatabaseBooleanFalse
(String databaseFalse) Deprecated.migrate todatabaseBooleanFalse(String)
.DatabaseBuilder.setDatabaseBooleanTrue
(String databaseTrue) Deprecated.migrate todatabaseBooleanTrue(String)
.DatabaseBuilder.setDatabasePlatform
(DatabasePlatform databasePlatform) Deprecated.migrate todatabasePlatform(DatabasePlatform)
.DatabaseBuilder.setDatabasePlatformName
(String databasePlatformName) Deprecated.migrate todatabasePlatformName(String)
.DatabaseBuilder.setDatabaseSequenceBatch
(int databaseSequenceBatchSize) Deprecated.migrate todatabaseSequenceBatch(int)
.DatabaseBuilder.setDatabaseSequenceBatchSize
(int databaseSequenceBatchSize) Deprecated.migrate todatabaseSequenceBatchSize(int)
.DatabaseBuilder.setDataSource
(DataSource dataSource) Deprecated.migrate todataSource(DataSource)
.DatabaseBuilder.setDataSourceConfig
(io.ebean.datasource.DataSourceBuilder dataSourceConfig) Deprecated.migrate todataSourceBuilder(DataSourceBuilder)
.DatabaseBuilder.setDataTimeZone
(String dataTimeZone) Deprecated.migrate todataTimeZone(String)
.DatabaseBuilder.setDbEncrypt
(DbEncrypt dbEncrypt) Deprecated.migrate todbEncrypt(DbEncrypt)
.DatabaseBuilder.setDbOffline
(boolean dbOffline) Deprecated.migrate tooffline(boolean)
.DatabaseBuilder.setDbSchema
(String dbSchema) Deprecated.migrate tosetDbSchema(String)
DatabaseBuilder.setDbUuid
(PlatformConfig.DbUuid dbUuid) Deprecated.migrate todbUuid(PlatformConfig.DbUuid)
.DatabaseBuilder.setDdlCreateOnly
(boolean ddlCreateOnly) Deprecated.migrate toddlCreateOnly(boolean)
.DatabaseBuilder.setDdlExtra
(boolean ddlExtra) Deprecated.migrate toddlExtra(boolean)
.DatabaseBuilder.setDdlGenerate
(boolean ddlGenerate) Deprecated.migrate toddlGenerate(boolean)
.DatabaseBuilder.setDdlHeader
(String ddlHeader) Deprecated.migrate toddlHeader(String)
.DatabaseBuilder.setDdlInitSql
(String ddlInitSql) Deprecated.migrate toddlInitSql(String)
.DatabaseBuilder.setDdlPlaceholderMap
(Map<String, String> ddlPlaceholderMap) Deprecated.migrate toddlPlaceholderMap(Map)
.DatabaseBuilder.setDdlPlaceholders
(String ddlPlaceholders) Deprecated.migrate toddlPlaceholders(String)
.DatabaseBuilder.setDdlRun
(boolean ddlRun) Deprecated.migrate toddlRun(boolean)
.DatabaseBuilder.setDdlSeedSql
(String ddlSeedSql) Deprecated.migrate toddlSeedSql(String)
.DatabaseBuilder.setDdlStrictMode
(boolean ddlStrictMode) Deprecated.migrate toddlStrictMode(boolean)
.DatabaseBuilder.setDefaultEnumType
(jakarta.persistence.EnumType defaultEnumType) Deprecated.migrate todefaultEnumType(EnumType)
.DatabaseBuilder.setDefaultServer
(boolean defaultServer) Deprecated.migrate todefaultDatabase(boolean)
.DatabaseBuilder.setDisableClasspathSearch
(boolean disableClasspathSearch) Deprecated.migrate todisableClasspathSearch(boolean)
.DatabaseBuilder.setDisableL2Cache
(boolean disableL2Cache) Deprecated.migrate todisableL2Cache(boolean)
.DatabaseBuilder.setDisableLazyLoading
(boolean disableLazyLoading) Deprecated.migrate todisableLazyLoading(boolean)
.DatabaseBuilder.setDumpMetricsOnShutdown
(boolean dumpMetricsOnShutdown) Deprecated.migrate todumpMetricsOnShutdown(boolean)
.DatabaseBuilder.setDumpMetricsOptions
(String dumpMetricsOptions) Deprecated.migrate todumpMetricsOptions(String)
.DatabaseBuilder.setDurationWithNanos
(boolean durationWithNanos) Deprecated.migrate todurationWithNanos(boolean)
.DatabaseBuilder.setEagerFetchLobs
(boolean eagerFetchLobs) Deprecated.migrate toeagerFetchLobs(boolean)
.DatabaseBuilder.setEnabledL2Regions
(String enabledL2Regions) Deprecated.migrate toenabledL2Regions(String)
.DatabaseBuilder.setEncryptDeployManager
(EncryptDeployManager encryptDeployManager) Deprecated.migrate toencryptDeployManager(EncryptDeployManager)
.DatabaseBuilder.setEncryptKeyManager
(EncryptKeyManager encryptKeyManager) Deprecated.migrate toencryptKeyManager(EncryptKeyManager)
.DatabaseBuilder.setEncryptor
(Encryptor encryptor) Deprecated.migrate toencryptor(Encryptor)
.DatabaseBuilder.setExpressionEqualsWithNullAsNoop
(boolean expressionEqualsWithNullAsNoop) Deprecated.migrate toexpressionEqualsWithNullAsNoop(boolean)
.DatabaseBuilder.setExpressionNativeIlike
(boolean expressionNativeIlike) Deprecated.migrate toexpressionNativeIlike(boolean)
.DatabaseBuilder.setExternalTransactionManager
(ExternalTransactionManager externalTransactionManager) Deprecated.DatabaseBuilder.setFindControllers
(List<BeanFindController> findControllers) Set the list of BeanFindController instances.DatabaseBuilder.setGeometrySRID
(int geometrySRID) Deprecated.migrate togeometrySRID(int)
.DatabaseBuilder.setHistoryTableSuffix
(String historyTableSuffix) Deprecated.migrate tohistoryTableSuffix(String)
.DatabaseBuilder.setIdGeneratorAutomatic
(boolean idGeneratorAutomatic) Deprecated.migrate toidGeneratorAutomatic(boolean)
.DatabaseBuilder.setIdGenerators
(List<IdGenerator> idGenerators) Set the custom IdGenerator instances.Deprecated.migrate toidType(IdType)
.DatabaseBuilder.setJdbcFetchSizeFindEach
(int jdbcFetchSizeFindEach) Deprecated.migrate tojdbcFetchSizeFindEach(int)
.DatabaseBuilder.setJdbcFetchSizeFindList
(int jdbcFetchSizeFindList) Deprecated.migrate tojdbcFetchSizeFindList(int)
.DatabaseBuilder.setJodaLocalTimeMode
(String jodaLocalTimeMode) Deprecated.migrate tojodaLocalTimeMode(String)
.DatabaseBuilder.setJsonDate
(JsonConfig.Date jsonDate) Deprecated.migrate tojsonDateTime(JsonConfig.DateTime)
.DatabaseBuilder.setJsonDateTime
(JsonConfig.DateTime jsonDateTime) Deprecated.migrate tojsonDateTime(JsonConfig.DateTime)
.DatabaseBuilder.setJsonFactory
(com.fasterxml.jackson.core.JsonFactory jsonFactory) Deprecated.migrate tojsonFactory(JsonFactory)
.DatabaseBuilder.setJsonInclude
(JsonConfig.Include jsonInclude) Deprecated.migrate tojsonInclude(JsonConfig.Include)
.DatabaseBuilder.setJsonMutationDetection
(io.ebean.annotation.MutationDetection jsonMutationDetection) Deprecated.migrate tojsonMutationDetection(MutationDetection)
.DatabaseBuilder.setLazyLoadBatchSize
(int lazyLoadBatchSize) Deprecated.migrate tolazyLoadBatchSize(int)
.DatabaseBuilder.setLoadModuleInfo
(boolean loadModuleInfo) Deprecated.migrate toloadModuleInfo(boolean)
.DatabaseBuilder.setLocalOnlyL2Cache
(boolean localOnlyL2Cache) Deprecated.migrate tolocalOnlyL2Cache(boolean)
.DatabaseBuilder.setLocalTimeWithNanos
(boolean localTimeWithNanos) Deprecated.migrate tolocalTimeWithNanos(boolean)
.DatabaseBuilder.setMappingLocations
(List<String> mappingLocations) Deprecated.migrate tomappingLocations(List)
.DatabaseBuilder.setMaxCallStack
(int maxCallStack) Deprecated.migrate tomaxCallStack(int)
.DatabaseBuilder.setMetricNaming
(Function<String, String> metricNaming) Deprecated.migrate tometricNaming(Function)
.Deprecated.migrate toname(String)
.DatabaseBuilder.setNamingConvention
(NamingConvention namingConvention) Deprecated.migrate tonamingConvention(NamingConvention)
.DatabaseBuilder.setNotifyL2CacheInForeground
(boolean notifyL2CacheInForeground) Deprecated.migrate tonotifyL2CacheInForeground(boolean)
.DatabaseBuilder.setObjectMapper
(Object objectMapper) Deprecated.migrate toobjectMapper(Object)
.DatabaseBuilder.setPackages
(List<String> packages) Set packages to search for entities via class path search.DatabaseBuilder.setPersistBatch
(io.ebean.annotation.PersistBatch persistBatch) Deprecated.migrate topersistBatch(PersistBatch)
.DatabaseBuilder.setPersistBatching
(boolean persistBatching) Deprecated.migrate topersistBatching(boolean)
.DatabaseBuilder.setPersistBatchOnCascade
(io.ebean.annotation.PersistBatch persistBatchOnCascade) Deprecated.migrate topersistBatchOnCascade(PersistBatch)
.DatabaseBuilder.setPersistBatchSize
(int persistBatchSize) Deprecated.migrate topersistBatchSize(int)
.DatabaseBuilder.setPersistControllers
(List<BeanPersistController> persistControllers) Register all the BeanPersistController instances.DatabaseBuilder.setPersistenceContextScope
(PersistenceContextScope persistenceContextScope) Deprecated.migrate topersistenceContextScope(PersistenceContextScope)
.DatabaseBuilder.setPersistListeners
(List<BeanPersistListener> persistListeners) Register all the BeanPersistListener instances.DatabaseBuilder.setPlatformConfig
(PlatformConfig platformConfig) Deprecated.migrate toplatformConfig(PlatformConfig)
.DatabaseBuilder.setPostConstructListeners
(List<BeanPostConstructListener> listeners) Set the list of BeanPostLoader instances.DatabaseBuilder.setPostLoaders
(List<BeanPostLoad> postLoaders) Set the list of BeanPostLoader instances.DatabaseBuilder.setProfilingConfig
(ProfilingConfig profilingConfig) Deprecated.migrate toprofilingConfig(ProfilingConfig)
.DatabaseBuilder.setQueryAdapters
(List<BeanQueryAdapter> queryAdapters) Register all the BeanQueryAdapter instances.DatabaseBuilder.setQueryBatchSize
(int queryBatchSize) Deprecated.migrate toqueryBatchSize(int)
.DatabaseBuilder.setQueryCacheMaxIdleTime
(int queryCacheMaxIdleTime) Deprecated.migrate toqueryCacheMaxIdleTime(int)
.DatabaseBuilder.setQueryCacheMaxSize
(int queryCacheMaxSize) Deprecated.migrate toqueryCacheMaxSize(int)
.DatabaseBuilder.setQueryCacheMaxTimeToLive
(int queryCacheMaxTimeToLive) Deprecated.migrate toqueryCacheMaxTimeToLive(int)
.DatabaseBuilder.setQueryPlanCapture
(boolean queryPlanCapture) Deprecated.migrate toqueryPlanCapture(boolean)
.DatabaseBuilder.setQueryPlanCaptureMaxCount
(int queryPlanCaptureMaxCount) Deprecated.migrate toqueryPlanCaptureMaxCount(int)
.DatabaseBuilder.setQueryPlanCaptureMaxTimeMillis
(long queryPlanCaptureMaxTimeMillis) Deprecated.migrate toqueryPlanCaptureMaxTimeMillis(long)
.DatabaseBuilder.setQueryPlanCapturePeriodSecs
(long queryPlanCapturePeriodSecs) Deprecated.migrate toqueryPlanCapturePeriodSecs(long)
.DatabaseBuilder.setQueryPlanEnable
(boolean queryPlanEnable) Deprecated.migrate toqueryPlanEnable(boolean)
.DatabaseBuilder.setQueryPlanListener
(QueryPlanListener queryPlanListener) Deprecated.migrate toqueryPlanListener(QueryPlanListener)
.DatabaseBuilder.setQueryPlanThresholdMicros
(long queryPlanThresholdMicros) Deprecated.migrate toqueryPlanThresholdMicros(long)
.DatabaseBuilder.setQueryPlanTTLSeconds
(int queryPlanTTLSeconds) Deprecated.migrate toqueryPlanTTLSeconds(int)
.DatabaseBuilder.setReadOnlyDataSource
(DataSource readOnlyDataSource) Deprecated.migrate toreadOnlyDataSource(DataSource)
.DatabaseBuilder.setReadOnlyDataSourceConfig
(io.ebean.datasource.DataSourceBuilder readOnlyDataSourceConfig) Deprecated.migrate toreadOnlyDataSourceBuilder(DataSourceBuilder)
.DatabaseBuilder.setRegister
(boolean register) Deprecated.migrate toregister(boolean)
.DatabaseBuilder.setResourceDirectory
(String resourceDirectory) Deprecated.migrate toresourceDirectory(String)
.DatabaseBuilder.setRunMigration
(boolean runMigration) Deprecated.migrate torunMigration(boolean)
.DatabaseBuilder.setServerCachePlugin
(ServerCachePlugin serverCachePlugin) Deprecated.migrate toserverCachePlugin(ServerCachePlugin)
.DatabaseBuilder.setSkipCacheAfterWrite
(boolean skipCacheAfterWrite) Deprecated.migrate toskipCacheAfterWrite(boolean)
.DatabaseBuilder.setSkipDataSourceCheck
(boolean skipDataSourceCheck) Deprecated.migrate toskipDataSourceCheck(boolean)
.DatabaseBuilder.setSlowQueryListener
(SlowQueryListener slowQueryListener) Deprecated.migrate toslowQueryListener(SlowQueryListener)
.DatabaseBuilder.setSlowQueryMillis
(long slowQueryMillis) Deprecated.migrate toslowQueryMillis(long)
.DatabaseBuilder.setTenantCatalogProvider
(TenantCatalogProvider tenantCatalogProvider) Deprecated.migrate totenantCatalogProvider(TenantCatalogProvider)
.DatabaseBuilder.setTenantDataSourceProvider
(TenantDataSourceProvider tenantDataSourceProvider) Deprecated.DatabaseBuilder.setTenantMode
(TenantMode tenantMode) Deprecated.migrate totenantMode(TenantMode)
.DatabaseBuilder.setTenantPartitionColumn
(String tenantPartitionColumn) Deprecated.migrate totenantPartitionColumn(String)
.DatabaseBuilder.setTenantSchemaProvider
(TenantSchemaProvider tenantSchemaProvider) Deprecated.migrate totenantSchemaProvider(TenantSchemaProvider)
.DatabaseBuilder.setTransactionRollbackOnChecked
(boolean transactionRollbackOnChecked) Deprecated.migrate totransactionRollbackOnChecked(boolean)
.DatabaseBuilder.setUpdateAllPropertiesInBatch
(boolean updateAllPropertiesInBatch) Deprecated.migrate toupdateAllPropertiesInBatch(boolean)
.DatabaseBuilder.setUseJtaTransactionManager
(boolean useJtaTransactionManager) Deprecated.migrate touseJtaTransactionManager(boolean)
.DatabaseBuilder.setUseValidationNotNull
(boolean useValidationNotNull) Deprecated.migrate touseValidationNotNull(boolean)
.DatabaseBuilder.setUuidNodeId
(String uuidNodeId) Deprecated.migrate touuidNodeId(String)
.DatabaseBuilder.setUuidStateFile
(String uuidStateFile) Deprecated.migrate touuidStateFile(String)
.DatabaseBuilder.setUuidVersion
(DatabaseConfig.UuidVersion uuidVersion) Deprecated.migrate touuidVersion(DatabaseConfig.UuidVersion)
.default DatabaseBuilder
DatabaseBuilder.skipCacheAfterWrite
(boolean skipCacheAfterWrite) Set to false when we still want to hit the cache after a write has occurred on a transaction.default DatabaseBuilder
DatabaseBuilder.skipDataSourceCheck
(boolean skipDataSourceCheck) Set to true to skip the startup DataSource check.default DatabaseBuilder
DatabaseBuilder.slowQueryListener
(SlowQueryListener slowQueryListener) Set the slow query event listener.default DatabaseBuilder
DatabaseBuilder.slowQueryMillis
(long slowQueryMillis) Set the slow query time in millis.default DatabaseBuilder
DatabaseBuilder.tenantCatalogProvider
(TenantCatalogProvider tenantCatalogProvider) Set the tenancy catalog provider.default DatabaseBuilder
DatabaseBuilder.tenantDataSourceProvider
(TenantDataSourceProvider tenantDataSourceProvider) Set the tenancy datasource provider.default DatabaseBuilder
DatabaseBuilder.tenantMode
(TenantMode tenantMode) Set the tenancy mode to use.default DatabaseBuilder
DatabaseBuilder.tenantPartitionColumn
(String tenantPartitionColumn) Set the column name used for TenantMode.PARTITION.default DatabaseBuilder
DatabaseBuilder.tenantSchemaProvider
(TenantSchemaProvider tenantSchemaProvider) Set the tenancy schema provider.default DatabaseBuilder
DatabaseBuilder.transactionRollbackOnChecked
(boolean transactionRollbackOnChecked) Set to true if transactions should by default rollback on checked exceptions.default DatabaseBuilder
DatabaseBuilder.updateAllPropertiesInBatch
(boolean updateAllPropertiesInBatch) Set to false if by default updates in JDBC batch should not include all properties.default DatabaseBuilder
DatabaseBuilder.useJtaTransactionManager
(boolean useJtaTransactionManager) Set to true if we are running in a JTA Transaction manager.default DatabaseBuilder
DatabaseBuilder.useValidationNotNull
(boolean useValidationNotNull) Controls if Ebean should ignore&x64;javax.validation.contstraints.NotNull
or&x64;jakarta.validation.contstraints.NotNull
with respect to generating aNOT NULL
column.default DatabaseBuilder
DatabaseBuilder.uuidNodeId
(String uuidNodeId) Sets the V1-UUID-NodeId.default DatabaseBuilder
DatabaseBuilder.uuidStateFile
(String uuidStateFile) Set the UUID state file.default DatabaseBuilder
DatabaseBuilder.uuidVersion
(DatabaseConfig.UuidVersion uuidVersion) Sets the UUID version mode.Methods in io.ebean with parameters of type DatabaseBuilderModifier and TypeMethodDescriptionstatic Database
DatabaseFactory.create
(DatabaseBuilder builder) Create using the DatabaseConfig object to configure the database.static Database
DatabaseFactory.createWithContextClassLoader
(DatabaseBuilder config, ClassLoader classLoader) Create using the DatabaseConfig additionally specifying a classLoader to use as the context class loader. -
Uses of DatabaseBuilder in io.ebean.cache
Methods in io.ebean.cache with parameters of type DatabaseBuilderModifier and TypeMethodDescriptionServerCacheNotifyPlugin.create
(DatabaseBuilder config) Create a ServerCacheNotify implementation given the server configuration.ServerCachePlugin.create
(DatabaseBuilder config, BackgroundExecutor executor) Create the ServerCacheFactory given the server config and background executor service. -
Uses of DatabaseBuilder in io.ebean.config
Classes in io.ebean.config that implement DatabaseBuilderModifier and TypeClassDescriptionclass
The configuration used for creating a Database.Methods in io.ebean.config that return DatabaseBuilderModifier and TypeMethodDescriptionDatabaseConfig.apply
(Consumer<DatabaseBuilder.Settings> applyConfiguration) DatabaseConfig.readOnlyDatabase
(boolean readOnlyDatabase) Methods in io.ebean.config with parameters of type DatabaseBuilderModifier and TypeMethodDescriptionvoid
DatabaseConfigProvider.apply
(DatabaseBuilder config) Apply the configuration to the DatabaseConfig.void
AutoConfigure.postConfigure
(DatabaseBuilder config) Provide some configuration the DatabaseConfig prior to server creation but after properties have been applied.void
AutoConfigure.preConfigure
(DatabaseBuilder config) Perform configuration for the DatabaseConfig prior to properties load. -
Uses of DatabaseBuilder in io.ebean.event
Methods in io.ebean.event with parameters of type DatabaseBuilderModifier and TypeMethodDescriptionvoid
ServerConfigStartup.onStart
(DatabaseBuilder config) On starting configure the DatabaseConfig. -
Uses of DatabaseBuilder in io.ebean.service
Methods in io.ebean.service with parameters of type DatabaseBuilderModifier and TypeMethodDescriptionSpiContainer.createServer
(DatabaseBuilder configuration) Create the EbeanServer for a given configuration.
allQuotedIdentifiers(boolean)
.