A C D E G H I M P R S T U V
All Classes All Packages

## A

addDataSourceProperty(String, Object) - Method in class com.zaxxer.hikari.HikariConfig
  Add a property (name/value pair) that will be used to configure the `DataSource`/`Driver`.
addHealthCheckProperty(String, String) - Method in class com.zaxxer.hikari.HikariConfig
adjudicate(SQLException) - Method in interface com.zaxxer.hikari.SQLExceptionOverride
  If this method returns `SQLExceptionOverride.Override.CONTINUE_EVICT` then Connection eviction will occur, but if it returns `SQLExceptionOverride.Override.DO_NOT_EVICT` the eviction will be elided.

## C

close() - Method in class com.zaxxer.hikari.HikariDataSource
  Shutdown the DataSource and its associated pool.
close() - Method in interface com.zaxxer.hikari.metrics.IMetricsTracker
com.zaxxer.hikari - package com.zaxxer.hikari
com.zaxxer.hikari.metrics - package com.zaxxer.hikari.metrics
CONTINUE_EVICT - com.zaxxer.hikari.SQLExceptionOverride.Override
copyStateTo(HikariConfig) - Method in class com.zaxxer.hikari.HikariConfig
  Copies the state of `this` into `other`.
create(String, PoolStats) - Method in interface com.zaxxer.hikari.metrics.MetricsTrackerFactory
  Create an instance of an IMetricsTracker.

## D

DO_NOT_EVICT - com.zaxxer.hikari.SQLExceptionOverride.Override

## E

evictConnection(Connection) - Method in class com.zaxxer.hikari.HikariDataSource
  Evict a connection from the pool.

## G

getActiveConnections() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Get the number of currently active connections in the pool.
getActiveConnections() - Method in class com.zaxxer.hikari.metrics.PoolStats
getCatalog() - Method in class com.zaxxer.hikari.HikariConfig
  Get the default catalog name to be set on connections.
getCatalog() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Get the default catalog name to be set on connections.
getConnection() - Method in class com.zaxxer.hikari.HikariDataSource
getConnection(String, String) - Method in class com.zaxxer.hikari.HikariDataSource
getConnectionInitSql() - Method in class com.zaxxer.hikari.HikariConfig
  Get the SQL string that will be executed on all new connections when they are created, before they are added to the pool.
getConnectionTestQuery() - Method in class com.zaxxer.hikari.HikariConfig
  Get the SQL query to be executed to test the validity of connections.
getConnectionTimeout() - Method in class com.zaxxer.hikari.HikariConfig
  Get the maximum number of milliseconds that a client will wait for a connection from the pool.
getConnectionTimeout() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Get the maximum number of milliseconds that a client will wait for a connection from the pool.
getDataSource() - Method in class com.zaxxer.hikari.HikariConfig
  Get the `DataSource` that has been explicitly specified to be wrapped by the pool.
getDataSourceClassName() - Method in class com.zaxxer.hikari.HikariConfig
  Get the name of the JDBC `DataSource` class used to create Connections.
getDataSourceJNDI() - Method in class com.zaxxer.hikari.HikariConfig
getDataSourceProperties() - Method in class com.zaxxer.hikari.HikariConfig
getDriverClassName() - Method in class com.zaxxer.hikari.HikariConfig
getExceptionOverrideClassName() - Method in class com.zaxxer.hikari.HikariConfig
  Get the user supplied SQLExceptionOverride class name.
getHealthCheckProperties() - Method in class com.zaxxer.hikari.HikariConfig
getHealthCheckRegistry() - Method in class com.zaxxer.hikari.HikariConfig
  Get the HealthCheckRegistry that will be used for registration of health checks by HikariCP.
getHikariConfigMXBean() - Method in class com.zaxxer.hikari.HikariDataSource
  Get the `HikariConfigMXBean` for this HikariDataSource instance.
getHikariPoolMXBean() - Method in class com.zaxxer.hikari.HikariDataSource
  Get the `HikariPoolMXBean` for this HikariDataSource instance.
getIdleConnections() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Get the number of currently idle connections in the pool.
getIdleConnections() - Method in class com.zaxxer.hikari.metrics.PoolStats
getIdleTimeout() - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
getIdleTimeout() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
getInitializationFailTimeout() - Method in class com.zaxxer.hikari.HikariConfig
  Get the pool initialization failure timeout.
