Package io.quarkus.mongodb.deployment

Interface DevServicesBuildTimeConfig

public interface DevServicesBuildTimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    containerEnv()
    Environment variables that are passed to the container.
    Optional<Boolean>
    enabled()
    If DevServices has been explicitly enabled or disabled.
    Optional<String>
    imageName()
    The container image name to use, for container based DevServices providers.
    Optional<Integer>
    port()
    Optional fixed port the dev service will listen to.
    Map<String,String>
    properties()
    Generic properties that are added to the connection URL.
    String
    serviceName()
    The value of the quarkus-dev-service-mongodb label attached to the started container.
    boolean
    shared()
    Indicates if the MongoDB server managed by Quarkus Dev Services is shared.

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

      When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.

    • imageName

      @ConfigDocDefault(value="`{mongo-image}`", escape=false) Optional<String> imageName()
      The container image name to use, for container based DevServices providers.

    • port

      Optional<Integer> port()
      Optional fixed port the dev service will listen to.

      If not defined, the port will be chosen randomly.

    • properties

      @ConfigDocMapKey("property-key") Map<String,String> properties()
      Generic properties that are added to the connection URL.

    • containerEnv

      @ConfigDocMapKey("environment-variable-name") Map<String,String> containerEnv()
      Environment variables that are passed to the container.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container.

      The discovery uses the quarkus-dev-service-mongodb label. The value is configured using the service-name property.

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("mongodb") String serviceName()
      The value of the quarkus-dev-service-mongodb label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for MongoDB looks for a container with the quarkus-dev-service-mongodb label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the quarkus-dev-service-mongodb label set to the specified value.