org.springframework.boot.autoconfigure.jdbc

Class HikariDataSourceConfiguration

java.lang.Object

org.springframework.boot.autoconfigure.jdbc.AbstractDataSourceConfiguration

org.springframework.boot.autoconfigure.jdbc.HikariDataSourceConfiguration

All Implemented Interfaces:

Aware, BeanClassLoaderAware, InitializingBean

@Configuration
public class HikariDataSourceConfiguration
extends AbstractDataSourceConfiguration

Configuration for a HikariCP database pool. The HikariCP pool is a popular data source implementation that provides high performance as well as some useful opinionated defaults. For compatibility with other DataSource implementations accepts configuration via properties in "spring.datasource.*", e.g. "url", "driverClassName", "username", "password" (and some others but the full list supported by the Tomcat pool is not applicable). Note that the Hikari team recommends using a "dataSourceClassName" and a Properties instance (specified here as "spring.datasource.hikari.*"). This makes the binding potentially vendor specific, but gives you full control of all the native features in the vendor's DataSource.

Since:

1.1.0

Author:

Dave Syer

See Also:

DataSourceAutoConfiguration

Constructor Summary

Constructors

Constructor and Description
HikariDataSourceConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
DataSource	dataSource()
Properties	getHikari()
protected String	getUsername()
void	setDataSourceClassName(String dataSourceClassName)
void	setUsername(String username)

Methods inherited from class org.springframework.boot.autoconfigure.jdbc.AbstractDataSourceConfiguration

afterPropertiesSet, getDriverClassName, getInitialSize, getMaxActive, getMaxIdle, getMaxWaitMillis, getMinEvictableIdleTimeMillis, getMinIdle, getPassword, getTimeBetweenEvictionRunsMillis, getUrl, getValidationQuery, isTestOnBorrow, isTestOnReturn, isTestWhileIdle, setBeanClassLoader, setDriverClassName, setInitialSize, setMaxActive, setMaxIdle, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setPassword, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUrl, setValidationQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariDataSourceConfiguration

public HikariDataSourceConfiguration()

Method Detail

dataSource

@Bean(destroyMethod="shutdown")
public DataSource dataSource()

close

@PreDestroy
public void close()

setDataSourceClassName

public void setDataSourceClassName(String dataSourceClassName)

Parameters:

dataSourceClassName - the dataSourceClassName to set

setUsername

public void setUsername(String username)

Overrides:

setUsername in class AbstractDataSourceConfiguration

getHikari

public Properties getHikari()

Returns:

the hikari data source properties

getUsername

protected String getUsername()

Overrides:

getUsername in class AbstractDataSourceConfiguration