getJdbcUrl() - Method in class com.zaxxer.hikari.HikariConfig
getKeepaliveTime() - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the keepalive interval for a connection in the pool.
getLeakDetectionThreshold() - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
getLeakDetectionThreshold() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
getLoginTimeout() - Method in class com.zaxxer.hikari.HikariDataSource
getLogWriter() - Method in class com.zaxxer.hikari.HikariDataSource
getMaxConnections() - Method in class com.zaxxer.hikari.metrics.PoolStats
getMaximumPoolSize() - Method in class com.zaxxer.hikari.HikariConfig
  The property controls the maximum number of connections that HikariCP will keep in the pool, including both idle and in-use connections.
getMaximumPoolSize() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  The property controls the maximum number of connections that HikariCP will keep in the pool, including both idle and in-use connections.
getMaxLifetime() - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the maximum lifetime of a connection in the pool.
getMaxLifetime() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the maximum lifetime of a connection in the pool.
getMetricRegistry() - Method in class com.zaxxer.hikari.HikariConfig
  Get the MetricRegistry instance to use for registration of metrics used by HikariCP.
getMetricsTrackerFactory() - Method in class com.zaxxer.hikari.HikariConfig
getMinConnections() - Method in class com.zaxxer.hikari.metrics.PoolStats
getMinimumIdle() - Method in class com.zaxxer.hikari.HikariConfig
  The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
getMinimumIdle() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
getObjectInstance(Object, Name, Context, Hashtable<?, ?>) - Method in class com.zaxxer.hikari.HikariJNDIFactory
getParentLogger() - Method in class com.zaxxer.hikari.HikariDataSource
getPassword() - Method in class com.zaxxer.hikari.HikariConfig
  Get the default password to use for DataSource.getConnection(username, password) calls.
getPendingThreads() - Method in class com.zaxxer.hikari.metrics.PoolStats
getPoolName() - Method in class com.zaxxer.hikari.HikariConfig
  The name of the connection pool.
getPoolName() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  The name of the connection pool.
getScheduledExecutor() - Method in class com.zaxxer.hikari.HikariConfig
  Get the ScheduledExecutorService used for housekeeping.
getSchema() - Method in class com.zaxxer.hikari.HikariConfig
  Get the default schema name to be set on connections.
getThreadFactory() - Method in class com.zaxxer.hikari.HikariConfig
  Get the thread factory used to create threads.
getThreadsAwaitingConnection() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Get the number of threads awaiting connections from the pool.
getTotalConnections() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Get the total number of connections currently in the pool.
getTotalConnections() - Method in class com.zaxxer.hikari.metrics.PoolStats
getTransactionIsolation() - Method in class com.zaxxer.hikari.HikariConfig
getUsername() - Method in class com.zaxxer.hikari.HikariConfig
  Get the default username used for DataSource.getConnection(username, password) calls.
getValidationTimeout() - Method in class com.zaxxer.hikari.HikariConfig
  Get the maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
getValidationTimeout() - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Get the maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

## H

HikariConfig - Class in com.zaxxer.hikari
HikariConfig() - Constructor for class com.zaxxer.hikari.HikariConfig
  Default constructor
HikariConfig(String) - Constructor for class com.zaxxer.hikari.HikariConfig
  Construct a HikariConfig from the specified property file name.
HikariConfig(Properties) - Constructor for class com.zaxxer.hikari.HikariConfig
  Construct a HikariConfig from the specified properties object.
HikariConfigMXBean - Interface in com.zaxxer.hikari
  The javax.management MBean for a Hikari pool configuration.
HikariDataSource - Class in com.zaxxer.hikari
  The HikariCP pooled DataSource.
HikariDataSource() - Constructor for class com.zaxxer.hikari.HikariDataSource
  Default constructor.
HikariDataSource(HikariConfig) - Constructor for class com.zaxxer.hikari.HikariDataSource
  Construct a HikariDataSource with the specified configuration.
HikariJNDIFactory - Class in com.zaxxer.hikari
  A JNDI factory that produces HikariDataSource instances.
