io.r2dbc.pool

Class ConnectionPool

java.lang.Object

io.r2dbc.pool.ConnectionPool

All Implemented Interfaces:

io.r2dbc.spi.ConnectionFactory, io.r2dbc.spi.Wrapped<io.r2dbc.spi.ConnectionFactory>, Closeable, AutoCloseable, Disposable

public class ConnectionPool
extends Object
implements io.r2dbc.spi.ConnectionFactory, Disposable, Closeable, io.r2dbc.spi.Wrapped<io.r2dbc.spi.ConnectionFactory>

Reactive Relational Database Connection Pool implementation.

Author:

Mark Paluch, Tadaya Tsuyukubo

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Constructor Summary

Constructors

Constructor and Description
ConnectionPool(ConnectionPoolConfiguration configuration) Creates a new connection factory.

Method Summary

Modifier and Type	Method and Description
void	close()
Mono<io.r2dbc.spi.Connection>	create()
void	dispose()
Mono<Void>	disposeLater() Dispose this ConnectionPool in non-blocking flow.
io.r2dbc.spi.ConnectionFactoryMetadata	getMetadata()
Optional<PoolMetrics>	getMetrics() Returns PoolMetrics if available.
protected ObjectName	getPoolObjectName(String name) Construct JMX ObjectName.
boolean	isDisposed()
String	toString()
io.r2dbc.spi.ConnectionFactory	unwrap()
Mono<Integer>	warmup() Warms up the ConnectionPool, if needed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectionPool

public ConnectionPool(ConnectionPoolConfiguration configuration)

Creates a new connection factory.

Parameters:

configuration - the configuration to use for building the connection pool.

Throws:

IllegalArgumentException - if configuration is null

Method Detail

warmup

public Mono<Integer> warmup()

Warms up the ConnectionPool, if needed. This instructs the pool to check for a minimum size and allocate necessary connections when the minimum is not reached.

Returns:

a cold Mono that triggers resource warmup and emits the number of warmed up resources.

create

public Mono<io.r2dbc.spi.Connection> create()

Specified by:

create in interface io.r2dbc.spi.ConnectionFactory

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

dispose

public void dispose()

Specified by:

dispose in interface Disposable

disposeLater

public Mono<Void> disposeLater()

Dispose this ConnectionPool in non-blocking flow.

When multiple errors occurred during dispose flow, they are added as suppressed errors onto the first error.

Returns:

a Mono triggering the shutdown of the pool once subscribed.

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Disposable

getMetadata

public io.r2dbc.spi.ConnectionFactoryMetadata getMetadata()

Specified by:

getMetadata in interface io.r2dbc.spi.ConnectionFactory

unwrap

public io.r2dbc.spi.ConnectionFactory unwrap()

Specified by:

unwrap in interface io.r2dbc.spi.Wrapped<io.r2dbc.spi.ConnectionFactory>

toString

public String toString()

Overrides:

toString in class Object

getMetrics

public Optional<PoolMetrics> getMetrics()

Returns PoolMetrics if available.

Returns:

the optional pool metrics.

getPoolObjectName

protected ObjectName getPoolObjectName(String name)
                                throws MalformedObjectNameException

Construct JMX ObjectName.

Parameters:

name - connection pool name

Returns:

JMX ObjectName

Throws:

MalformedObjectNameException - when invalid objectname is constructed