io.zonky.test.db

Annotation Type AutoConfigureEmbeddedDatabase

@Documented
 @Inherited
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Repeatable(value=AutoConfigureEmbeddedDatabases.class)
public @interface AutoConfigureEmbeddedDatabase

Annotation that can be applied to a test class to configure an embedded database to use instead of any application defined DataSource.

This annotation may be used as a meta-annotation to create custom composed annotations.

See Also:

EmbeddedDatabaseContextCustomizerFactory

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	beanName The bean name to identify the data source to be associated with the embedded database.
AutoConfigureEmbeddedDatabase.DatabaseProvider	provider Provider to be used to create the underlying embedded database, see the documentation for the comparison matrix.
AutoConfigureEmbeddedDatabase.RefreshMode	refresh Determines the refresh mode of the embedded database.
AutoConfigureEmbeddedDatabase.Replace	replace Determines what type of existing DataSource beans can be replaced.
AutoConfigureEmbeddedDatabase.DatabaseType	type The type of embedded database to be created when replacing the data source.

Element Detail

beanName

public abstract java.lang.String beanName

The bean name to identify the data source to be associated with the embedded database.

It is required only if the application context contains multiple DataSource beans.

Returns:

the bean name to identify the DataSource bean

Default:

""

refresh

public abstract AutoConfigureEmbeddedDatabase.RefreshMode refresh

Determines the refresh mode of the embedded database.

This feature allows for reset the database to its initial state that existed before the test began. It is based on the use of template databases and does not rely on the rollback of the current transaction, so it is possible to save and commit data within the test without any consequences.

The refresh mode may also be configured via the zonky.test.database.refresh configuration property.

Returns:

the type of refresh mode to be used for database reset

Default:

io.zonky.test.db.AutoConfigureEmbeddedDatabase.RefreshMode.NEVER

type

public abstract AutoConfigureEmbeddedDatabase.DatabaseType type

The type of embedded database to be created when replacing the data source. By default will attempt to detect the database type based on the classpath.

The database type may also be configured via the zonky.test.database.type configuration property.

Returns:

the type of embedded database

Default:

io.zonky.test.db.AutoConfigureEmbeddedDatabase.DatabaseType.AUTO

provider

public abstract AutoConfigureEmbeddedDatabase.DatabaseProvider provider

Provider to be used to create the underlying embedded database, see the documentation for the comparison matrix.

The provider may also be configured via the zonky.test.database.provider configuration property.

Returns:

the provider to create the embedded database

Default:

io.zonky.test.db.AutoConfigureEmbeddedDatabase.DatabaseProvider.DEFAULT

replace

public abstract AutoConfigureEmbeddedDatabase.Replace replace

Determines what type of existing DataSource beans can be replaced.

It may also be configured via the zonky.test.database.replace configuration property.

Returns:

the type of existing DataSource to replace

Default:

io.zonky.test.db.AutoConfigureEmbeddedDatabase.Replace.ANY