com.zaxxer.hikari

Class HikariDataSource

java.lang.Object

com.zaxxer.hikari.HikariConfig

com.zaxxer.hikari.HikariDataSource

All Implemented Interfaces:

HikariConfigMBean, java.io.Closeable, java.lang.AutoCloseable, java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

public class HikariDataSource
extends HikariConfig
implements javax.sql.DataSource, java.io.Closeable

The HikariCP pooled DataSource.

Author:

Brett Wooldridge

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() close() and shutdown() are synonymous.
void	evictConnection(java.sql.Connection connection) Evict a connection from the pool.
java.sql.Connection	getConnection()
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password)
int	getLoginTimeout()
java.io.PrintWriter	getLogWriter()
java.util.logging.Logger	getParentLogger()
boolean	isWrapperFor(java.lang.Class<?> iface)
void	setLoginTimeout(int seconds)
void	setLogWriter(java.io.PrintWriter out)
void	shutdown() Shutdown the DataSource and its associated pool.
java.lang.String	toString()
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class com.zaxxer.hikari.HikariConfig

addDataSourceProperty, getCatalog, getConnectionCustomizer, getConnectionCustomizerClassName, getConnectionInitSql, getConnectionTestQuery, getConnectionTimeout, getDataSource, getDataSourceClassName, getDataSourceJNDI, getDataSourceProperties, getIdleTimeout, getJdbcUrl, getLeakDetectionThreshold, getMaximumPoolSize, getMaxLifetime, getMetricRegistry, getMinimumIdle, getPassword, getPoolName, getThreadFactory, getTransactionIsolation, getUsername, isAutoCommit, isInitializationFailFast, isIsolateInternalQueries, isJdbc4ConnectionTest, isReadOnly, isRegisterMbeans, setAutoCommit, setCatalog, setConnectionCustomizer, setConnectionCustomizerClassName, setConnectionInitSql, setConnectionTestQuery, setConnectionTimeout, setDataSource, setDataSourceClassName, setDataSourceJNDI, setDataSourceProperties, setDriverClassName, setIdleTimeout, setInitializationFailFast, setIsolateInternalQueries, setJdbc4ConnectionTest, setJdbcUrl, setLeakDetectionThreshold, setMaximumPoolSize, setMaxLifetime, setMetricRegistry, setMinimumIdle, setPassword, setPoolName, setReadOnly, setRegisterMbeans, setThreadFactory, setTransactionIsolation, setUsername, 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 java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLogWriter

public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

evictConnection

public void evictConnection(java.sql.Connection connection)

Evict a connection from the pool. Use caution using this method, if you evict the same connection more than one time, the internal pool accounting will become invalid and the pool may stop functioning.

Parameters:

connection - the connection to evict from the pool

close

public void close()

close() and shutdown() are synonymous.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

shutdown

public void shutdown()

Shutdown the DataSource and its associated pool.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object