From f91403858b83d6ac4b581db2e251d6a289b4584b Mon Sep 17 00:00:00 2001 From: Brett Wooldridge Date: Mon, 25 Jan 2021 00:32:20 +0900 Subject: [PATCH] Update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dbbc7fd..1f5df6d2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ _Java 8 thru 11 maven artifact:_ com.zaxxer HikariCP - 3.4.5 + 4.0.0 ``` _Java 7 maven artifact (*maintenance mode*):_ @@ -167,6 +167,18 @@ of 0 means that idle connections are never removed from the pool. The minimum a (10 seconds). *Default: 600000 (10 minutes)* +⌚``keepaliveTime``
+This property controls how frequently HikariCP will attempt to keep a connection alive, in order to prevent +it from being timed out by the database or network infrastructure. This value must be less than the +`maxLifetime` value. A "keepalive" will only occur on idle connections, and never against in-use +connections. When the time arrives for a "keepalive" against a given connection, that connection will be +removed from the pool, "pinged", and then returned to the pool. The 'ping' is one of either invocation of +the JDBC4 `isValid()` method, or execution of the `connectionTestQuery`. Typically, the duration out-of-the-pool +should be measured in single digit milliseconds or even sub-milliseconds, and therefore should have little +or no noticible performance impact. The minimum allowed value is 30000ms (30 seconds), but a value in the +range of minutes is most desirable. +*Default: 0 (disabled)* + ⌚``maxLifetime``
This property controls the maximum lifetime of a connection in the pool. An in-use connection will never be retired, only when it is closed will it then be removed. On a connection-by-connection