Package io.quarkus.reactive.datasource.runtime

Interface DataSourceReactiveRuntimeConfig

public interface DataSourceReactiveRuntimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    additionalProperties()
    Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.
    Optional<Boolean>
    cachePreparedStatements()
    Whether prepared statements should be cached on the client side.
    OptionalInt
    eventLoopSize()
    When a new connection object is created, the pool assigns it an event loop.
    String
    hostnameVerificationAlgorithm()
    The hostname verification algorithm to use in case the server's identity should be checked.
    Optional<Duration>
    idleTimeout()
    The maximum time a connection remains unused in the pool before it is closed.
    io.quarkus.vertx.core.runtime.config.JksConfiguration
    keyCertificateJks()
    Key/cert configuration in the JKS format.
    io.quarkus.vertx.core.runtime.config.PemKeyCertConfiguration
    keyCertificatePem()
    Key/cert configuration in the PEM format.
    io.quarkus.vertx.core.runtime.config.PfxConfiguration
    keyCertificatePfx()
    Key/cert configuration in the PFX format.
    Optional<Duration>
    maxLifetime()
    The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.
    int
    maxSize()
    The datasource pool maximum size.
    Optional<String>
    name()
    Set the pool name, used when the pool is shared among datasources, otherwise ignored.
    int
    reconnectAttempts()
    The number of reconnection attempts when a pooled connection cannot be established on first try.
    Duration
    reconnectInterval()
    The interval between reconnection attempts when a pooled connection cannot be established on first try.
    boolean
    shared()
    Set to true to share the pool among datasources.
    boolean
    trustAll()
    Whether all server certificates should be trusted.
    io.quarkus.vertx.core.runtime.config.JksConfiguration
    trustCertificateJks()
    Trust configuration in the JKS format.
    io.quarkus.vertx.core.runtime.config.PemTrustCertConfiguration
    trustCertificatePem()
    Trust configuration in the PEM format.
    io.quarkus.vertx.core.runtime.config.PfxConfiguration
    trustCertificatePfx()
    Trust configuration in the PFX format.
    Optional<List<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String>>
    url()
    The datasource URLs.

  • Method Details

    • cachePreparedStatements

      @ConfigDocDefault("true for PostgreSQL/MySQL/MariaDB/Db2, false otherwise") Optional<Boolean> cachePreparedStatements()
      Whether prepared statements should be cached on the client side.

    • url

      Optional<List<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String>> url()
      The datasource URLs.

      If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.

    • maxSize

      @WithDefault("20") int maxSize()
      The datasource pool maximum size.

    • eventLoopSize

      OptionalInt eventLoopSize()
      When a new connection object is created, the pool assigns it an event loop.

      When #event-loop-size is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If #event-loop-size is set to zero or a negative value, the pool assigns the current event loop to the new connection.

    • trustAll

      @WithDefault("false") boolean trustAll()
      Whether all server certificates should be trusted.

    • trustCertificatePem

      io.quarkus.vertx.core.runtime.config.PemTrustCertConfiguration trustCertificatePem()
      Trust configuration in the PEM format.

      When enabled, #trust-certificate-jks and #trust-certificate-pfx must be disabled.

    • trustCertificateJks

      io.quarkus.vertx.core.runtime.config.JksConfiguration trustCertificateJks()
      Trust configuration in the JKS format.

      When enabled, #trust-certificate-pem and #trust-certificate-pfx must be disabled.

    • trustCertificatePfx

      io.quarkus.vertx.core.runtime.config.PfxConfiguration trustCertificatePfx()
      Trust configuration in the PFX format.

      When enabled, #trust-certificate-jks and #trust-certificate-pem must be disabled.

    • keyCertificatePem

      io.quarkus.vertx.core.runtime.config.PemKeyCertConfiguration keyCertificatePem()
      Key/cert configuration in the PEM format.

      When enabled, key-certificate-jks and #key-certificate-pfx must be disabled.

    • keyCertificateJks

      io.quarkus.vertx.core.runtime.config.JksConfiguration keyCertificateJks()
      Key/cert configuration in the JKS format.

      When enabled, #key-certificate-pem and #key-certificate-pfx must be disabled.

    • keyCertificatePfx

      io.quarkus.vertx.core.runtime.config.PfxConfiguration keyCertificatePfx()
      Key/cert configuration in the PFX format.

      When enabled, key-certificate-jks and #key-certificate-pem must be disabled.

    • reconnectAttempts

      @WithDefault("0") int reconnectAttempts()
      The number of reconnection attempts when a pooled connection cannot be established on first try.

    • reconnectInterval

      @WithDefault("PT1S") Duration reconnectInterval()
      The interval between reconnection attempts when a pooled connection cannot be established on first try.

    • hostnameVerificationAlgorithm

      @WithDefault("NONE") String hostnameVerificationAlgorithm()
      The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or NONE. NONE is the default value and disables the verification.

    • idleTimeout

      @ConfigDocDefault("no timeout") Optional<Duration> idleTimeout()
      The maximum time a connection remains unused in the pool before it is closed.

    • maxLifetime

      @ConfigDocDefault("no timeout") Optional<Duration> maxLifetime()
      The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.

    • shared

      @WithDefault("false") boolean shared()
      Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the __vertx.DEFAULT name is used.

    • name

      Optional<String> name()
      Set the pool name, used when the pool is shared among datasources, otherwise ignored.

    • additionalProperties

      @ConfigDocMapKey("property-key") Map<String,String> additionalProperties()
      Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.