Configuration Reference

Version:5.5.2-SNAPSHOT

Micronaut Hibernate Jpa Config Properties

🔗
Table 1. Configuration Properties for JpaConfiguration
Property Type Description

jpa.*.packages-to-scan

java.lang.String

jpa.*.properties

java.util.Map

jpa.*.mapping-resources

java.util.List

Mapping resources (equivalent to "mapping-file" entries in persistence.xml).

jpa.*.compile-time-hibernate-proxies

boolean

Compile time Hibernate proxies.

jpa.*.reactive

boolean

🔗
Table 2. Configuration Properties for JpaConfiguration$EntityScanConfiguration
Property Type Description

jpa.*.entity-scan.enabled

boolean

Set whether entity scan is enabled. Defaults to true.

jpa.*.entity-scan.packages

java.lang.String

The packages to limit the scan to.

Micronaut Jasync Sql Config Properties

🔗
Table 3. Configuration Properties for JasyncPoolConfiguration
Property Type Description

jasync.client.host

java.lang.String

jasync.client.port

int

jasync.client.database

java.lang.String

jasync.client.username

java.lang.String

jasync.client.password

java.lang.String

jasync.client.max-active-connections

int

jasync.client.max-idle-time

long

jasync.client.max-pending-queries

int

jasync.client.connection-validation-interval

long

jasync.client.connection-create-timeout

long

jasync.client.connection-test-timeout

long

jasync.client.query-timeout

java.lang.Long

jasync.client.execution-context

java.util.concurrent.Executor

jasync.client.charset

java.nio.charset.Charset

jasync.client.maximum-message-size

int

jasync.client.allocator

io.netty.buffer.ByteBufAllocator

jasync.client.application-name

java.lang.String

jasync.client.interceptors

java.util.List

jasync.client.max-connection-ttl

java.lang.Long

jasync.client.current-schema

java.lang.String

jasync.client.socket-path

java.lang.String

jasync.client.credentials-provider

com.github.jasync.sql.db.CredentialsProvider

jasync.client.min-idle-connections

java.lang.Integer

🔗
Table 4. Configuration Properties for JasyncPoolConfiguration$JasyncSslConfiguration
Property Type Description

jasync.client.ssl

com.github.jasync.sql.db.SSLConfiguration

jasync.client.ssl.mode

com.github.jasync.sql.db.SSLConfiguration$Mode

The mode

jasync.client.ssl.root-cert

java.lang.String

The cert

jasync.client.ssl.client-cert

java.lang.String

The client cert

jasync.client.ssl.client-private-key

java.lang.String

The client private key

Micronaut Jdbc Dbcp Config Properties

🔗
Table 5. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.abandoned-log-writer

java.io.PrintWriter

datasources.*.abandoned-usage-tracking

boolean

datasources.*.auto-commit-on-return

boolean

datasources.*.cache-state

boolean

datasources.*.connection-factory-class-name

java.lang.String

datasources.*.connection-init-sqls

java.util.Collection

datasources.*.connection-properties

java.lang.String

datasources.*.default-auto-commit

java.lang.Boolean

datasources.*.default-catalog

java.lang.String

datasources.*.default-query-timeout

java.time.Duration

datasources.*.default-read-only

java.lang.Boolean

datasources.*.default-schema

java.lang.String

datasources.*.default-transaction-isolation

int

datasources.*.disconnection-sql-codes

java.util.Collection

datasources.*.driver

java.sql.Driver

datasources.*.driver-class-loader

java.lang.ClassLoader

datasources.*.duration-between-eviction-runs

java.time.Duration

datasources.*.enable-auto-commit-on-return

boolean

datasources.*.eviction-policy-class-name

java.lang.String

datasources.*.fast-fail-validation

boolean

datasources.*.initial-size

int

datasources.*.jmx-name

java.lang.String

datasources.*.lifo

boolean

datasources.*.log-abandoned

boolean

datasources.*.log-expired-connections

