io.airlift.dbpool

Class ManagedDataSourceConfig<T extends ManagedDataSourceConfig<T>>

java.lang.Object

io.airlift.dbpool.ManagedDataSourceConfig<T>

Type Parameters:

T - The type current class or subclass, which is used for method chaining

Implementation Note:
The generic type T is used for method chaining. A sub class should declare the Class as follows:
MyDataSourceConfig extends ManagedDataSourceConfig<MyDataSourceConfig>

Direct Known Subclasses:

H2EmbeddedDataSourceConfig, MySqlDataSourceConfig, PostgreSqlDataSourceConfig

@DefunctConfig(value={"db.username","db.password"})
public class ManagedDataSourceConfig<T extends ManagedDataSourceConfig<T>>
extends Object

Basic configuration for ManagedDataSource.

The configuration options can be chained as follows:

 
     ManagedDataSourceConfig config = new ManagedDataSourceConfig()
             .setMaxConnections(20)
             .setMaxConnectionWait(new Duration(20, TimeUnit.MILLISECONDS));
 
 

Constructor Summary

Constructors

Constructor and Description
ManagedDataSourceConfig()

Method Summary

Modifier and Type	Method and Description
int	getMaxConnections() Gets the maximum number of concurrent connections allowed by the data source.
io.airlift.units.Duration	getMaxConnectionWait() Gets the maximum time a client is allowed to wait before a connection.
T	setMaxConnections(int maxConnections) Sets the maximum number of concurrent connections allowed by the data source.
T	setMaxConnectionWait(io.airlift.units.Duration maxConnectionWait) Sets the maximum time a client is allowed to wait before a connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedDataSourceConfig

public ManagedDataSourceConfig()

Method Detail

getMaxConnections

public int getMaxConnections()

Gets the maximum number of concurrent connections allowed by the data source. The data source will perform a best effort cap on the number of connections, but in some scenarios there may be slightly more connections than the current cap. When the cap is lowered the extra connections will be pruned as they are closed.

setMaxConnections

@Config(value="db.connections.max")
public T setMaxConnections(int maxConnections)

Sets the maximum number of concurrent connections allowed by the data source. The data source will perform a best effort cap on the number of connections, but in some scenarios there may be slightly more connections than the current cap. When the cap is lowered the extra connections will be pruned as they are closed.

getMaxConnectionWait

public io.airlift.units.Duration getMaxConnectionWait()

Gets the maximum time a client is allowed to wait before a connection. If a connection can not be obtained within the limit, a SqlTimeoutException is thrown.

setMaxConnectionWait

@Config(value="db.connections.wait")
public T setMaxConnectionWait(io.airlift.units.Duration maxConnectionWait)

Sets the maximum time a client is allowed to wait before a connection. If a connection can not be obtained within the limit, a SqlTimeoutException is thrown.