java.lang.Object
- io.rxmicro.config.Config
- - io.rxmicro.data.sql.SQLDatabaseConfig
  - - io.rxmicro.data.sql.SQLPooledDatabaseConfig

```
public class SQLPooledDatabaseConfig
extends SQLDatabaseConfig
```
Allows configuring SQL DB pool options.

Since:

0.1

Author:

nedis

See Also:

Duration

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_ACQUIRE_RETRY`	Default acquire retry.
`static int`	`DEFAULT_INIT_POOL_SIZE`	Default init pool size.
`static Duration`	`DEFAULT_MAX_IDLE_DURATION`	Default max idle duration.
`static int`	`DEFAULT_MAX_POOL_SIZE`	Default max pool size.
`static String`	`DEFAULT_VALIDATION_QUERY`	Default validation query.

Fields inherited from class io.rxmicro.data.sql.SQLDatabaseConfig
DEFAULT_HOST

Fields inherited from class io.rxmicro.config.Config
KEY_VALUE_ENTRY_DELIMITER, RX_MICRO_CONFIG_DIRECTORY_NAME, RX_MICRO_CONFIG_FILE_NAME, VALUES_DELIMITER

Constructor Summary

Constructors
Constructor Description

SQLPooledDatabaseConfig()
Creates a pooled SQL config instance with default settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getAcquireRetry()`	Returns the number of retries if the first connection acquire attempt fails.
`int`	`getInitialSize()`	Returns the initial pool size.
`Duration`	`getMaxAcquireTime()`	Returns the maximum time to acquire connection from pool.
`Duration`	`getMaxCreateConnectionTime()`	Returns the maximum time to create a new connection.
`Duration`	`getMaxIdleTime()`	Returns the maximum idle time of the connection in the pool.
`Duration`	`getMaxLifeTime()`	Returns the maximum lifetime of the connection in the pool.
`int`	`getMaxSize()`	Returns the maximum pool size.
`String`	`getValidationQuery()`	Returns the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.
`SQLPooledDatabaseConfig`	`setAcquireRetry(int acquireRetry)`	Sets the number of retries if the first connection acquire attempt fails.
`SQLPooledDatabaseConfig`	`setConnectTimeout(Duration connectTimeout)`	Sets the connection timeout.
`SQLPooledDatabaseConfig`	`setDatabase(String database)`	Sets the database name.
`SQLPooledDatabaseConfig`	`setHost(String host)`	Sets the server host name.
`SQLPooledDatabaseConfig`	`setInitialSize(int initialSize)`	Sets the initial pool size.
`SQLPooledDatabaseConfig`	`setMaxAcquireTime(Duration maxAcquireTime)`	Sets the maximum time to acquire connection from pool.
`SQLPooledDatabaseConfig`	`setMaxCreateConnectionTime(Duration maxCreateConnectionTime)`	Sets the maximum time to create a new connection.
`SQLPooledDatabaseConfig`	`setMaxIdleTime(Duration maxIdleTime)`	Sets the maximum idle time of the connection in the pool.
`SQLPooledDatabaseConfig`	`setMaxLifeTime(Duration maxLifeTime)`	Sets the maximum lifetime of the connection in the pool.
`SQLPooledDatabaseConfig`	`setMaxSize(int maxSize)`	Sets the maximum pool size.
`SQLPooledDatabaseConfig`	`setOptions(Map<String,String> options)`	Sets the additional database options.
`SQLPooledDatabaseConfig`	`setPassword(CharSequence password)`	Sets the database password.
`SQLPooledDatabaseConfig`	`setPort(int port)`	Sets the server port.
`SQLPooledDatabaseConfig`	`setUser(String user)`	Sets the database username.
`SQLPooledDatabaseConfig`	`setValidationQuery(String validationQuery)`	Sets the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.

