Package com.zaxxer.hikari

Class HikariDataSource

java.lang.Object

com.zaxxer.hikari.HikariConfig

com.zaxxer.hikari.HikariDataSource

All Implemented Interfaces:

HikariConfigMXBean, Closeable, AutoCloseable, Wrapper, CommonDataSource, DataSource

public class HikariDataSource
extends HikariConfig
implements DataSource, Closeable

The HikariCP pooled DataSource.

Author:

Brett Wooldridge

Constructor Summary

Constructors

Constructor	Description
HikariDataSource()	Default constructor.
HikariDataSource(HikariConfig configuration)	Construct a HikariDataSource with the specified configuration.

Method Summary

Modifier and Type	Method	Description
void	close()	Shutdown the DataSource and its associated pool.
void	evictConnection(Connection connection)	Evict a connection from the pool.
Connection	getConnection()
Connection	getConnection(String username, String password)
HikariConfigMXBean	getHikariConfigMXBean()	Get the HikariConfigMXBean for this HikariDataSource instance.
HikariPoolMXBean	getHikariPoolMXBean()	Get the HikariPoolMXBean for this HikariDataSource instance.
int	getLoginTimeout()
PrintWriter	getLogWriter()
Logger	getParentLogger()
boolean	isClosed()	Determine whether the HikariDataSource has been closed.
boolean	isWrapperFor(Class<?> iface)
void	resumePool()	Deprecated. Call the HikariPoolMXBean#resumePool() method on the HikariPoolMXBean obtained by #getHikariPoolMXBean() or JMX lookup.
void	setHealthCheckRegistry(Object healthCheckRegistry)	Set a Codahale HealthCheckRegistry to use for HikariCP.
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	setMetricRegistry(Object metricRegistry)	Set a Codahale MetricRegistry to use for HikariCP.
void	setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)
void	shutdown()	Deprecated. This method has been deprecated, please use close() instead
void	suspendPool()	Deprecated. Call the HikariPoolMXBean#suspendPool() method on the HikariPoolMXBean obtained by #getHikariPoolMXBean() or JMX lookup.
String	toString()
<T> T	unwrap(Class<T> iface)

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Methods inherited from class com.zaxxer.hikari.HikariConfig

addDataSourceProperty, addHealthCheckProperty, copyState, getCatalog, getConnectionInitSql, getConnectionTestQuery, getConnectionTimeout, getDataSource, getDataSourceClassName, getDataSourceJNDI, getDataSourceProperties, getDriverClassName, getHealthCheckProperties, getHealthCheckRegistry, getIdleTimeout, getInitializationFailTimeout, getJdbcUrl, getLeakDetectionThreshold, getMaximumPoolSize, getMaxLifetime, getMetricRegistry, getMetricsTrackerFactory, getMinimumIdle, getPassword, getPoolName, getScheduledExecutor, getScheduledExecutorService, getThreadFactory, getTransactionIsolation, getUsername, getValidationTimeout, isAllowPoolSuspension, isAutoCommit, isInitializationFailFast, isIsolateInternalQueries, isJdbc4ConnectionTest, isReadOnly, isRegisterMbeans, setAllowPoolSuspension, setAutoCommit, setCatalog, setConnectionInitSql, setConnectionTestQuery, setConnectionTimeout, setDataSource, setDataSourceClassName, setDataSourceJNDI, setDataSourceProperties, setDriverClassName, setHealthCheckProperties, setIdleTimeout, setInitializationFailFast, setInitializationFailTimeout, setIsolateInternalQueries, setJdbc4ConnectionTest, setJdbcUrl, setLeakDetectionThreshold, setMaximumPoolSize, setMaxLifetime, setMinimumIdle, setPassword, setPoolName, setReadOnly, setRegisterMbeans, setScheduledExecutor, setScheduledExecutorService, setThreadFactory, setTransactionIsolation, setUsername, setValidationTimeout, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HikariDataSource

public HikariDataSource()

Default constructor. Setters be used to configure the pool. Using this constructor vs. HikariDataSource(HikariConfig) will result in getConnection() performance that is slightly lower due to lazy initialization checks.

HikariDataSource

public HikariDataSource(HikariConfig configuration)

Construct a HikariDataSource with the specified configuration.

Parameters:

configuration - a HikariConfig instance

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
                                String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface CommonDataSource

Specified by:

getLogWriter in interface DataSource

Throws:

SQLException

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Specified by:

setLogWriter in interface CommonDataSource

Specified by:

setLogWriter in interface DataSource

Throws:

SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Specified by:

setLoginTimeout in interface DataSource

Throws:

SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface CommonDataSource

Specified by:

getLoginTimeout in interface DataSource

Throws:

SQLException

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

setMetricRegistry

public void setMetricRegistry(Object metricRegistry)

Set a Codahale MetricRegistry to use for HikariCP.

Overrides:

setMetricRegistry in class HikariConfig

Parameters:

metricRegistry - the Codahale MetricRegistry to set

setMetricsTrackerFactory

public void setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)

Overrides:

setMetricsTrackerFactory in class HikariConfig

setHealthCheckRegistry

public void setHealthCheckRegistry(Object healthCheckRegistry)

Set a Codahale HealthCheckRegistry to use for HikariCP.

Overrides:

setHealthCheckRegistry in class HikariConfig

Parameters:

healthCheckRegistry - the Codahale HealthCheckRegistry to set

getHikariPoolMXBean

public HikariPoolMXBean getHikariPoolMXBean()

Get the HikariPoolMXBean for this HikariDataSource instance. If this method is called on a HikariDataSource that has been constructed without a HikariConfig instance, and before an initial call to #getConnection(), the return value will be null.

Returns:

the HikariPoolMXBean instance, or null.

getHikariConfigMXBean

public HikariConfigMXBean getHikariConfigMXBean()

Get the HikariConfigMXBean for this HikariDataSource instance.

Returns:

the HikariConfigMXBean instance.

evictConnection

public void evictConnection(Connection connection)

Evict a connection from the pool. If the connection has already been closed (returned to the pool) this may result in a "soft" eviction; the connection will be evicted sometime in the future if it is currently in use. If the connection has not been closed, the eviction is immediate.

Parameters:

connection - the connection to evict from the pool

suspendPool

@Deprecated
public void suspendPool()

Deprecated. Call the HikariPoolMXBean#suspendPool() method on the HikariPoolMXBean obtained by #getHikariPoolMXBean() or JMX lookup.

Suspend allocation of connections from the pool. All callers to getConnection() will block indefinitely until resumePool() is called.

resumePool

@Deprecated
public void resumePool()

Deprecated. Call the HikariPoolMXBean#resumePool() method on the HikariPoolMXBean obtained by #getHikariPoolMXBean() or JMX lookup.

Resume allocation of connections from the pool.

close

public void close()

Shutdown the DataSource and its associated pool.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isClosed

public boolean isClosed()

Determine whether the HikariDataSource has been closed.

Returns:

true if the HikariDataSource has been closed, false otherwise

shutdown

@Deprecated
public void shutdown()

Deprecated. This method has been deprecated, please use close() instead

Shutdown the DataSource and its associated pool.

toString

public String toString()

Overrides:

toString in class Object