boolean

datasources.*.login-timeout

int

datasources.*.log-writer

java.io.PrintWriter

datasources.*.max-conn-lifetime-millis

long

datasources.*.max-idle

int

datasources.*.max-open-prepared-statements

int

datasources.*.max-total

int

datasources.*.max-wait-millis

long

datasources.*.min-evictable-idle-time-millis

long

datasources.*.min-idle

int

datasources.*.num-tests-per-eviction-run

int

datasources.*.remove-abandoned-on-borrow

boolean

datasources.*.remove-abandoned-on-maintenance

boolean

datasources.*.remove-abandoned-timeout

java.time.Duration

datasources.*.rollback-on-return

boolean

datasources.*.soft-min-evictable-idle-time-millis

long

datasources.*.test-on-borrow

boolean

datasources.*.test-on-create

boolean

datasources.*.test-on-return

boolean

datasources.*.test-while-idle

boolean

datasources.*.time-between-eviction-runs-millis

long

datasources.*.validation-query-timeout

java.time.Duration

datasources.*.access-to-underlying-connection-allowed

boolean

datasources.*.clear-statement-pool-on-return

boolean

datasources.*.pool-prepared-statements

boolean

datasources.*.driver-class-name

java.lang.String

datasources.*.max-conn

java.time.Duration

datasources.*.max-wait

java.time.Duration

datasources.*.min-evictable-idle

java.time.Duration

datasources.*.password

java.lang.String

datasources.*.register-connection-mbean

boolean

datasources.*.soft-min-evictable-idle

java.time.Duration

datasources.*.url

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-query

java.lang.String

datasources.*.connection-properties-string

java.lang.String

A helper method to allow setting the connectionProperties via a single String.

datasources.*.data-source-properties

java.util.Map

Micronaut Jdbc Hikari Config Properties

🔗
Table 6. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.catalog

java.lang.String

datasources.*.connection-timeout

long

datasources.*.idle-timeout

long

datasources.*.leak-detection-threshold

long

datasources.*.max-lifetime

long

datasources.*.maximum-pool-size

int

datasources.*.minimum-idle

int

datasources.*.password

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-timeout

long

datasources.*.connection-test-query

java.lang.String

datasources.*.connection-init-sql

java.lang.String

datasources.*.data-source

javax.sql.DataSource

datasources.*.data-source-class-name

java.lang.String

datasources.*.data-source-jndi

java.lang.String

datasources.*.data-source-properties

java.util.Map

Sets the data source properties.

datasources.*.driver-class-name

java.lang.String

datasources.*.jdbc-url

java.lang.String

datasources.*.auto-commit

boolean

datasources.*.allow-pool-suspension

boolean

datasources.*.initialization-fail-timeout

long

datasources.*.isolate-internal-queries

boolean

datasources.*.metrics-tracker-factory

com.zaxxer.hikari.metrics.MetricsTrackerFactory

datasources.*.metric-registry

java.lang.Object

datasources.*.health-check-registry

java.lang.Object

datasources.*.health-check-properties

java.util.Properties

datasources.*.keepalive-time

long

datasources.*.read-only

boolean

datasources.*.register-mbeans

boolean

datasources.*.pool-name

java.lang.String

datasources.*.scheduled-executor

java.util.concurrent.ScheduledExecutorService

datasources.*.transaction-isolation

java.lang.String

datasources.*.schema

java.lang.String

datasources.*.exception-override-class-name

java.lang.String

datasources.*.thread-factory

java.util.concurrent.ThreadFactory

datasources.*.url

java.lang.String

Setter.

datasources.*.validation-query

java.lang.String

Setter.

datasources.*.jndi-name

java.lang.String

Get Jndi name.

datasources.*.automatic-validation-query

boolean

Micronaut Jdbc Tomcat Config Properties

🔗
Table 7. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.abandon-when-percentage-full

int

datasources.*.fair-queue

boolean

