Class EmbeddedDatabaseFactory
- Direct Known Subclasses:
EmbeddedDatabaseFactoryBean
EmbeddedDatabase
instance.
Callers are guaranteed that the returned database has been fully initialized and populated.
The factory can be configured as follows:
- Call
generateUniqueDatabaseName
to set a unique, random name for the database. - Call
setDatabaseName(java.lang.String)
to set an explicit name for the database. - Call
setDatabaseType(org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType)
to set the database type if you wish to use one of the pre-supported types with its default settings. - Call
setDatabaseConfigurer(org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseConfigurer)
to configure support for a custom embedded database type, or customize the defaults for one of the pre-supported types. - Call
setDatabasePopulator(org.springframework.jdbc.datasource.init.DatabasePopulator)
to change the algorithm used to populate the database. - Call
setDataSourceFactory(org.springframework.jdbc.datasource.embedded.DataSourceFactory)
to change the type ofDataSource
used to connect to the database.
After configuring the factory, call getDatabase()
to obtain
a reference to the EmbeddedDatabase
instance.
- Since:
- 3.0
- Author:
- Keith Donald, Juergen Hoeller, Sam Brannen, Stephane Nicoll
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Default name for an embedded database: "testdb". -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionFactory method that returns the embedded database instance, which is also aDataSource
.protected final DataSource
Hook that gets theDataSource
that provides the connectivity to the embedded database.protected void
Hook to initialize the embedded database.void
setDatabaseConfigurer
(EmbeddedDatabaseConfigurer configurer) Set the strategy that will be used to configure the embedded database instance.void
setDatabaseName
(String databaseName) Set the name of the database.void
setDatabasePopulator
(DatabasePopulator populator) Set the strategy that will be used to initialize or populate the embedded database.void
Set the type of embedded database to use.void
setDataSourceFactory
(DataSourceFactory dataSourceFactory) Set the factory to use to create theDataSource
instance that connects to the embedded database.void
setGenerateUniqueDatabaseName
(boolean generateUniqueDatabaseName) Set thegenerateUniqueDatabaseName
flag to enable or disable generation of a pseudo-random unique ID to be used as the database name.protected void
Hook to shut down the embedded database.
-
Field Details
-
DEFAULT_DATABASE_NAME
Default name for an embedded database: "testdb".- See Also:
-
-
Constructor Details
-
EmbeddedDatabaseFactory
public EmbeddedDatabaseFactory()
-
-
Method Details
-
setGenerateUniqueDatabaseName
public void setGenerateUniqueDatabaseName(boolean generateUniqueDatabaseName) Set thegenerateUniqueDatabaseName
flag to enable or disable generation of a pseudo-random unique ID to be used as the database name.Setting this flag to
true
overrides any explicit name set viasetDatabaseName(java.lang.String)
.- Since:
- 4.2
- See Also:
-
setDatabaseName
Set the name of the database.Defaults to "testdb".
Will be overridden if the
generateUniqueDatabaseName
flag has been set totrue
.- Parameters:
databaseName
- name of the embedded database- See Also:
-
setDataSourceFactory
Set the factory to use to create theDataSource
instance that connects to the embedded database.Defaults to
SimpleDriverDataSourceFactory
. -
setDatabaseType
Set the type of embedded database to use.Call this when you wish to configure one of the pre-supported types with its default settings.
Defaults to HSQL.
- Parameters:
type
- the database type
-
setDatabaseConfigurer
Set the strategy that will be used to configure the embedded database instance.Call this with customizeConfigurer when you wish to customize the settings of one of the pre-supported types. Alternatively, use this when you wish to use an embedded database type not already supported.
- Since:
- 6.2
-
setDatabasePopulator
Set the strategy that will be used to initialize or populate the embedded database.Defaults to
null
. -
getDatabase
Factory method that returns the embedded database instance, which is also aDataSource
. -
initDatabase
protected void initDatabase()Hook to initialize the embedded database.If the
generateUniqueDatabaseName
flag has been set totrue
, the current value of the database name will be overridden with an auto-generated name.Subclasses may call this method to force initialization; however, this method should only be invoked once.
After calling this method,
getDataSource()
returns theDataSource
providing connectivity to the database. -
shutdownDatabase
protected void shutdownDatabase()Hook to shut down the embedded database. Subclasses may call this method to force shutdown.After calling,
getDataSource()
returnsnull
.Does nothing if no embedded database has been initialized.
-
getDataSource
Hook that gets theDataSource
that provides the connectivity to the embedded database.Returns
null
if theDataSource
has not been initialized or if the database has been shut down. Subclasses may call this method to access theDataSource
instance directly.
-