Deprecated API

Contents

• Terminally Deprecated
• Classes
• Methods
• Constructors

Terminally Deprecated Elements

Element	Description
io.ebean.config.DatabaseConfig.getClasses()	- migrate to DatabaseConfig.classes().
io.ebean.config.DatabaseConfig.isAutoLoadModuleInfo()	- migrate to DatabaseConfig.isLoadModuleInfo().
io.ebean.DatabaseBuilder.Settings.getClasses()	- migrate to DatabaseBuilder.Settings.classes(). Sorry if returning Set rather than List breaks code but it feels safer to do that than a subtle change to return a shallow copy which you will not detect.
io.ebean.DatabaseBuilder.Settings.isAutoLoadModuleInfo()	- migrate to DatabaseBuilder.Settings.isLoadModuleInfo().
io.ebean.EmptyPagedList	migrate to using PagedList.emptyList() only. An empty PagedList. For use in application code when we need to return a PagedList but don't want to execute a query. PagedList<Customer> empty = PagedList.emptyList();
io.ebean.event.ServletContextListener
io.ebean.ExpressionList.delete(Transaction)	migrate to ExpressionList.usingTransaction(Transaction) then delete(). Execute as a delete query deleting the 'root level' beans that match the predicates in the query. Note that if the query includes joins then the generated delete statement may not be optimal depending on the database platform.
io.ebean.ExpressionList.order()	migrate to ExpressionList.orderBy().
io.ebean.ExpressionList.order(String)	migrate to ExpressionList.orderBy(String)
io.ebean.ExpressionList.update(Transaction)	migrate to ExpressionList.usingTransaction(Transaction) then update(). Execute as a update query with the given transaction.
io.ebean.OrderBy()	This method will be removed from public API. Create an empty OrderBy with no associated query.
io.ebean.OrderBy(Query<T>, String)	This method will be removed from public API.
io.ebean.OrderBy(String)	migrate to OrderBy.of(String).
io.ebean.OrderBy.copyWithTrim(String)	This method will become internal only API. Return a copy of this OrderBy with the path trimmed.
io.ebean.Query.delete(Transaction)	migrate to QueryBuilder.usingTransaction(Transaction) then delete(). Execute as a delete query returning the number of rows deleted using the given transaction. Note that if the query includes joins then the generated delete statement may not be optimal depending on the database platform.
io.ebean.Query.order()	migrate to Query.orderBy().
io.ebean.Query.order(String)	migrate to Query.orderBy().
io.ebean.Query.setOrder(OrderBy<T>)	migrate to QueryBuilder.setOrderBy(OrderBy).
io.ebean.Query.update(Transaction)	migrate to QueryBuilder.usingTransaction(Transaction) then update(). Execute the UpdateQuery returning the number of rows updated using the given transaction.

Deprecated Classes

Class	Description
io.ebean.EmptyPagedList	migrate to using PagedList.emptyList() only. An empty PagedList. For use in application code when we need to return a PagedList but don't want to execute a query. PagedList<Customer> empty = PagedList.emptyList();
io.ebean.event.ServletContextListener

Deprecated Methods