HikariJNDIFactory() - Constructor for class com.zaxxer.hikari.HikariJNDIFactory
HikariPoolMXBean - Interface in com.zaxxer.hikari
  The javax.management MBean for a Hikari pool instance.

## I

IMetricsTracker - Interface in com.zaxxer.hikari.metrics
isAllowPoolSuspension() - Method in class com.zaxxer.hikari.HikariConfig
  Get the pool suspension behavior (allowed or disallowed).
isAutoCommit() - Method in class com.zaxxer.hikari.HikariConfig
  Get the default auto-commit behavior of connections in the pool.
isClosed() - Method in class com.zaxxer.hikari.HikariDataSource
  Determine whether the HikariDataSource has been closed.
isIsolateInternalQueries() - Method in class com.zaxxer.hikari.HikariConfig
  Determine whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via `Connection.rollback()`.
isReadOnly() - Method in class com.zaxxer.hikari.HikariConfig
  Determine whether the Connections in the pool are in read-only mode.
isRegisterMbeans() - Method in class com.zaxxer.hikari.HikariConfig
  Determine whether HikariCP will self-register `HikariConfigMXBean` and `HikariPoolMXBean` instances in JMX.
isRunning() - Method in class com.zaxxer.hikari.HikariDataSource
  Returns `true` if the pool as been started and is not suspended or shutdown.
isWrapperFor(Class<?>) - Method in class com.zaxxer.hikari.HikariDataSource

## M

MetricsTracker - Class in com.zaxxer.hikari.metrics
  Deprecated.
MetricsTracker() - Constructor for class com.zaxxer.hikari.metrics.MetricsTracker
  Deprecated.
MetricsTrackerFactory - Interface in com.zaxxer.hikari.metrics

## P

PoolStats - Class in com.zaxxer.hikari.metrics
PoolStats(long) - Constructor for class com.zaxxer.hikari.metrics.PoolStats

## R

recordConnectionAcquiredNanos(long) - Method in interface com.zaxxer.hikari.metrics.IMetricsTracker
recordConnectionCreatedMillis(long) - Method in interface com.zaxxer.hikari.metrics.IMetricsTracker
recordConnectionTimeout() - Method in interface com.zaxxer.hikari.metrics.IMetricsTracker
recordConnectionUsageMillis(long) - Method in interface com.zaxxer.hikari.metrics.IMetricsTracker
resumePool() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Resume the pool.

## S

setAllowPoolSuspension(boolean) - Method in class com.zaxxer.hikari.HikariConfig
  Set whether or not pool suspension is allowed.