datasources.*.access-to-underlying-connection-allowed

boolean

datasources.*.connection-properties

java.lang.String

datasources.*.db-properties

java.util.Properties

datasources.*.default-auto-commit

java.lang.Boolean

datasources.*.default-catalog

java.lang.String

datasources.*.default-read-only

java.lang.Boolean

datasources.*.default-transaction-isolation

int

datasources.*.initial-size

int

datasources.*.log-abandoned

boolean

datasources.*.max-active

int

datasources.*.max-idle

int

datasources.*.max-wait

int

datasources.*.min-evictable-idle-time-millis

int

datasources.*.min-idle

int

datasources.*.name

java.lang.String

datasources.*.num-tests-per-eviction-run

int

datasources.*.remove-abandoned

boolean

datasources.*.remove-abandoned-timeout

int

datasources.*.test-on-borrow

boolean

datasources.*.test-on-return

boolean

datasources.*.test-while-idle

boolean

datasources.*.time-between-eviction-runs-millis

int

datasources.*.validation-query-timeout

int

datasources.*.validator-class-name

java.lang.String

datasources.*.validator

org.apache.tomcat.jdbc.pool.Validator

datasources.*.validation-interval

long

datasources.*.init-sql

java.lang.String

datasources.*.test-on-connect

boolean

datasources.*.jdbc-interceptors

java.lang.String

datasources.*.driver-class-name

java.lang.String

datasources.*.password

java.lang.String

datasources.*.url

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-query

java.lang.String

datasources.*.jmx-enabled

boolean

datasources.*.suspect-timeout

int

datasources.*.use-equals

boolean

datasources.*.max-age

long

datasources.*.use-lock

boolean

datasources.*.data-source

java.lang.Object

datasources.*.data-source-jndi

java.lang.String

datasources.*.alternate-username-allowed

boolean

datasources.*.commit-on-return

boolean

datasources.*.rollback-on-return

boolean

datasources.*.use-disposable-connection-facade

boolean

datasources.*.log-validation-errors

boolean

datasources.*.propagate-interrupt-state

boolean

datasources.*.ignore-exception-on-pre-load

boolean

datasources.*.use-statement-facade

boolean

datasources.*.data-source-properties

java.util.Map

datasources.*.jndi-name

java.lang.String

Micronaut Jdbc Ucp Config Properties

🔗
Table 8. Configuration Properties for UniversalConnectionPoolManagerConfiguration
Property Type Description

ucp-manager.enabled

boolean

Enables {@link oracle.ucp.admin.UniversalConnectionPoolManager}.

🔗
Table 9. Configuration Properties for UniversalConnectionPoolManagerConfiguration$JMXBeanConfiguration
Property Type Description

ucp-manager.jmx.enabled

boolean

Enables the JMX-Based Management of UCP.

🔗
Table 10. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.name

java.lang.String

the name of the datasource

datasources.*.driver-class-name

java.lang.String

datasources.*.url

java.lang.String

datasources.*.username

java.lang.String

the username

datasources.*.password

java.lang.String

datasources.*.validation-query

java.lang.String

datasources.*.data-source-properties

java.util.Map

datasources.*.log-writer

java.io.PrintWriter

datasources.*.login-timeout

int

datasources.*.user

java.lang.String

datasources.*.server-name

java.lang.String

datasources.*.port-number

int

datasources.*.database-name

java.lang.String

datasources.*.data-source-name

java.lang.String

datasources.*.description

java.lang.String

datasources.*.network-protocol

java.lang.String

datasources.*.role-name

java.lang.String

datasources.*.initial-pool-size

int

datasources.*.min-pool-size

int

datasources.*.max-pool-size

int

datasources.*.inactive-connection-timeout

int

datasources.*.connection-wait-timeout

int

datasources.*.time-to-live-connection-timeout

int

datasources.*.abandoned-connection-timeout

int

datasources.*.timeout-check-interval

int

datasources.*.fast-connection-failover-enabled

