io.quarkus.datasource.runtime.DevServicesBuildTimeConfig Maven / Gradle / Ivy
package io.quarkus.datasource.runtime;
import java.util.Map;
import java.util.Optional;
import java.util.OptionalInt;
import io.quarkus.runtime.annotations.ConfigDocMapKey;
import io.quarkus.runtime.annotations.ConfigGroup;
import io.quarkus.runtime.configuration.TrimmedStringConverter;
import io.smallrye.config.WithConverter;
import io.smallrye.config.WithDefault;
@ConfigGroup
public interface DevServicesBuildTimeConfig {
/**
* Whether this Dev Service should start with the application in dev mode or tests.
*
* Dev Services are enabled by default
* unless connection configuration (e.g. the JDBC URL or reactive client URL) is set explicitly.
*
* @asciidoclet
*/
Optional enabled();
/**
* The container image name for container-based Dev Service providers.
*
* This has no effect if the provider is not a container-based database, such as H2 or Derby.
*/
@WithConverter(TrimmedStringConverter.class)
Optional imageName();
/**
* Environment variables that are passed to the container.
*/
@ConfigDocMapKey("environment-variable-name")
Map containerEnv();
/**
* Generic properties that are passed for additional container configuration.
*
* Properties defined here are database-specific
* and are interpreted specifically in each database dev service implementation.
*/
@ConfigDocMapKey("property-key")
Map containerProperties();
/**
* Generic properties that are added to the database connection URL.
*/
@ConfigDocMapKey("property-key")
Map properties();
/**
* Optional fixed port the dev service will listen to.
*
* If not defined, the port will be chosen randomly.
*/
OptionalInt port();
/**
* The container start command to use for container-based Dev Service providers.
*
* This has no effect if the provider is not a container-based database, such as H2 or Derby.
*/
@WithConverter(TrimmedStringConverter.class)
Optional command();
/**
* The database name to use if this Dev Service supports overriding it.
*/
Optional dbName();
/**
* The username to use if this Dev Service supports overriding it.
*/
Optional username();
/**
* The password to use if this Dev Service supports overriding it.
*/
Optional password();
/**
* The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
*
* This has no effect if the provider is not a container-based database, such as H2 or Derby.
*/
Optional initScriptPath();
/**
* The volumes to be mapped to the container.
*
* The map key corresponds to the host location; the map value is the container location.
* If the host location starts with "classpath:",
* the mapping loads the resource from the classpath with read-only permission.
*
* When using a file system location, the volume will be generated with read-write permission,
* potentially leading to data loss or modification in your file system.
*
* This has no effect if the provider is not a container-based database, such as H2 or Derby.
*/
@ConfigDocMapKey("host-path")
Map volumes();
/**
* Whether to keep Dev Service containers running *after a dev mode session or test suite execution*
* to reuse them in the next dev mode session or test suite execution.
*
* Within a dev mode session or test suite execution,
* Quarkus will always reuse Dev Services as long as their configuration
* (username, password, environment, port bindings, ...) did not change.
* This feature is specifically about keeping containers running
* **when Quarkus is not running** to reuse them across runs.
*
* WARNING: This feature needs to be enabled explicitly in `testcontainers.properties`,
* may require changes to how you configure data initialization in dev mode and tests,
* and may leave containers running indefinitely, forcing you to stop and remove them manually.
* See xref:databases-dev-services.adoc#reuse[this section of the documentation] for more information.
*
* This configuration property is set to `true` by default,
* so it is mostly useful to *disable* reuse,
* if you enabled it in `testcontainers.properties`
* but only want to use it for some of your Quarkus applications or datasources.
*
* @asciidoclet
*/
@WithDefault("true")
boolean reuse();
}