Package io.quarkus.datasource.runtime

Class DevServicesBuildTimeConfig

java.lang.Object

io.quarkus.datasource.runtime.DevServicesBuildTimeConfig

public class DevServicesBuildTimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	command	The container start command to use for container-based DevServices providers.
Map<String,String>	containerEnv	Environment variables that are passed to the container.
Map<String,String>	containerProperties	Generic properties that are passed for additional container configuration.
Optional<String>	dbName	The database name to use if this Dev Service supports overriding it.
Optional<Boolean>	enabled	If DevServices has been explicitly enabled or disabled.
Optional<String>	imageName	The container image name for container-based DevServices providers.
Optional<String>	initScriptPath	The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
Optional<String>	password	The password to use if this Dev Service supports overriding it.
OptionalInt	port	Optional fixed port the dev service will listen to.
Map<String,String>	properties	Generic properties that are added to the database connection URL.
Optional<String>	username	The username to use if this Dev Service supports overriding it.
Map<String,String>	volumes	The volumes to be mapped to the container.

Constructor Summary

Constructors

Constructor	Description
DevServicesBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enabled

@ConfigItem
public Optional<Boolean> enabled

If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default unless an existing configuration is present. When DevServices is enabled, Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.

imageName

@ConfigItem
public Optional<String> imageName

The container image name for container-based DevServices providers. This has no effect if the provider is not a container-based database, such as H2 or Derby.

containerEnv

@ConfigItem
public Map<String,String> containerEnv

Environment variables that are passed to the container.

containerProperties

@ConfigItem
public Map<String,String> containerProperties

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.

properties

@ConfigItem
public Map<String,String> properties

Generic properties that are added to the database connection URL.

port

@ConfigItem
public OptionalInt port

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

command

@ConfigItem
public Optional<String> command

The container start command to use for container-based DevServices providers. This has no effect if the provider is not a container-based database, such as H2 or Derby.

dbName

@ConfigItem
public Optional<String> dbName

The database name to use if this Dev Service supports overriding it.

username

@ConfigItem
public Optional<String> username

The username to use if this Dev Service supports overriding it.

password

@ConfigItem
public Optional<String> password

The password to use if this Dev Service supports overriding it.

initScriptPath

@ConfigItem
public Optional<String> initScriptPath

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.

volumes

@ConfigItem
public Map<String,String> volumes

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.

Constructor Detail

DevServicesBuildTimeConfig

public DevServicesBuildTimeConfig()