setAutoCommit(boolean) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default auto-commit behavior of connections in the pool.
setCatalog(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default catalog name to be set on connections.
setCatalog(String) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Set the default catalog name to be set on connections.
setConnectionInitSql(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the SQL string that will be executed on all new connections when they are created, before they are added to the pool.
setConnectionTestQuery(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the SQL query to be executed to test the validity of connections.
setConnectionTimeout(long) - Method in class com.zaxxer.hikari.HikariConfig
  Set the maximum number of milliseconds that a client will wait for a connection from the pool.
setConnectionTimeout(long) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Set the maximum number of milliseconds that a client will wait for a connection from the pool.
setDataSource(DataSource) - Method in class com.zaxxer.hikari.HikariConfig
  Set a `DataSource` for the pool to explicitly wrap.
setDataSourceClassName(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the fully qualified class name of the JDBC `DataSource` that will be used create Connections.
setDataSourceJNDI(String) - Method in class com.zaxxer.hikari.HikariConfig
setDataSourceProperties(Properties) - Method in class com.zaxxer.hikari.HikariConfig
setDriverClassName(String) - Method in class com.zaxxer.hikari.HikariConfig
setExceptionOverrideClassName(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the user supplied SQLExceptionOverride class name.
setHealthCheckProperties(Properties) - Method in class com.zaxxer.hikari.HikariConfig
setHealthCheckRegistry(Object) - Method in class com.zaxxer.hikari.HikariConfig
  Set the HealthCheckRegistry that will be used for registration of health checks by HikariCP.
setHealthCheckRegistry(Object) - Method in class com.zaxxer.hikari.HikariDataSource
  Set the HealthCheckRegistry that will be used for registration of health checks by HikariCP.
setIdleTimeout(long) - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
setIdleTimeout(long) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
setInitializationFailTimeout(long) - Method in class com.zaxxer.hikari.HikariConfig
  Set the pool initialization failure timeout.
setIsolateInternalQueries(boolean) - Method in class com.zaxxer.hikari.HikariConfig
  Configure whether internal pool queries, principally aliveness checks, will be isolated in their own transaction via `Connection.rollback()`.
setJdbcUrl(String) - Method in class com.zaxxer.hikari.HikariConfig
setKeepaliveTime(long) - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the keepalive interval for a connection in the pool.
setLeakDetectionThreshold(long) - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
setLeakDetectionThreshold(long) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
setLoginTimeout(int) - Method in class com.zaxxer.hikari.HikariDataSource
setLogWriter(PrintWriter) - Method in class com.zaxxer.hikari.HikariDataSource
setMaximumPoolSize(int) - Method in class com.zaxxer.hikari.HikariConfig
  The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
setMaximumPoolSize(int) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
setMaxLifetime(long) - Method in class com.zaxxer.hikari.HikariConfig
  This property controls the maximum lifetime of a connection in the pool.
setMaxLifetime(long) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  This property controls the maximum lifetime of a connection in the pool.
setMetricRegistry(Object) - Method in class com.zaxxer.hikari.HikariConfig
  Set a MetricRegistry instance to use for registration of metrics used by HikariCP.
setMetricRegistry(Object) - Method in class com.zaxxer.hikari.HikariDataSource
  Set a MetricRegistry instance to use for registration of metrics used by HikariCP.
setMetricsTrackerFactory(MetricsTrackerFactory) - Method in class com.zaxxer.hikari.HikariConfig
setMetricsTrackerFactory(MetricsTrackerFactory) - Method in class com.zaxxer.hikari.HikariDataSource
setMinimumIdle(int) - Method in class com.zaxxer.hikari.HikariConfig
  The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
setMinimumIdle(int) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
setPassword(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default password to use for DataSource.getConnection(username, password) calls.
setPassword(String) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Set the password used for authentication.
setPoolName(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the name of the connection pool.
setReadOnly(boolean) - Method in class com.zaxxer.hikari.HikariConfig
  Configures the Connections to be added to the pool as read-only Connections.
setRegisterMbeans(boolean) - Method in class com.zaxxer.hikari.HikariConfig
  Configures whether HikariCP self-registers the `HikariConfigMXBean` and `HikariPoolMXBean` in JMX.
setScheduledExecutor(ScheduledExecutorService) - Method in class com.zaxxer.hikari.HikariConfig
  Set the ScheduledExecutorService used for housekeeping.
setSchema(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default schema name to be set on connections.
setThreadFactory(ThreadFactory) - Method in class com.zaxxer.hikari.HikariConfig
  Set the thread factory to be used to create threads.
setTransactionIsolation(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default transaction isolation level.
setUsername(String) - Method in class com.zaxxer.hikari.HikariConfig
  Set the default username used for DataSource.getConnection(username, password) calls.
setUsername(String) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Set the username used for authentication.
setValidationTimeout(long) - Method in class com.zaxxer.hikari.HikariConfig
  Sets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
setValidationTimeout(long) - Method in interface com.zaxxer.hikari.HikariConfigMXBean
  Sets the maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
softEvictConnections() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Evict currently idle connections from the pool, and mark active (in-use) connections for eviction when they are returned to the pool.
SQLExceptionOverride - Interface in com.zaxxer.hikari
  Users can implement this interface to override the default SQLException handling of HikariCP.
SQLExceptionOverride.Override - Enum in com.zaxxer.hikari
suspendPool() - Method in interface com.zaxxer.hikari.HikariPoolMXBean
  Suspend the pool.

## T

toString() - Method in class com.zaxxer.hikari.HikariDataSource

## U

unwrap(Class<T>) - Method in class com.zaxxer.hikari.HikariDataSource

## V

validate() - Method in class com.zaxxer.hikari.HikariConfig
valueOf(String) - Static method in enum com.zaxxer.hikari.SQLExceptionOverride.Override
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.zaxxer.hikari.SQLExceptionOverride.Override
  Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I M P R S T U V
All Classes All Packages