boolean

datasources.*.connection-factory-class-name

java.lang.String

datasources.*.max-statements

int

datasources.*.max-idle-time

int

datasources.*.property-cycle

int

datasources.*.connection-pool-name

java.lang.String

datasources.*.validate-connection-on-borrow

boolean

datasources.*.sqlfor-validate-connection

java.lang.String

datasources.*.connection-harvest-trigger-count

int

datasources.*.connection-harvest-max-count

int

datasources.*.max-connection-reuse-time

long

datasources.*.max-connection-reuse-count

int

datasources.*.onsconfiguration

java.lang.String

datasources.*.connection-properties

java.util.Properties

datasources.*.connection-labeling-high-cost

int

datasources.*.connection-repurpose-threshold

int

datasources.*.high-cost-connection-reuse-threshold

int

datasources.*.seconds-to-trust-idle-connection

int

datasources.*.query-timeout

int

datasources.*.max-connections-per-shard

int

datasources.*.sharding-mode

boolean

datasources.*.connection-validation-timeout

int

datasources.*.sslcontext

javax.net.ssl.SSLContext

datasources.*.hostname-resolver

oracle.ucp.jdbc.PoolDataSource$HostnameResolver

datasources.*.read-only-instance-allowed

boolean

datasources.*.token-supplier

java.util.function.Supplier

Micronaut Jooq Config Properties

🔗
Table 11. Configuration Properties for R2dbcJooqConfigurationProperties
Property Type Description

jooq.r2dbc-datasources.*.sql-dialect

org.jooq.SQLDialect

SQL dialect to use. If {@code null}, will be detected automatically.

jooq.r2dbc-datasources.*.json-converter-enabled

boolean

If enable {@link JsonConverterProvider} bean to use Jackson for JSON and JSONB types.

🔗
Table 12. Configuration Properties for JooqConfigurationProperties
Property Type Description

jooq.datasources.*.sql-dialect

org.jooq.SQLDialect

SQL dialect to use. If {@code null}, will be detected automatically.

jooq.datasources.*.json-converter-enabled

boolean

If enable {@link JsonConverterProvider} bean to use Jackson for JSON and JSONB types.

Micronaut Vertx Mysql Client Config Properties

🔗
Table 13. Configuration Properties for MySQLClientConfiguration
Property Type Description

vertx.mysql.client.uri

java.lang.String

vertx.mysql.client.send-buffer-size

int

vertx.mysql.client.receive-buffer-size

int

vertx.mysql.client.reuse-address

boolean

vertx.mysql.client.traffic-class

int

vertx.mysql.client.log-activity

boolean

vertx.mysql.client.activity-log-data-format

io.netty.handler.logging.ByteBufFormat

vertx.mysql.client.reuse-port

boolean

vertx.mysql.client.tcp-no-delay

boolean

vertx.mysql.client.tcp-keep-alive

boolean

vertx.mysql.client.so-linger

int

vertx.mysql.client.idle-timeout

int

vertx.mysql.client.read-idle-timeout

int

vertx.mysql.client.write-idle-timeout

int

vertx.mysql.client.idle-timeout-unit

java.util.concurrent.TimeUnit

vertx.mysql.client.ssl

boolean

vertx.mysql.client.key-cert-options

io.vertx.core.net.KeyCertOptions

vertx.mysql.client.key-store-options

io.vertx.core.net.JksOptions

vertx.mysql.client.pfx-key-cert-options

io.vertx.core.net.PfxOptions

vertx.mysql.client.pem-key-cert-options

io.vertx.core.net.PemKeyCertOptions

vertx.mysql.client.trust-options

io.vertx.core.net.TrustOptions

vertx.mysql.client.trust-store-options

io.vertx.core.net.JksOptions

vertx.mysql.client.pfx-trust-options

io.vertx.core.net.PfxOptions

vertx.mysql.client.pem-trust-options

io.vertx.core.net.PemTrustOptions