Methods inherited from class io.rxmicro.data.sql.SQLDatabaseConfig
getConnectionString, getConnectTimeout, getDatabase, getHost, getOptions, getPassword, getPort, getUser, validate

Methods inherited from class io.rxmicro.config.Config
getDefaultNameSpace, getDefaultNameSpace, getNameSpace

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

- Field Detail
  - DEFAULT_ACQUIRE_RETRY
```
public static final int DEFAULT_ACQUIRE_RETRY
```
    Default acquire retry.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INIT_POOL_SIZE
```
public static final int DEFAULT_INIT_POOL_SIZE
```
    Default init pool size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_POOL_SIZE
```
public static final int DEFAULT_MAX_POOL_SIZE
```
    Default max pool size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IDLE_DURATION
```
public static final Duration DEFAULT_MAX_IDLE_DURATION
```
    Default max idle duration.
  - DEFAULT_VALIDATION_QUERY
```
public static final String DEFAULT_VALIDATION_QUERY
```
    Default validation query.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SQLPooledDatabaseConfig
```
public SQLPooledDatabaseConfig()
```
    Creates a pooled SQL config instance with default settings.
- Method Detail
  - getAcquireRetry
```
public int getAcquireRetry()
```
    Returns the number of retries if the first connection acquire attempt fails.
    Defaults to 2
    
    Returns:
    
    the number of retries if the first connection acquire attempt fails.
  - setAcquireRetry
```
@BuilderMethod
public SQLPooledDatabaseConfig setAcquireRetry(int acquireRetry)
```
    Sets the number of retries if the first connection acquire attempt fails.
    Defaults to 2
    
    Parameters:
    
    acquireRetry - the number of retries if the first connection acquire attempt fails.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getInitialSize
```
public int getInitialSize()
```
    Returns the initial pool size.
    Defaults to 3
    
    Returns:
    
    the initial pool size
  - setInitialSize
```
@BuilderMethod
public SQLPooledDatabaseConfig setInitialSize(int initialSize)
```
    Sets the initial pool size.
    Defaults to 3
    
    Parameters:
    
    initialSize - the initial pool size
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getMaxSize
```
public int getMaxSize()
```
    Returns the maximum pool size.
    Defaults to 5
    
    Returns:
    
    the maximum pool size
  - setMaxSize
```
@BuilderMethod
public SQLPooledDatabaseConfig setMaxSize(int maxSize)
```
    Sets the maximum pool size.
    Defaults to 5
    
    Parameters:
    
    maxSize - the maximum pool size
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getValidationQuery
```
public String getValidationQuery()
```
    Returns the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.
    
    Returns:
    
    the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.
  - setValidationQuery
```
@BuilderMethod
public SQLPooledDatabaseConfig setValidationQuery(String validationQuery)
```
    Sets the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.
    
    Parameters:
    
    validationQuery - the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getMaxIdleTime
```
public Duration getMaxIdleTime()
```
    Returns the maximum idle time of the connection in the pool.
    
    Returns:
    
    the maximum idle time of the connection in the pool.
  - setMaxIdleTime
```
@BuilderMethod
public SQLPooledDatabaseConfig setMaxIdleTime(Duration maxIdleTime)
```
    Sets the maximum idle time of the connection in the pool.
    
    Parameters:
    
    maxIdleTime - the maximum idle time of the connection in the pool.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getMaxCreateConnectionTime
```
public Duration getMaxCreateConnectionTime()
```
    Returns the maximum time to create a new connection.
    
    Returns:
    
    the maximum time to create a new connection.
  - setMaxCreateConnectionTime
```
@BuilderMethod
public SQLPooledDatabaseConfig setMaxCreateConnectionTime(Duration maxCreateConnectionTime)
```
    Sets the maximum time to create a new connection.
    
    Parameters:
    
    maxCreateConnectionTime - the maximum time to create a new connection.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getMaxAcquireTime
