Package io.quarkus.datasource.runtime

Interface DataSourceRuntimeConfig

public interface DataSourceRuntimeConfig

Method Summary

Modifier and Type	Method	Description
boolean	active()	Whether this datasource should be active at runtime.
@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) Optional<String>	credentialsProvider()	The credentials provider name
@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) Optional<String>	credentialsProviderName()	The credentials provider bean name.
Optional<String>	password()	The datasource password
Optional<String>	username()	The datasource username

Method Details

active

@WithDefault("true")
boolean active()

Whether this datasource should be active at runtime. See xref:datasource.adoc#datasource-active[this section of the documentation]. If the datasource is not active, it won't start with the application, and accessing the corresponding Datasource CDI bean will fail, meaning in particular that consumers of this datasource (e.g. Hibernate ORM persistence units) will fail to start unless they are inactive too.

username

Optional<String> username()

The datasource username

password

Optional<String> password()

The datasource password

credentialsProvider

@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) Optional<String> credentialsProvider()

The credentials provider name

credentialsProviderName

@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) Optional<String> credentialsProviderName()

The credentials provider bean name.

This is a bean name (as in @Named) of a bean that implements CredentialsProvider. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.

For Vault, the credentials provider bean name is vault-credentials-provider.