Package io.quarkus.datasource.runtime

Interface DataSourceRuntimeConfig

public interface DataSourceRuntimeConfig

Method Summary

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

Method Details

active

@ConfigDocDefault("`true` if the URL is set, `false` otherwise")
Optional<Boolean> active()

Whether this datasource should be active at runtime. See xref:datasource.adoc#datasource-active[this section of the documentation].

username

Optional<String> username()

The datasource username

password

Optional<String> password()

The datasource password

credentialsProvider

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

The credentials provider name

credentialsProviderName

Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) 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.