Uses of Interface
io.ebean.datasource.DataSourceBuilder

Uses of DataSourceBuilder in io.ebean.datasource

Subinterfaces of DataSourceBuilder in io.ebean.datasource

Modifier and Type	Interface	Description
static interface	DataSourceBuilder.Settings	The settings of the DataSourceBuilder.

Classes in io.ebean.datasource that implement DataSourceBuilder

Modifier and Type	Class	Description
class	DataSourceConfig	Configuration information for a DataSource.

Methods in io.ebean.datasource that return DataSourceBuilder

Modifier and Type	Method	Description
DataSourceBuilder	DataSourceBuilder.addProperty(String key, boolean value)	Add a driver property.
DataSourceBuilder	DataSourceBuilder.addProperty(String key, int value)	Add a driver property.
DataSourceBuilder	DataSourceBuilder.addProperty(String key, String value)	Add a driver property.
default DataSourceBuilder	DataSourceBuilder.alert(DataSourceAlert alert)	Set the alert implementation to use.
default DataSourceBuilder	DataSourceBuilder.alsoIf(BooleanSupplier predicate, Consumer<DataSourceBuilder.Settings> apply)	Conditionally apply configuration to the builder via a lambda.
default DataSourceBuilder	DataSourceBuilder.applicationName(String applicationName)	Set the ClientInfo ApplicationName property.
DataSourceBuilder	DataSourceBuilder.apply(Consumer<DataSourceBuilder.Settings> apply)	Apply configuration to the builder via a lambda.
DataSourceBuilder	DataSourceConfig.apply(Consumer<DataSourceBuilder.Settings> apply)
default DataSourceBuilder	DataSourceBuilder.autoCommit(boolean autoCommit)	Set to true to turn on autoCommit.
static DataSourceBuilder	DataSourcePool.builder()	Return a builder for the DataSourcePool.
default DataSourceBuilder	DataSourceBuilder.captureStackTrace(boolean captureStackTrace)	Set to true if a stack trace should be captured when obtaining a connection from the pool.
DataSourceBuilder	DataSourceBuilder.catalog(String catalog)	Set the default database catalog to use.
default DataSourceBuilder	DataSourceBuilder.clientInfo(Properties clientInfo)	Set the ClientInfo as properties.
DataSourceBuilder	DataSourceBuilder.copy()	Return a copy of the DataSourceBuilder.
static DataSourceBuilder	DataSourceBuilder.create()	Return a new builder of DataSourcePool.
default DataSourceBuilder	DataSourceBuilder.cstmtCacheSize(int cstmtCacheSize)	Set the size of the CallableStatement cache (per connection).
default DataSourceBuilder	DataSourceBuilder.customProperties(Map<String,String> customProperties)	Set custom properties for the jdbc driver connection.
DataSourceBuilder	DataSourceBuilder.dataSource(DataSource dataSource)	Set a DataSource that will be used to provide new connections.
DataSourceBuilder	DataSourceBuilder.driver(Class<? extends Driver> driver)	Set the driver class to use.
default DataSourceBuilder	DataSourceBuilder.driver(String driverClassName)	Set the database driver className.
DataSourceBuilder	DataSourceBuilder.driver(Driver driver)	Set the driver to use.
DataSourceBuilder	DataSourceConfig.driver(Class<? extends Driver> driverClass)
DataSourceBuilder	DataSourceConfig.driver(Driver driver)
DataSourceBuilder	DataSourceBuilder.enforceCleanClose(boolean enforceCleanClose)	When enabled, the datasource enforces a clean close.
DataSourceBuilder	DataSourceConfig.enforceCleanClose(boolean enforceCleanClose)
default DataSourceBuilder	DataSourceBuilder.failOnStart(boolean failOnStart)	Set to false, if DataSource should not fail on start.
static DataSourceBuilder	DataSourceBuilder.from(Properties properties)	Return a new builder loading from the given properties.
static DataSourceBuilder	DataSourceBuilder.from(Properties properties, String prefix)	Return a new builder loading from the given properties using a given prefix.
default DataSourceBuilder	DataSourceBuilder.heartbeatFreqSecs(int heartbeatFreqSecs)	Set the expected heartbeat frequency in seconds.
DataSourceBuilder	DataSourceBuilder.heartbeatMaxPoolExhaustedCount(int count)	Sets the coun how often the heartbeat has to detect pool exhaustion in succession.
DataSourceBuilder	DataSourceConfig.heartbeatMaxPoolExhaustedCount(int count)
default DataSourceBuilder	DataSourceBuilder.heartbeatSql(String heartbeatSql)	Set a SQL statement used to test the database is accessible.
default DataSourceBuilder	DataSourceBuilder.heartbeatTimeoutSeconds(int heartbeatTimeoutSeconds)	Set the heart beat timeout in seconds.
default DataSourceBuilder	DataSourceBuilder.initDatabase(InitDatabase initDatabase)	Set the InitDatabase to use with ownerUsername.
default DataSourceBuilder	DataSourceBuilder.initDatabaseForPlatform(String platform)	Set InitDatabase based on the database platform.
DataSourceBuilder	DataSourceBuilder.initialConnections(int initialConnections)	Set the number of initial connections to create when starting.
default DataSourceBuilder	DataSourceBuilder.initSql(List<String> initSql)	Set custom init queries for each query.
default DataSourceBuilder	DataSourceBuilder.isolationLevel(int isolationLevel)	Set the transaction isolation level.
default DataSourceBuilder	DataSourceBuilder.leakTimeMinutes(int leakTimeMinutes)	Set the time in minutes after which a connection could be considered to have leaked.
default DataSourceBuilder	DataSourceBuilder.listener(DataSourcePoolListener listener)	Set the listener to use.
DataSourceBuilder	DataSourceBuilder.load(Properties properties)	Load the settings from the properties with no prefix on the property names.
DataSourceBuilder	DataSourceBuilder.load(Properties properties, String prefix)	Load the settings from the properties with the given prefix on the property names.
DataSourceBuilder	DataSourceBuilder.loadSettings(Properties properties, String poolName)	Load the settings from the properties with "datasource" prefix on the property names.
default DataSourceBuilder	DataSourceBuilder.maxAgeMinutes(int maxAgeMinutes)	Set the maximum age a connection can be in minutes.
default DataSourceBuilder	DataSourceBuilder.maxConnections(int maxConnections)	Set the maximum number of connections the pool can reach.
default DataSourceBuilder	DataSourceBuilder.maxInactiveTimeSecs(int maxInactiveTimeSecs)	Set the time in seconds a connection can be idle after which it can be trimmed from the pool.
default DataSourceBuilder	DataSourceBuilder.maxStackTraceSize(int maxStackTraceSize)	Set the max size for reporting stack traces on busy connections.
default DataSourceBuilder	DataSourceBuilder.minConnections(int minConnections)	Set the minimum number of connections the pool should maintain.
default DataSourceBuilder	DataSourceBuilder.name(String name)	Set the data source pool name.
default DataSourceBuilder	DataSourceBuilder.offline(boolean offline)	Set to true if the DataSource should be started offline (without any connections).
default DataSourceBuilder	DataSourceBuilder.ownerPassword(String ownerPassword)	Set the database owner password (used to create connection for use with InitDatabase).
default DataSourceBuilder	DataSourceBuilder.ownerUsername(String ownerUsername)	Set the database owner username (used to create connection for use with InitDatabase).
default DataSourceBuilder	DataSourceBuilder.password(String password)	Set the database password.
default DataSourceBuilder	DataSourceBuilder.password2(String password2)	Set the database alternate password2.
default DataSourceBuilder	DataSourceBuilder.platform(String platform)	Set the database platform (for use with ownerUsername and InitDatabase.
default DataSourceBuilder	DataSourceBuilder.poolListener(String poolListener)	Set a pool listener.
default DataSourceBuilder	DataSourceBuilder.pstmtCacheSize(int pstmtCacheSize)	Set the size of the PreparedStatement cache (per connection).
default DataSourceBuilder	DataSourceBuilder.readOnly(boolean readOnly)	Set to true to for read only.
default DataSourceBuilder	DataSourceBuilder.readOnlyUrl(String readOnlyUrl)	Set the connection URL to use for a matching read-only connection pool.
default DataSourceBuilder	DataSourceBuilder.schema(String schema)	Set the default database schema to use.
DataSourceBuilder	DataSourceBuilder.setAlert(DataSourceAlert alert)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to alert(DataSourceAlert).
DataSourceBuilder	DataSourceBuilder.setApplicationName(String applicationName)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to applicationName(String)
DataSourceBuilder	DataSourceBuilder.setAutoCommit(boolean autoCommit)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to autoCommit(boolean).
DataSourceBuilder	DataSourceBuilder.setCaptureStackTrace(boolean captureStackTrace)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to captureStackTrace(boolean).
DataSourceBuilder	DataSourceBuilder.setClientInfo(Properties clientInfo)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to clientInfo(Properties).
DataSourceBuilder	DataSourceBuilder.setCstmtCacheSize(int cstmtCacheSize)	Deprecated. - migrate to cstmtCacheSize(int).
DataSourceBuilder	DataSourceBuilder.setCustomProperties(Map<String,String> customProperties)	Deprecated. - migrate to customProperties(Map).
DataSourceBuilder	DataSourceBuilder.setDefaults(DataSourceBuilder other)	Default the values for driver, url, username, password and minConnections from another builder if these properties not already been set.
DataSourceBuilder	DataSourceBuilder.setDriver(String driverClassName)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to driver(String).
DataSourceBuilder	DataSourceBuilder.setFailOnStart(boolean failOnStart)	Deprecated. - migrate to failOnStart(boolean).
DataSourceBuilder	DataSourceBuilder.setHeartbeatFreqSecs(int heartbeatFreqSecs)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to heartbeatFreqSecs(int).
DataSourceBuilder	DataSourceBuilder.setHeartbeatSql(String heartbeatSql)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to heartbeatSql(String).
DataSourceBuilder	DataSourceBuilder.setHeartbeatTimeoutSeconds(int heartbeatTimeoutSeconds)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to heartbeatTimeoutSeconds(int).
DataSourceBuilder	DataSourceBuilder.setInitDatabase(InitDatabase initDatabase)	Deprecated. - migrate to initDatabase(InitDatabase).
DataSourceBuilder	DataSourceBuilder.setInitDatabaseForPlatform(String platform)	Deprecated. - migrate to initDatabaseForPlatform(String).
DataSourceBuilder	DataSourceBuilder.setInitSql(List<String> initSql)	Deprecated. - migrate to initSql(List).
DataSourceBuilder	DataSourceBuilder.setIsolationLevel(int isolationLevel)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to isolationLevel(int).
DataSourceBuilder	DataSourceBuilder.setLeakTimeMinutes(int leakTimeMinutes)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to leakTimeMinutes(int).
DataSourceBuilder	DataSourceBuilder.setListener(DataSourcePoolListener listener)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to listener(DataSourcePoolListener).
DataSourceBuilder	DataSourceBuilder.setMaxAgeMinutes(int maxAgeMinutes)	Deprecated. - migrate to maxAgeMinutes(int).
DataSourceBuilder	DataSourceBuilder.setMaxConnections(int maxConnections)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to maxConnections(int).
DataSourceBuilder	DataSourceBuilder.setMaxInactiveTimeSecs(int maxInactiveTimeSecs)	Deprecated. - migrate to maxInactiveTimeSecs(int).
DataSourceBuilder	DataSourceBuilder.setMaxStackTraceSize(int maxStackTraceSize)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to maxStackTraceSize(int).
DataSourceBuilder	DataSourceBuilder.setMinConnections(int minConnections)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to minConnections(int).
DataSourceBuilder	DataSourceBuilder.setName(String name)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to name(String)
DataSourceBuilder	DataSourceBuilder.setOffline(boolean offline)	Deprecated. - migrate to offline(boolean).
DataSourceBuilder	DataSourceBuilder.setOwnerPassword(String ownerPassword)	Deprecated. - migrate to ownerPassword(String).
DataSourceBuilder	DataSourceBuilder.setOwnerUsername(String ownerUsername)	Deprecated. - migrate to ownerUsername(String).
DataSourceBuilder	DataSourceBuilder.setPassword(String password)	Deprecated. - migrate to password(String).
DataSourceBuilder	DataSourceBuilder.setPassword2(String password2)	Deprecated. - migrate to password2(String).
DataSourceBuilder	DataSourceBuilder.setPlatform(String platform)	Deprecated. - migrate to platform(String).
DataSourceBuilder	DataSourceBuilder.setPoolListener(String poolListener)	Deprecated. - migrate to poolListener(String).
DataSourceBuilder	DataSourceBuilder.setPstmtCacheSize(int pstmtCacheSize)	Deprecated. - migrate to pstmtCacheSize(int).
DataSourceBuilder	DataSourceBuilder.setReadOnly(boolean readOnly)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to readOnly(boolean).
DataSourceBuilder	DataSourceBuilder.setReadOnlyUrl(String readOnlyUrl)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to readOnlyUrl(String).
DataSourceBuilder	DataSourceBuilder.setSchema(String schema)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to schema(String).
DataSourceBuilder	DataSourceBuilder.setTrimPoolFreqSecs(int trimPoolFreqSecs)	Deprecated. - migrate to trimPoolFreqSecs(int).
DataSourceBuilder	DataSourceBuilder.setUrl(String url)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to url(String).
DataSourceBuilder	DataSourceBuilder.setUsername(String username)	Deprecated, for removal: This API element is subject to removal in a future version. - migrate to username(String).
DataSourceBuilder	DataSourceBuilder.setWaitTimeoutMillis(int waitTimeoutMillis)	Deprecated. - migrate to waitTimeoutMillis(int).
DataSourceBuilder	DataSourceBuilder.shutdownOnJvmExit(boolean shutdownOnJvmExit)	When set true a JVM shutdown hook is registered that will shutdown the connection pool on JVM exit if it has not already been shutdown.
default DataSourceBuilder	DataSourceBuilder.trimPoolFreqSecs(int trimPoolFreqSecs)	Set the minimum trim gap between pool trim checks.
default DataSourceBuilder	DataSourceBuilder.url(String url)	Set the connection URL.
default DataSourceBuilder	DataSourceBuilder.username(String username)	Set the database username.
DataSourceBuilder	DataSourceBuilder.validateOnHeartbeat(boolean validateOnHeartbeat)	Set whether the connection pool should be validated periodically.
default DataSourceBuilder	DataSourceBuilder.waitTimeoutMillis(int waitTimeoutMillis)	Set the time in millis to wait for a connection before timing out once the pool has reached its maximum size.

Methods in io.ebean.datasource with parameters of type DataSourceBuilder

Modifier and Type	Method	Description
DataSourceBuilder	DataSourceBuilder.setDefaults(DataSourceBuilder other)	Default the values for driver, url, username, password and minConnections from another builder if these properties not already been set.
DataSourceConfig	DataSourceConfig.setDefaults(DataSourceBuilder builder)