doobie.hikari.Config.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of foobie-hikari_3 Show documentation
hikari
There is a newer version: 0.15.0
// Copyright (c) 2013-2020 Rob Norris and Contributors
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT

package doobie.hikari

import cats.effect.kernel.Sync
import cats.syntax.show.*
import com.zaxxer.hikari.HikariConfig
import com.zaxxer.hikari.metrics.MetricsTrackerFactory
import doobie.enumerated.TransactionIsolation

import java.util.Properties
import java.util.concurrent.ScheduledExecutorService
import java.util.concurrent.ThreadFactory
import java.util.concurrent.TimeUnit
import javax.sql.DataSource
import scala.concurrent.duration.Duration

/**
 * Configuration case class, susceptible to PureConfig. Helps with creating
 * `com.zaxxer.hikari.HikariConfig`, which in turn is used to create
 * `doobie.hikari.HikariTransactor`. See the method
 * `HikariTransactor.fromConfigAutoEc`
 */
final case class Config(
  jdbcUrl: String,
  catalog: Option[String] = None,
  connectionTimeout: Duration = Duration(30, TimeUnit.SECONDS),
  idleTimeout: Duration = Duration(10, TimeUnit.MINUTES),
  leakDetectionThreshold: Duration = Duration.Zero,
  maximumPoolSize: Int = 10,
  maxLifetime: Duration = Duration(30, TimeUnit.MINUTES),
  minimumIdle: Int = 10,
  password: Option[String] = None,
  poolName: Option[String] = None,
  username: Option[String] = None,
  validationTimeout: Duration = Duration(5, TimeUnit.SECONDS),
  allowPoolSuspension: Boolean = false,
  autoCommit: Boolean = true,
  connectionInitSql: Option[String] = None,
  connectionTestQuery: Option[String] = None,
  dataSourceClassName: Option[String] = None,
  dataSourceJNDI: Option[String] = None,
  driverClassName: Option[String] = None,
  initializationFailTimeout: Duration = Duration(1, TimeUnit.MILLISECONDS),
  isolateInternalQueries: Boolean = false,
  readOnly: Boolean = false,
  registerMbeans: Boolean = false,
  schema: Option[String] = None,
  transactionIsolation: Option[TransactionIsolation] = None,
)

object Config {
  def makeHikariConfig[F[_]](
    config: Config,
    dataSource: Option[DataSource] = None,
    dataSourceProperties: Option[Properties] = None,
    healthCheckProperties: Option[Properties] = None,
    healthCheckRegistry: Option[Object] = None,
    metricRegistry: Option[Object] = None,
    metricsTrackerFactory: Option[MetricsTrackerFactory] = None,
    scheduledExecutor: Option[ScheduledExecutorService] = None,
    threadFactory: Option[ThreadFactory] = None,
  )(implicit F: Sync[F]): F[HikariConfig] =
    F.delay {
      val c = new HikariConfig()

      c.setJdbcUrl(config.jdbcUrl)

      config.catalog.foreach(c.setCatalog)
      c.setConnectionTimeout(config.connectionTimeout.toMillis)
      c.setIdleTimeout(config.idleTimeout.toMillis)
      c.setLeakDetectionThreshold(config.leakDetectionThreshold.toMillis)
      c.setMaximumPoolSize(config.maximumPoolSize)
      c.setMaxLifetime(config.maxLifetime.toMillis)
      c.setMinimumIdle(config.minimumIdle)
      config.password.foreach(c.setPassword)
      config.poolName.foreach(c.setPoolName)
      config.username.foreach(c.setUsername)
      c.setValidationTimeout(config.validationTimeout.toMillis)

      c.setAllowPoolSuspension(config.allowPoolSuspension)
      c.setAutoCommit(config.autoCommit)
      config.connectionInitSql.foreach(c.setConnectionInitSql)
      config.connectionTestQuery.foreach(c.setConnectionTestQuery)
      config.dataSourceClassName.foreach(c.setDataSourceClassName)
      config.dataSourceJNDI.foreach(c.setDataSourceJNDI)
      config.driverClassName.foreach(c.setDriverClassName)
      c.setInitializationFailTimeout(config.initializationFailTimeout.toMillis)
      c.setIsolateInternalQueries(config.isolateInternalQueries)
      c.setReadOnly(config.readOnly)
      c.setRegisterMbeans(config.registerMbeans)
      config.schema.foreach(c.setSchema)
      config.transactionIsolation.map(_.show).foreach(c.setTransactionIsolation)

      dataSource.foreach(c.setDataSource)
      dataSourceProperties.foreach(c.setDataSourceProperties)
      healthCheckProperties.foreach(c.setHealthCheckProperties)
      healthCheckRegistry.foreach(c.setHealthCheckRegistry)
      metricRegistry.foreach(c.setMetricRegistry)
      metricsTrackerFactory.foreach(c.setMetricsTrackerFactory)
      scheduledExecutor.foreach(c.setScheduledExecutor)
      threadFactory.foreach(c.setThreadFactory)

      c
    }

}