Method	Description
io.ebean.config.DatabaseConfig.getClasses()	- migrate to DatabaseConfig.classes().
io.ebean.config.DatabaseConfig.isAutoLoadModuleInfo()	- migrate to DatabaseConfig.isLoadModuleInfo().
io.ebean.DatabaseBuilder.setAllQuotedIdentifiers(boolean)	migrate to DatabaseBuilder.allQuotedIdentifiers(boolean).
io.ebean.DatabaseBuilder.setAsOfSysPeriod(String)	migrate to DatabaseBuilder.asOfSysPeriod(String).
io.ebean.DatabaseBuilder.setAsOfViewSuffix(String)	migrate to DatabaseBuilder.asOfViewSuffix(String).
io.ebean.DatabaseBuilder.setAutoPersistUpdates(boolean)	migrate to DatabaseBuilder.autoPersistUpdates(boolean).
io.ebean.DatabaseBuilder.setAutoReadOnlyDataSource(boolean)	migrate to DatabaseBuilder.autoReadOnlyDataSource(boolean).
io.ebean.DatabaseBuilder.setAutoTuneConfig(AutoTuneConfig)	migrate to DatabaseBuilder.autoTuneConfig(AutoTuneConfig).
io.ebean.DatabaseBuilder.setBackgroundExecutorSchedulePoolSize(int)	migrate to DatabaseBuilder.backgroundExecutorSchedulePoolSize(int).
io.ebean.DatabaseBuilder.setBackgroundExecutorShutdownSecs(int)	migrate to DatabaseBuilder.backgroundExecutorShutdownSecs(int).
io.ebean.DatabaseBuilder.setBackgroundExecutorWrapper(BackgroundExecutorWrapper)	migrate to DatabaseBuilder.backgroundExecutorWrapper(BackgroundExecutorWrapper).
io.ebean.DatabaseBuilder.setCacheMaxIdleTime(int)	migrate to DatabaseBuilder.cacheMaxIdleTime(int).
io.ebean.DatabaseBuilder.setCacheMaxSize(int)	migrate to DatabaseBuilder.cacheMaxSize(int).
io.ebean.DatabaseBuilder.setCacheMaxTimeToLive(int)	migrate to DatabaseBuilder.cacheMaxTimeToLive(int).
io.ebean.DatabaseBuilder.setChangeLogAsync(boolean)	migrate to DatabaseBuilder.changeLogAsync(boolean).
io.ebean.DatabaseBuilder.setChangeLogIncludeInserts(boolean)	migrate to DatabaseBuilder.changeLogIncludeInserts(boolean).
io.ebean.DatabaseBuilder.setChangeLogListener(ChangeLogListener)	migrate to DatabaseBuilder.changeLogListener(ChangeLogListener).
io.ebean.DatabaseBuilder.setChangeLogPrepare(ChangeLogPrepare)	migrate to DatabaseBuilder.changeLogPrepare(ChangeLogPrepare).
io.ebean.DatabaseBuilder.setChangeLogRegister(ChangeLogRegister)	migrate to DatabaseBuilder.changeLogRegister(ChangeLogRegister).
io.ebean.DatabaseBuilder.setClassLoadConfig(ClassLoadConfig)	migrate to DatabaseBuilder.classLoadConfig(ClassLoadConfig).
io.ebean.DatabaseBuilder.setClock(Clock)	migrate to DatabaseBuilder.clock(Clock).
io.ebean.DatabaseBuilder.setConstraintNaming(DbConstraintNaming)	migrate to DatabaseBuilder.constraintNaming(DbConstraintNaming).
io.ebean.DatabaseBuilder.setContainerConfig(ContainerConfig)	migrate to DatabaseBuilder.containerConfig(ContainerConfig).
io.ebean.DatabaseBuilder.setCurrentTenantProvider(CurrentTenantProvider)	migrate to DatabaseBuilder.currentTenantProvider(CurrentTenantProvider).
io.ebean.DatabaseBuilder.setCurrentUserProvider(CurrentUserProvider)	migrate to DatabaseBuilder.currentUserProvider(CurrentUserProvider).
io.ebean.DatabaseBuilder.setDatabaseBooleanFalse(String)	migrate to DatabaseBuilder.databaseBooleanFalse(String).
io.ebean.DatabaseBuilder.setDatabaseBooleanTrue(String)	migrate to DatabaseBuilder.databaseBooleanTrue(String).
io.ebean.DatabaseBuilder.setDatabasePlatform(DatabasePlatform)	migrate to DatabaseBuilder.databasePlatform(DatabasePlatform).
io.ebean.DatabaseBuilder.setDatabasePlatformName(String)	migrate to DatabaseBuilder.databasePlatformName(String).
io.ebean.DatabaseBuilder.setDatabaseSequenceBatch(int)	migrate to DatabaseBuilder.databaseSequenceBatch(int).
io.ebean.DatabaseBuilder.setDatabaseSequenceBatchSize(int)	migrate to DatabaseBuilder.databaseSequenceBatchSize(int).
io.ebean.DatabaseBuilder.setDataSource(DataSource)	migrate to DatabaseBuilder.dataSource(DataSource).
io.ebean.DatabaseBuilder.setDataSourceConfig(DataSourceBuilder)	migrate to DatabaseBuilder.dataSourceBuilder(DataSourceBuilder).
io.ebean.DatabaseBuilder.setDataTimeZone(String)	migrate to DatabaseBuilder.dataTimeZone(String).
io.ebean.DatabaseBuilder.setDbEncrypt(DbEncrypt)	migrate to DatabaseBuilder.dbEncrypt(DbEncrypt).
io.ebean.DatabaseBuilder.setDbOffline(boolean)	migrate to DatabaseBuilder.offline(boolean).
io.ebean.DatabaseBuilder.setDbSchema(String)	migrate to DatabaseBuilder.setDbSchema(String)
io.ebean.DatabaseBuilder.setDbUuid(PlatformConfig.DbUuid)	migrate to DatabaseBuilder.dbUuid(PlatformConfig.DbUuid).
io.ebean.DatabaseBuilder.setDdlCreateOnly(boolean)	migrate to DatabaseBuilder.ddlCreateOnly(boolean).
io.ebean.DatabaseBuilder.setDdlExtra(boolean)	migrate to DatabaseBuilder.ddlExtra(boolean).
io.ebean.DatabaseBuilder.setDdlGenerate(boolean)	migrate to DatabaseBuilder.ddlGenerate(boolean).
io.ebean.DatabaseBuilder.setDdlHeader(String)	migrate to DatabaseBuilder.ddlHeader(String).
io.ebean.DatabaseBuilder.setDdlInitSql(String)	migrate to DatabaseBuilder.ddlInitSql(String).
io.ebean.DatabaseBuilder.setDdlPlaceholderMap(Map<String, String>)	migrate to DatabaseBuilder.ddlPlaceholderMap(Map).
io.ebean.DatabaseBuilder.setDdlPlaceholders(String)	migrate to DatabaseBuilder.ddlPlaceholders(String).
io.ebean.DatabaseBuilder.setDdlRun(boolean)	migrate to DatabaseBuilder.ddlRun(boolean).
io.ebean.DatabaseBuilder.setDdlSeedSql(String)	migrate to DatabaseBuilder.ddlSeedSql(String).
io.ebean.DatabaseBuilder.setDdlStrictMode(boolean)	migrate to DatabaseBuilder.ddlStrictMode(boolean).
io.ebean.DatabaseBuilder.setDefaultEnumType(EnumType)	migrate to DatabaseBuilder.defaultEnumType(EnumType).
io.ebean.DatabaseBuilder.setDefaultServer(boolean)	migrate to DatabaseBuilder.defaultDatabase(boolean).
io.ebean.DatabaseBuilder.setDisableClasspathSearch(boolean)	migrate to DatabaseBuilder.disableClasspathSearch(boolean).
io.ebean.DatabaseBuilder.setDisableL2Cache(boolean)	migrate to DatabaseBuilder.disableL2Cache(boolean).
io.ebean.DatabaseBuilder.setDisableLazyLoading(boolean)	migrate to DatabaseBuilder.disableLazyLoading(boolean).
io.ebean.DatabaseBuilder.setDumpMetricsOnShutdown(boolean)	migrate to DatabaseBuilder.dumpMetricsOnShutdown(boolean).
io.ebean.DatabaseBuilder.setDumpMetricsOptions(String)	migrate to DatabaseBuilder.dumpMetricsOptions(String).
io.ebean.DatabaseBuilder.setDurationWithNanos(boolean)	migrate to DatabaseBuilder.durationWithNanos(boolean).
io.ebean.DatabaseBuilder.setEagerFetchLobs(boolean)	migrate to DatabaseBuilder.eagerFetchLobs(boolean).
io.ebean.DatabaseBuilder.setEnabledL2Regions(String)	migrate to DatabaseBuilder.enabledL2Regions(String).
io.ebean.DatabaseBuilder.setEncryptDeployManager(EncryptDeployManager)	migrate to DatabaseBuilder.encryptDeployManager(EncryptDeployManager).
io.ebean.DatabaseBuilder.setEncryptKeyManager(EncryptKeyManager)	migrate to DatabaseBuilder.encryptKeyManager(EncryptKeyManager).
io.ebean.DatabaseBuilder.setEncryptor(Encryptor)	migrate to DatabaseBuilder.encryptor(Encryptor).
io.ebean.DatabaseBuilder.setExpressionEqualsWithNullAsNoop(boolean)	migrate to DatabaseBuilder.expressionEqualsWithNullAsNoop(boolean).
io.ebean.DatabaseBuilder.setExpressionNativeIlike(boolean)	migrate to DatabaseBuilder.expressionNativeIlike(boolean).
io.ebean.DatabaseBuilder.setExternalTransactionManager(ExternalTransactionManager)	migrate to DatabaseBuilder.externalTransactionManager(ExternalTransactionManager).
io.ebean.DatabaseBuilder.setGeometrySRID(int)	migrate to DatabaseBuilder.geometrySRID(int).
io.ebean.DatabaseBuilder.setHistoryTableSuffix(String)	migrate to DatabaseBuilder.historyTableSuffix(String).
io.ebean.DatabaseBuilder.setIdGeneratorAutomatic(boolean)	migrate to DatabaseBuilder.idGeneratorAutomatic(boolean).
io.ebean.DatabaseBuilder.setIdType(IdType)	migrate to DatabaseBuilder.idType(IdType).
io.ebean.DatabaseBuilder.setJdbcFetchSizeFindEach(int)	migrate to DatabaseBuilder.jdbcFetchSizeFindEach(int).
io.ebean.DatabaseBuilder.setJdbcFetchSizeFindList(int)	migrate to DatabaseBuilder.jdbcFetchSizeFindList(int).
io.ebean.DatabaseBuilder.setJodaLocalTimeMode(String)	migrate to DatabaseBuilder.jodaLocalTimeMode(String).
io.ebean.DatabaseBuilder.setJsonDate(JsonConfig.Date)	migrate to DatabaseBuilder.jsonDateTime(JsonConfig.DateTime).
io.ebean.DatabaseBuilder.setJsonDateTime(JsonConfig.DateTime)	migrate to DatabaseBuilder.jsonDateTime(JsonConfig.DateTime).
io.ebean.DatabaseBuilder.setJsonFactory(JsonFactory)	migrate to DatabaseBuilder.jsonFactory(JsonFactory).
io.ebean.DatabaseBuilder.setJsonInclude(JsonConfig.Include)	migrate to DatabaseBuilder.jsonInclude(JsonConfig.Include).
io.ebean.DatabaseBuilder.setJsonMutationDetection(MutationDetection)	migrate to DatabaseBuilder.jsonMutationDetection(MutationDetection).
io.ebean.DatabaseBuilder.setLazyLoadBatchSize(int)	migrate to DatabaseBuilder.lazyLoadBatchSize(int).
io.ebean.DatabaseBuilder.setLoadModuleInfo(boolean)	migrate to DatabaseBuilder.loadModuleInfo(boolean).
io.ebean.DatabaseBuilder.setLocalOnlyL2Cache(boolean)	migrate to DatabaseBuilder.localOnlyL2Cache(boolean).
io.ebean.DatabaseBuilder.setLocalTimeWithNanos(boolean)	migrate to DatabaseBuilder.localTimeWithNanos(boolean).
io.ebean.DatabaseBuilder.setMappingLocations(List<String>)	migrate to DatabaseBuilder.mappingLocations(List).
io.ebean.DatabaseBuilder.setMaxCallStack(int)	migrate to DatabaseBuilder.maxCallStack(int).
io.ebean.DatabaseBuilder.setMetricNaming(Function<String, String>)	migrate to DatabaseBuilder.metricNaming(Function).
io.ebean.DatabaseBuilder.setName(String)	migrate to DatabaseBuilder.name(String).
io.ebean.DatabaseBuilder.setNamingConvention(NamingConvention)	migrate to DatabaseBuilder.namingConvention(NamingConvention).
io.ebean.DatabaseBuilder.setNotifyL2CacheInForeground(boolean)	migrate to DatabaseBuilder.notifyL2CacheInForeground(boolean).
io.ebean.DatabaseBuilder.setObjectMapper(Object)	migrate to DatabaseBuilder.objectMapper(Object).
io.ebean.DatabaseBuilder.setPersistBatch(PersistBatch)	migrate to DatabaseBuilder.persistBatch(PersistBatch).
io.ebean.DatabaseBuilder.setPersistBatching(boolean)	migrate to DatabaseBuilder.persistBatching(boolean).
io.ebean.DatabaseBuilder.setPersistBatchOnCascade(PersistBatch)	migrate to DatabaseBuilder.persistBatchOnCascade(PersistBatch).
io.ebean.DatabaseBuilder.setPersistBatchSize(int)	migrate to DatabaseBuilder.persistBatchSize(int).
io.ebean.DatabaseBuilder.setPersistenceContextScope(PersistenceContextScope)	migrate to DatabaseBuilder.persistenceContextScope(PersistenceContextScope).
io.ebean.DatabaseBuilder.setPlatformConfig(PlatformConfig)	migrate to DatabaseBuilder.platformConfig(PlatformConfig).
io.ebean.DatabaseBuilder.setProfilingConfig(ProfilingConfig)	migrate to DatabaseBuilder.profilingConfig(ProfilingConfig).
io.ebean.DatabaseBuilder.setQueryBatchSize(int)	migrate to DatabaseBuilder.queryBatchSize(int).
io.ebean.DatabaseBuilder.setQueryCacheMaxIdleTime(int)	migrate to DatabaseBuilder.queryCacheMaxIdleTime(int).
io.ebean.DatabaseBuilder.setQueryCacheMaxSize(int)	migrate to DatabaseBuilder.queryCacheMaxSize(int).
io.ebean.DatabaseBuilder.setQueryCacheMaxTimeToLive(int)	migrate to DatabaseBuilder.queryCacheMaxTimeToLive(int).
io.ebean.DatabaseBuilder.setQueryPlanCapture(boolean)	migrate to DatabaseBuilder.queryPlanCapture(boolean).
io.ebean.DatabaseBuilder.setQueryPlanCaptureMaxCount(int)	migrate to DatabaseBuilder.queryPlanCaptureMaxCount(int).
io.ebean.DatabaseBuilder.setQueryPlanCaptureMaxTimeMillis(long)	migrate to DatabaseBuilder.queryPlanCaptureMaxTimeMillis(long).
io.ebean.DatabaseBuilder.setQueryPlanCapturePeriodSecs(long)	migrate to DatabaseBuilder.queryPlanCapturePeriodSecs(long).
io.ebean.DatabaseBuilder.setQueryPlanEnable(boolean)	migrate to DatabaseBuilder.queryPlanEnable(boolean).
io.ebean.DatabaseBuilder.setQueryPlanListener(QueryPlanListener)	migrate to DatabaseBuilder.queryPlanListener(QueryPlanListener).
io.ebean.DatabaseBuilder.setQueryPlanThresholdMicros(long)	migrate to DatabaseBuilder.queryPlanThresholdMicros(long).
io.ebean.DatabaseBuilder.setQueryPlanTTLSeconds(int)	migrate to DatabaseBuilder.queryPlanTTLSeconds(int).
io.ebean.DatabaseBuilder.setReadOnlyDataSource(DataSource)	migrate to DatabaseBuilder.readOnlyDataSource(DataSource).
io.ebean.DatabaseBuilder.setReadOnlyDataSourceConfig(DataSourceBuilder)	migrate to DatabaseBuilder.readOnlyDataSourceBuilder(DataSourceBuilder).
io.ebean.DatabaseBuilder.setRegister(boolean)	migrate to DatabaseBuilder.register(boolean).
io.ebean.DatabaseBuilder.setResourceDirectory(String)	migrate to DatabaseBuilder.resourceDirectory(String).
io.ebean.DatabaseBuilder.setRunMigration(boolean)	migrate to DatabaseBuilder.runMigration(boolean).
io.ebean.DatabaseBuilder.setServerCachePlugin(ServerCachePlugin)	migrate to DatabaseBuilder.serverCachePlugin(ServerCachePlugin).
io.ebean.DatabaseBuilder.setSkipCacheAfterWrite(boolean)	migrate to DatabaseBuilder.skipCacheAfterWrite(boolean).
io.ebean.DatabaseBuilder.setSkipDataSourceCheck(boolean)	migrate to DatabaseBuilder.skipDataSourceCheck(boolean).
io.ebean.DatabaseBuilder.setSlowQueryListener(SlowQueryListener)	migrate to DatabaseBuilder.slowQueryListener(SlowQueryListener).
io.ebean.DatabaseBuilder.setSlowQueryMillis(long)	migrate to DatabaseBuilder.slowQueryMillis(long).
io.ebean.DatabaseBuilder.setTenantCatalogProvider(TenantCatalogProvider)	migrate to DatabaseBuilder.tenantCatalogProvider(TenantCatalogProvider).
io.ebean.DatabaseBuilder.setTenantDataSourceProvider(TenantDataSourceProvider)	migrate to DatabaseBuilder.tenantDataSourceProvider(TenantDataSourceProvider).
io.ebean.DatabaseBuilder.setTenantMode(TenantMode)	migrate to DatabaseBuilder.tenantMode(TenantMode).
io.ebean.DatabaseBuilder.setTenantPartitionColumn(String)	migrate to DatabaseBuilder.tenantPartitionColumn(String).
io.ebean.DatabaseBuilder.setTenantSchemaProvider(TenantSchemaProvider)	migrate to DatabaseBuilder.tenantSchemaProvider(TenantSchemaProvider).
io.ebean.DatabaseBuilder.Settings.getClasses()	- migrate to DatabaseBuilder.Settings.classes(). Sorry if returning Set rather than List breaks code but it feels safer to do that than a subtle change to return a shallow copy which you will not detect.
io.ebean.DatabaseBuilder.Settings.isAutoLoadModuleInfo()	- migrate to DatabaseBuilder.Settings.isLoadModuleInfo().
io.ebean.DatabaseBuilder.setTransactionRollbackOnChecked(boolean)	migrate to DatabaseBuilder.transactionRollbackOnChecked(boolean).
io.ebean.DatabaseBuilder.setUpdateAllPropertiesInBatch(boolean)	migrate to DatabaseBuilder.updateAllPropertiesInBatch(boolean).
io.ebean.DatabaseBuilder.setUseJtaTransactionManager(boolean)	migrate to DatabaseBuilder.useJtaTransactionManager(boolean).
io.ebean.DatabaseBuilder.setUseValidationNotNull(boolean)	migrate to DatabaseBuilder.useValidationNotNull(boolean).
io.ebean.DatabaseBuilder.setUuidNodeId(String)	migrate to DatabaseBuilder.uuidNodeId(String).
io.ebean.DatabaseBuilder.setUuidStateFile(String)	migrate to DatabaseBuilder.uuidStateFile(String).
io.ebean.DatabaseBuilder.setUuidVersion(DatabaseConfig.UuidVersion)	migrate to DatabaseBuilder.uuidVersion(DatabaseConfig.UuidVersion).
io.ebean.ExpressionList.delete(Transaction)	migrate to ExpressionList.usingTransaction(Transaction) then delete(). Execute as a delete query deleting the 'root level' beans that match the predicates in the query. Note that if the query includes joins then the generated delete statement may not be optimal depending on the database platform.
io.ebean.ExpressionList.order()	migrate to ExpressionList.orderBy().
io.ebean.ExpressionList.order(String)	migrate to ExpressionList.orderBy(String)
io.ebean.ExpressionList.update(Transaction)	migrate to ExpressionList.usingTransaction(Transaction) then update(). Execute as a update query with the given transaction.
io.ebean.ExtendedServer.setClock(Clock)
io.ebean.OrderBy.copyWithTrim(String)	This method will become internal only API. Return a copy of this OrderBy with the path trimmed.
io.ebean.Query.delete(Transaction)	migrate to QueryBuilder.usingTransaction(Transaction) then delete(). Execute as a delete query returning the number of rows deleted using the given transaction. Note that if the query includes joins then the generated delete statement may not be optimal depending on the database platform.
io.ebean.Query.order()	migrate to Query.orderBy().
io.ebean.Query.order(String)	migrate to Query.orderBy().
io.ebean.Query.setOrder(OrderBy<T>)	migrate to QueryBuilder.setOrderBy(OrderBy).
io.ebean.Query.update(Transaction)	migrate to QueryBuilder.usingTransaction(Transaction) then update(). Execute the UpdateQuery returning the number of rows updated using the given transaction.

Deprecated Constructors

Constructor	Description
io.ebean.OrderBy()	This method will be removed from public API. Create an empty OrderBy with no associated query.
io.ebean.OrderBy(Query<T>, String)	This method will be removed from public API.
io.ebean.OrderBy(String)	migrate to OrderBy.of(String).