ConnectionPoolConfiguration.Builder (Reactive Relational Database Connectivity

java.lang.Object
- io.r2dbc.pool.ConnectionPoolConfiguration.Builder

Enclosing class:

ConnectionPoolConfiguration
```
public static final class ConnectionPoolConfiguration.Builder
extends Object
```
A builder for ConnectionPoolConfiguration instances.
This class is not threadsafe

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionPoolConfiguration.Builder`	`acquireRetry(int retryAttempts)` Configure the number of acquire retries if the first acquiry attempt fails.
`ConnectionPoolConfiguration`	`build()` Returns a configured `ConnectionPoolConfiguration`.
`ConnectionPoolConfiguration.Builder`	`clock(Clock clock)` Configure the `Clock` used for allocation and eviction timing.
`ConnectionPoolConfiguration.Builder`	`connectionFactory(io.r2dbc.spi.ConnectionFactory connectionFactory)` Configure connection factory.
`ConnectionPoolConfiguration.Builder`	`customizer(Consumer<reactor.pool.PoolBuilder<io.r2dbc.spi.Connection,? extends reactor.pool.PoolConfig<? extends io.r2dbc.spi.Connection>>> customizer)` Configure a customizer for `PoolBuilder` that constructs the `Connection` pool.
`ConnectionPoolConfiguration.Builder`	`initialSize(int initialSize)` Configure the initial connection pool size.
`ConnectionPoolConfiguration.Builder`	`maxAcquireTime(Duration maxAcquireTime)` Configure `timeout` for acquiring a `Connection` from pool.
`ConnectionPoolConfiguration.Builder`	`maxCreateConnectionTime(Duration maxCreateConnectionTime)` Configure `timeout` for creating a new `Connection` from `ConnectionFactory`.
`ConnectionPoolConfiguration.Builder`	`maxIdleTime(Duration maxIdleTime)` Configure a idle `timeout`.
`ConnectionPoolConfiguration.Builder`	`maxLifeTime(Duration maxLifeTime)` Configure `lifetime` of the pooled `Connection` in the pool.
`ConnectionPoolConfiguration.Builder`	`maxSize(int maxSize)` Configure the maximal connection pool size.
`ConnectionPoolConfiguration.Builder`	`metricsRecorder(reactor.pool.PoolMetricsRecorder recorder)` Configure `PoolMetricsRecorder` to calculate elapsed time and instrumentation data
`ConnectionPoolConfiguration.Builder`	`name(String name)` Configure the name of the connection pool.
`ConnectionPoolConfiguration.Builder`	`registerJmx(boolean registerJmx)` Configure whether to register to JMX.
`String`	`toString()`
`ConnectionPoolConfiguration.Builder`	`validationDepth(io.r2dbc.spi.ValidationDepth validationDepth)` Configure validation depth for `connection validation`.
`ConnectionPoolConfiguration.Builder`	`validationQuery(String validationQuery)` Configure a validation query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - acquireRetry
```
public ConnectionPoolConfiguration.Builder acquireRetry(int retryAttempts)
```
    Configure the number of acquire retries if the first acquiry attempt fails.
    
    Parameters:
    
    retryAttempts - the number of retries. Can be zero or any positive number
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if retryAttempts is less than zero.
    
    See Also:
    
    Mono.retry(long)
  - clock
```
public ConnectionPoolConfiguration.Builder clock(Clock clock)
```
    Configure the Clock used for allocation and eviction timing.
    
    Parameters:
    
    clock - the Clock to use.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if clock is null.
  - customizer
```
public ConnectionPoolConfiguration.Builder customizer(Consumer<reactor.pool.PoolBuilder<io.r2dbc.spi.Connection,? extends reactor.pool.PoolConfig<? extends io.r2dbc.spi.Connection>>> customizer)
```
    Configure a customizer for PoolBuilder that constructs the Connection pool.
    
    Parameters:
    
    customizer - customizer for PoolBuilder that creates the Connection pool, must not be null.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if customizer is null
  - initialSize
```
public ConnectionPoolConfiguration.Builder initialSize(int initialSize)
```
    Configure the initial connection pool size. Defaults to 10.
    
    Parameters:
    
    initialSize - the initial pool size, must be equal or greater than zero.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxSize is negative or zero.
  - maxSize
```
public ConnectionPoolConfiguration.Builder maxSize(int maxSize)
```
    Configure the maximal connection pool size. Defaults to 10.
    
    Parameters:
    
    maxSize - the maximal pool size, must be greater than zero.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxSize is negative or zero.
  - maxIdleTime
```
public ConnectionPoolConfiguration.Builder maxIdleTime(Duration maxIdleTime)
```
    Configure a idle timeout. Defaults to 30 minutes.
    
    Parameters:
    
    maxIdleTime - the maximum idle time, must not be null and must not be negative. Duration.ZERO means no idle timeout.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxIdleTime is null or negative value.
  - maxCreateConnectionTime
```
public ConnectionPoolConfiguration.Builder maxCreateConnectionTime(Duration maxCreateConnectionTime)
```
    Configure timeout for creating a new Connection from ConnectionFactory. Default is no timeout.
    
    Parameters:
    
    maxCreateConnectionTime - the maximum time to create a new Connection from ConnectionFactory, must not be null and must not be negative. Duration.ZERO indicates no timeout.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxCreateConnectionTime is null or negative.
  - maxAcquireTime
```
public ConnectionPoolConfiguration.Builder maxAcquireTime(Duration maxAcquireTime)
```
    Configure timeout for acquiring a Connection from pool. Default is no timeout.
    When acquiring a Connection requires obtaining a new Connection from underlying ConnectionFactory, this timeout also applies to get the new one.
    
    Parameters:
    
    maxAcquireTime - the maximum time to acquire connection from pool, must not be null and must not be negative. Duration.ZERO indicates no timeout.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxAcquireTime is negative.
  - maxLifeTime
```
public ConnectionPoolConfiguration.Builder maxLifeTime(Duration maxLifeTime)
```
    Configure lifetime of the pooled Connection in the pool. Default is no timeout.
    
    Parameters:
    
    maxLifeTime - the maximum lifetime of the connection in the pool, must not be null and must not be negative. Duration.ZERO indicates no lifetime.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if maxLifeTime is negative.
  - metricsRecorder
```
public ConnectionPoolConfiguration.Builder metricsRecorder(reactor.pool.PoolMetricsRecorder recorder)
```
    Configure PoolMetricsRecorder to calculate elapsed time and instrumentation data
    
    Parameters:
    
    recorder - the PoolMetricsRecorder
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if recorder is null
  - name
```
public ConnectionPoolConfiguration.Builder name(String name)
```
    Configure the name of the connection pool.
    
    Parameters:
    
    name - pool name
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if name is null
  - registerJmx
```
public ConnectionPoolConfiguration.Builder registerJmx(boolean registerJmx)
```
    Configure whether to register to JMX. Defaults to false.
    
    Parameters:
    
    registerJmx - register the pool to JMX
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
  - validationDepth
```
public ConnectionPoolConfiguration.Builder validationDepth(io.r2dbc.spi.ValidationDepth validationDepth)
```
    Configure validation depth for connection validation.
    
    Parameters:
    
    validationDepth - the depth of validation, must not be null
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if validationDepth is null
  - connectionFactory
```
public ConnectionPoolConfiguration.Builder connectionFactory(io.r2dbc.spi.ConnectionFactory connectionFactory)
```
    Configure connection factory.
    
    Parameters:
    
    connectionFactory - the connection factory to connect to the db, must not be null
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if connectionFactory is null
    
    Since:
    
    0.8.2
  - validationQuery
```
public ConnectionPoolConfiguration.Builder validationQuery(String validationQuery)
```
    Configure a validation query. When a validation query is used, then Connection.validate(ValidationDepth) is not used.
    
    Parameters:
    
    validationQuery - the validation query to run before returning a Connection from the pool, must not be null.
    
    Returns:
    
    this ConnectionPoolConfiguration.Builder
    
    Throws:
    
    IllegalArgumentException - if validationQuery is null
  - build
```
public ConnectionPoolConfiguration build()
```
    Returns a configured ConnectionPoolConfiguration.
    
    Returns:
    
    a configured ConnectionPoolConfiguration
    
    Throws:
    
    IllegalArgumentException - if registerJmx is true AND name is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ConnectionPoolConfiguration.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

acquireRetry

clock

customizer

initialSize

maxSize

maxIdleTime

maxCreateConnectionTime

maxAcquireTime

maxLifeTime

metricsRecorder

name

registerJmx

validationDepth

connectionFactory

validationQuery

build

toString