Packages

c

zio.sql

HikariConnectionPoolConfig

final case class HikariConnectionPoolConfig(url: String, userName: String, password: String, poolSize: Int = 10, autoCommit: Boolean = true, connectionTimeout: Option[Long] = None, idleTimeout: Option[Long] = None, initializationFailTimeout: Option[Long] = None, maxLifetime: Option[Long] = None, minimumIdle: Option[Int] = None, connectionInitSql: Option[String] = None) extends Product with Serializable

Configuration information for the connection pool.

url

The JDBC connection string.

poolSize

The size of the pool.

connectionTimeout

Maximum number of milliseconds that a client will wait for a connection from the pool. If this time is exceeded without a connection becoming available, a SQLException will be thrown from javax.sql.DataSource.getConnection().

idleTimeout

This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 means that idle connections are never removed from the pool.

initializationFailTimeout

the number of milliseconds before the pool initialization fails, or 0 to validate connection setup but continue with pool start, or less than zero to skip all initialization checks and start the pool without delay.

maxLifetime

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. Should be bigger then 30000

minimumIdle

The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. If the idle connections dip below this value, HikariCP will make a best effort to restore them quickly and efficiently.

connectionInitSql

the SQL to execute on new connections Set the SQL string that will be executed on all new connections when they are created, before they are added to the pool. If this query fails, it will be treated as a failed connection attempt.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HikariConnectionPoolConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HikariConnectionPoolConfig(url: String, userName: String, password: String, poolSize: Int = 10, autoCommit: Boolean = true, connectionTimeout: Option[Long] = None, idleTimeout: Option[Long] = None, initializationFailTimeout: Option[Long] = None, maxLifetime: Option[Long] = None, minimumIdle: Option[Int] = None, connectionInitSql: Option[String] = None)

    url

    The JDBC connection string.

    poolSize

    The size of the pool.

    connectionTimeout

    Maximum number of milliseconds that a client will wait for a connection from the pool. If this time is exceeded without a connection becoming available, a SQLException will be thrown from javax.sql.DataSource.getConnection().

    idleTimeout

    This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 means that idle connections are never removed from the pool.

    initializationFailTimeout

    the number of milliseconds before the pool initialization fails, or 0 to validate connection setup but continue with pool start, or less than zero to skip all initialization checks and start the pool without delay.

    maxLifetime

    This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. Should be bigger then 30000

    minimumIdle

    The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. If the idle connections dip below this value, HikariCP will make a best effort to restore them quickly and efficiently.

    connectionInitSql

    the SQL to execute on new connections Set the SQL string that will be executed on all new connections when they are created, before they are added to the pool. If this query fails, it will be treated as a failed connection attempt.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val autoCommit: Boolean
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. val connectionInitSql: Option[String]
  8. val connectionTimeout: Option[Long]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. val idleTimeout: Option[Long]
  13. val initializationFailTimeout: Option[Long]
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val maxLifetime: Option[Long]
  16. val minimumIdle: Option[Int]
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val password: String
  21. val poolSize: Int
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. val url: String
  24. val userName: String
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped