HikariCpPlugin (jfinal-activerecord 3.7.0.v20201010-RELEASE API)

java.lang.Object
- org.tio.jfinal.plugin.hikaricp.HikariCpPlugin

所有已实现的接口:

IDataSourceProvider, IPlugin
```
public class HikariCpPlugin
extends Object
implements IPlugin, IDataSourceProvider
```
Fast, simple, reliable. HikariCP is a "zero-overhead" production ready JDBC connection pool. At roughly 130Kb, the library is very light

构造器概要

构造器
构造器和说明
`HikariCpPlugin(String jdbcUrl, String username, String password)`
`HikariCpPlugin(String jdbcUrl, String username, String password, String driverClass)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DataSource`	`getDataSource()`
`void`	`setAutoCommit(boolean autoCommit)` 是否自动提交
`void`	`setCatalog(String catalog)` 支持 catalog 概念的数据库可以设定该参数
`void`	`setConnectionInitSql(String connectionInitSql)` 新连接生成后，添加到连接池前执行的初始化sql
`void`	`setConnectionTestQuery(String connectionTestQuery)` JDBC4以下版本数据库驱动需要设定此参数
`void`	`setConnectionTimeout(long connectionTimeoutMs)`
`void`	`setDriverClass(String driverClass)` 驱动类名
`void`	`setIdleTimeout(long idleTimeoutMs)` 空闲超时时间(单位：毫秒)，默认600000 (10 分钟)
`void`	`setJdbcUrl(String jdbcUrl)` jdbc连接url
`void`	`setLeakDetectionThreshold(long leakDetectionThresholdMs)` 内存泄露侦测周期，最小为2000（2秒）
`void`	`setMaximumPoolSize(int maximumPoolSize)` 连接池最大连接数默认10
`void`	`setMaxLifetime(long maxLifetimeMs)` 最大生命周期/最大存活时间(单位：毫秒) ，默认1800000 (30 分钟)
`void`	`setPassword(String password)` 数据库密码
`void`	`setPoolName(String poolName)` 用户指定的连接池名
`void`	`setReadOnly(boolean readOnly)` 是否是只读连接，是否有效取决于相应的数据库是否支持
`void`	`setTransactionIsolation(String isolationLevel)` 事物等级
`void`	`setUsername(String username)` 数据库类型
`void`	`setValidationTimeout(long validationTimeoutMs)` 连接是否存活测试周期，默认5000（5秒）
`boolean`	`start()`
`boolean`	`stop()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - HikariCpPlugin
```
public HikariCpPlugin(String jdbcUrl,
                      String username,
                      String password)
```
  - HikariCpPlugin
```
public HikariCpPlugin(String jdbcUrl,
                      String username,
                      String password,
                      String driverClass)
```
- 方法详细资料
  - getDataSource
```
public DataSource getDataSource()
```
    指定者:
    
    getDataSource 在接口中 IDataSourceProvider
  - start
```
public boolean start()
```
    指定者:
    
    start 在接口中 IPlugin
  - stop
```
public boolean stop()
```
    指定者:
    
    stop 在接口中 IPlugin
  - setDriverClass
```
public final void setDriverClass(String driverClass)
```
    驱动类名
    
    参数:
    
    driverClass -
    
    从以下版本开始:
    
    V1.0.0
  - setUsername
```
public final void setUsername(String username)
```
    数据库类型
    
    参数:
    
    username -
    
    从以下版本开始:
    
    V1.0.0
  - setPassword
```
public final void setPassword(String password)
```
    数据库密码
    
    参数:
    
    password -
    
    从以下版本开始:
    
    V1.0.0
  - setAutoCommit
```
public final void setAutoCommit(boolean autoCommit)
```
    是否自动提交
    
    参数:
    
    autoCommit -
    
    从以下版本开始:
    
    V1.0.0
  - setReadOnly
```
public final void setReadOnly(boolean readOnly)
```
    是否是只读连接，是否有效取决于相应的数据库是否支持
    
    参数:
    
    readOnly -
    
    从以下版本开始:
    
    V1.0.0
  - setConnectionTimeout
```
public final void setConnectionTimeout(long connectionTimeoutMs)
```
    参数:
    
    connectionTimeoutMs - 连接超时时间(单位：毫秒)
    
    从以下版本开始:
    
    V1.0.0
  - setIdleTimeout
```
public final void setIdleTimeout(long idleTimeoutMs)
```
    空闲超时时间(单位：毫秒)，默认600000 (10 分钟)
    
    参数:
    
    idleTimeoutMs -
    
    从以下版本开始:
    
    V1.0.0
  - setMaxLifetime
```
public final void setMaxLifetime(long maxLifetimeMs)
```
    最大生命周期/最大存活时间(单位：毫秒) ，默认1800000 (30 分钟)
    
    参数:
    
    maxLifetime -
    
    从以下版本开始:
    
    V1.0.0
  - setMaximumPoolSize
```
public final void setMaximumPoolSize(int maximumPoolSize)
```
    连接池最大连接数默认10
    
    参数:
    
    maximumPoolSize -
    
    从以下版本开始:
    
    V1.0.0
  - setPoolName
```
public final void setPoolName(String poolName)
```
    用户指定的连接池名
    
    参数:
    
    poolName -
    
    从以下版本开始:
    
    V1.0.0
  - setConnectionInitSql
```
public final void setConnectionInitSql(String connectionInitSql)
```
    新连接生成后，添加到连接池前执行的初始化sql
    
    参数:
    
    connectionInitSql -
    
    从以下版本开始:
    
    V1.0.0
  - setConnectionTestQuery
```
public final void setConnectionTestQuery(String connectionTestQuery)
```
    JDBC4以下版本数据库驱动需要设定此参数
    
    参数:
    
    connectionTestQuery - 连接时测试sql
    
    从以下版本开始:
    
    V1.0.0
  - setJdbcUrl
```
public final void setJdbcUrl(String jdbcUrl)
```
    jdbc连接url
    
    参数:
    
    jdbcUrl -
  - setCatalog
```
public final void setCatalog(String catalog)
```
    支持 catalog 概念的数据库可以设定该参数
    
    参数:
    
    catalog -
  - setTransactionIsolation
```
public final void setTransactionIsolation(String isolationLevel)
```
    事物等级
    
    参数:
    
    isolationLevel -
  - setValidationTimeout
```
public final void setValidationTimeout(long validationTimeoutMs)
```
    连接是否存活测试周期，默认5000（5秒）
    
    参数:
    
    validationTimeoutMs -
  - setLeakDetectionThreshold
```
public final void setLeakDetectionThreshold(long leakDetectionThresholdMs)
```
    内存泄露侦测周期，最小为2000（2秒）
    
    参数:
    
    leakDetectionThresholdMs -

类 HikariCpPlugin

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

HikariCpPlugin

HikariCpPlugin

方法详细资料

getDataSource

start

stop

setDriverClass

setUsername

setPassword

setAutoCommit

setReadOnly

setConnectionTimeout

setIdleTimeout

setMaxLifetime

setMaximumPoolSize

setPoolName

setConnectionInitSql

setConnectionTestQuery

setJdbcUrl

setCatalog

setTransactionIsolation

setValidationTimeout

setLeakDetectionThreshold