vertx.mysql.client.use-alpn

boolean

vertx.mysql.client.ssl-engine-options

io.vertx.core.net.SSLEngineOptions

vertx.mysql.client.jdk-ssl-engine-options

io.vertx.core.net.JdkSSLEngineOptions

vertx.mysql.client.open-ssl-engine-options

io.vertx.core.net.OpenSSLEngineOptions

vertx.mysql.client.tcp-fast-open

boolean

vertx.mysql.client.tcp-cork

boolean

vertx.mysql.client.tcp-quick-ack

boolean

vertx.mysql.client.tcp-user-timeout

int

vertx.mysql.client.enabled-secure-transport-protocols

java.util.Set

vertx.mysql.client.ssl-handshake-timeout

long

vertx.mysql.client.ssl-handshake-timeout-unit

java.util.concurrent.TimeUnit

vertx.mysql.client.trust-all

boolean

vertx.mysql.client.connect-timeout

int

vertx.mysql.client.metrics-name

java.lang.String

vertx.mysql.client.proxy-options

io.vertx.core.net.ProxyOptions

vertx.mysql.client.non-proxy-hosts

java.util.List

vertx.mysql.client.local-address

java.lang.String

vertx.mysql.client.reconnect-attempts

int

vertx.mysql.client.hostname-verification-algorithm

java.lang.String

vertx.mysql.client.application-layer-protocols

java.util.List

vertx.mysql.client.reconnect-interval

long

vertx.mysql.client.register-write-handler

boolean

vertx.mysql.client.host

java.lang.String

vertx.mysql.client.port

int

vertx.mysql.client.user

java.lang.String

vertx.mysql.client.password

java.lang.String

vertx.mysql.client.database

java.lang.String

vertx.mysql.client.cache-prepared-statements

boolean

vertx.mysql.client.prepared-statement-cache-max-size

int

vertx.mysql.client.prepared-statement-cache-sql-filter

java.util.function.Predicate

vertx.mysql.client.properties

java.util.Map

vertx.mysql.client.tracing-policy

io.vertx.core.tracing.TracingPolicy

vertx.mysql.client.collation

java.lang.String

vertx.mysql.client.charset

java.lang.String

vertx.mysql.client.character-encoding

java.lang.String

vertx.mysql.client.use-affected-rows

boolean

vertx.mysql.client.ssl-mode

io.vertx.mysqlclient.SslMode

vertx.mysql.client.authentication-plugin

io.vertx.mysqlclient.MySQLAuthenticationPlugin

vertx.mysql.client.server-rsa-public-key-path

java.lang.String

vertx.mysql.client.server-rsa-public-key-value

io.vertx.core.buffer.Buffer

vertx.mysql.client.pipelining-limit

int

vertx.mysql.client.prepared-statement-cache-sql-limit

int

vertx.mysql.client.max-size

int

vertx.mysql.client.max-wait-queue-size

int

vertx.mysql.client.max-lifetime-unit

java.util.concurrent.TimeUnit

vertx.mysql.client.max-lifetime

int

vertx.mysql.client.pool-cleaner-period

int

vertx.mysql.client.connection-timeout-unit

java.util.concurrent.TimeUnit

vertx.mysql.client.connection-timeout

int

vertx.mysql.client.shared

boolean

vertx.mysql.client.name

java.lang.String

vertx.mysql.client.event-loop-size

int

Micronaut Vertx Pg Client Config Properties

🔗
Table 14. Configuration Properties for PgClientConfiguration
Property Type Description

vertx.pg.client.uri

java.lang.String

vertx.pg.client.send-buffer-size

int

vertx.pg.client.receive-buffer-size

int

vertx.pg.client.reuse-address

boolean

vertx.pg.client.traffic-class

int

vertx.pg.client.log-activity

boolean

vertx.pg.client.activity-log-data-format

io.netty.handler.logging.ByteBufFormat

vertx.pg.client.reuse-port

boolean