```
public Duration getMaxAcquireTime()
```
    Returns the maximum time to acquire connection from pool.
    
    Returns:
    
    the maximum time to acquire connection from pool.
  - setMaxAcquireTime
```
@BuilderMethod
public SQLPooledDatabaseConfig setMaxAcquireTime(Duration maxAcquireTime)
```
    Sets the maximum time to acquire connection from pool.
    
    Parameters:
    
    maxAcquireTime - the maximum time to acquire connection from pool.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - getMaxLifeTime
```
public Duration getMaxLifeTime()
```
    Returns the maximum lifetime of the connection in the pool.
    
    Returns:
    
    the maximum lifetime of the connection in the pool.
  - setMaxLifeTime
```
@BuilderMethod
public SQLPooledDatabaseConfig setMaxLifeTime(Duration maxLifeTime)
```
    Sets the maximum lifetime of the connection in the pool.
    
    Parameters:
    
    maxLifeTime - the maximum lifetime of the connection in the pool.
    
    Returns:
    
    the reference to this SQLPooledDatabaseConfig instance
  - setHost
```
public SQLPooledDatabaseConfig setHost(String host)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the server host name.
    
    Overrides:
    
    setHost in class SQLDatabaseConfig
    
    Parameters:
    
    host - the server host name
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setPort
```
public SQLPooledDatabaseConfig setPort(int port)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the server port.
    
    Overrides:
    
    setPort in class SQLDatabaseConfig
    
    Parameters:
    
    port - the server port
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setUser
```
public SQLPooledDatabaseConfig setUser(String user)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the database username.
    
    Overrides:
    
    setUser in class SQLDatabaseConfig
    
    Parameters:
    
    user - the database username
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setPassword
```
public SQLPooledDatabaseConfig setPassword(CharSequence password)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the database password.
    
    Overrides:
    
    setPassword in class SQLDatabaseConfig
    
    Parameters:
    
    password - the database password
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setDatabase
```
public SQLPooledDatabaseConfig setDatabase(String database)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the database name.
    
    Overrides:
    
    setDatabase in class SQLDatabaseConfig
    
    Parameters:
    
    database - the database name
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setOptions
```
public SQLPooledDatabaseConfig setOptions(Map<String,String> options)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the additional database options.
    
    Overrides:
    
    setOptions in class SQLDatabaseConfig
    
    Parameters:
    
    options - the additional options
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance
  - setConnectTimeout
```
public SQLPooledDatabaseConfig setConnectTimeout(Duration connectTimeout)
```
    Description copied from class: SQLDatabaseConfig
    
    Sets the connection timeout.
    
    Overrides:
    
    setConnectTimeout in class SQLDatabaseConfig
    
    Parameters:
    
    connectTimeout - the connection timeout
    
    Returns:
    
    the reference to this SQLDatabaseConfig instance

Class SQLPooledDatabaseConfig

Field Summary

Fields inherited from class io.rxmicro.data.sql.SQLDatabaseConfig

Fields inherited from class io.rxmicro.config.Config

Constructor Summary

Method Summary

Methods inherited from class io.rxmicro.data.sql.SQLDatabaseConfig

Methods inherited from class io.rxmicro.config.Config

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ACQUIRE_RETRY

DEFAULT_INIT_POOL_SIZE

DEFAULT_MAX_POOL_SIZE

DEFAULT_MAX_IDLE_DURATION

DEFAULT_VALIDATION_QUERY

Constructor Detail

SQLPooledDatabaseConfig

Method Detail

getAcquireRetry

setAcquireRetry

getInitialSize

setInitialSize

getMaxSize

setMaxSize

getValidationQuery

setValidationQuery

getMaxIdleTime

setMaxIdleTime

getMaxCreateConnectionTime

setMaxCreateConnectionTime

getMaxAcquireTime

setMaxAcquireTime

getMaxLifeTime

setMaxLifeTime

setHost

setPort

setUser

setPassword

setDatabase

setOptions

setConnectTimeout