Package io.quarkus.datasource.runtime

Interface DevServicesBuildTimeConfig

  • public interface DevServicesBuildTimeConfig

    • Method Detail

      • enabled

        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

        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

        Map<String,​String> containerEnv()
        Environment variables that are passed to the container.

      • containerProperties

        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

        Map<String,​String> properties()
        Generic properties that are added to the database connection URL.

      • port

        OptionalInt port()
        Optional fixed port the dev service will listen to.

        If not defined, the port will be chosen randomly.

      • command

        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

        Optional<String> dbName()
        The database name to use if this Dev Service supports overriding it.

      • username

        Optional<String> username()
        The username to use if this Dev Service supports overriding it.

      • password

        Optional<String> password()
        The password to use if this Dev Service supports overriding it.

      • initScriptPath

        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

        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.