vertx.pg.client.tcp-no-delay

boolean

vertx.pg.client.tcp-keep-alive

boolean

vertx.pg.client.so-linger

int

vertx.pg.client.idle-timeout

int

vertx.pg.client.read-idle-timeout

int

vertx.pg.client.write-idle-timeout

int

vertx.pg.client.idle-timeout-unit

java.util.concurrent.TimeUnit

vertx.pg.client.ssl

boolean

vertx.pg.client.key-cert-options

io.vertx.core.net.KeyCertOptions

vertx.pg.client.key-store-options

io.vertx.core.net.JksOptions

vertx.pg.client.pfx-key-cert-options

io.vertx.core.net.PfxOptions

vertx.pg.client.pem-key-cert-options

io.vertx.core.net.PemKeyCertOptions

vertx.pg.client.trust-options

io.vertx.core.net.TrustOptions

vertx.pg.client.trust-store-options

io.vertx.core.net.JksOptions

vertx.pg.client.pfx-trust-options

io.vertx.core.net.PfxOptions

vertx.pg.client.pem-trust-options

io.vertx.core.net.PemTrustOptions

vertx.pg.client.use-alpn

boolean

vertx.pg.client.ssl-engine-options

io.vertx.core.net.SSLEngineOptions

vertx.pg.client.jdk-ssl-engine-options

io.vertx.core.net.JdkSSLEngineOptions

vertx.pg.client.open-ssl-engine-options

io.vertx.core.net.OpenSSLEngineOptions

vertx.pg.client.tcp-fast-open

boolean

vertx.pg.client.tcp-cork

boolean

vertx.pg.client.tcp-quick-ack

boolean

vertx.pg.client.tcp-user-timeout

int

vertx.pg.client.enabled-secure-transport-protocols

java.util.Set

vertx.pg.client.ssl-handshake-timeout

long

vertx.pg.client.ssl-handshake-timeout-unit

java.util.concurrent.TimeUnit

vertx.pg.client.trust-all

boolean

vertx.pg.client.connect-timeout

int

vertx.pg.client.metrics-name

java.lang.String

vertx.pg.client.proxy-options

io.vertx.core.net.ProxyOptions

vertx.pg.client.non-proxy-hosts

java.util.List

vertx.pg.client.local-address

java.lang.String

vertx.pg.client.reconnect-attempts

int

vertx.pg.client.hostname-verification-algorithm

java.lang.String

vertx.pg.client.application-layer-protocols

java.util.List

vertx.pg.client.reconnect-interval

long

vertx.pg.client.register-write-handler

boolean

vertx.pg.client.host

java.lang.String

vertx.pg.client.port

int

vertx.pg.client.user

java.lang.String

vertx.pg.client.password

java.lang.String

vertx.pg.client.database

java.lang.String

vertx.pg.client.cache-prepared-statements

boolean

vertx.pg.client.prepared-statement-cache-max-size

int

vertx.pg.client.prepared-statement-cache-sql-filter

java.util.function.Predicate

vertx.pg.client.properties

java.util.Map

vertx.pg.client.tracing-policy

io.vertx.core.tracing.TracingPolicy

vertx.pg.client.pipelining-limit

int

vertx.pg.client.prepared-statement-cache-sql-limit

int

vertx.pg.client.ssl-mode

io.vertx.pgclient.SslMode

vertx.pg.client.use-layer7-proxy

boolean

vertx.pg.client.max-size

int

vertx.pg.client.max-wait-queue-size

int

vertx.pg.client.max-lifetime-unit

java.util.concurrent.TimeUnit

vertx.pg.client.max-lifetime

int

vertx.pg.client.pool-cleaner-period

int

vertx.pg.client.connection-timeout-unit

java.util.concurrent.TimeUnit

vertx.pg.client.connection-timeout

int

vertx.pg.client.shared

boolean

vertx.pg.client.name

java.lang.String

vertx.pg.client.event-loop-size

int