scalikejdbc.GlobalSettings.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalikejdbc-core_2.12 Show documentation

scalikejdbc-core

There is a newer version: 4.3.2

Show newest version

package scalikejdbc

/**
 * GlobalSettings for this library
 */
object GlobalSettings {

  /**
   * Disables specifying readOnly/autoCommit explicitly to be compatible with JTA DataSource.
   */
  var jtaDataSourceCompatible: Boolean = false

  /**
   * Driver names to choose column name for auto-generated key retrieval.
   */
  var driverNamesToChooseColumnNameForAutoGeneratedKeyRetrieval
    : collection.Seq[String] = Seq("oracle.jdbc.driver.OracleDriver")

  /**
   * Enables error logging for all SQL errors.
   */
  var loggingSQLErrors: Boolean = true

  /**
   * Enables logging for connection handling.
   */
  var loggingConnections: Boolean = true

  /**
   * Settings for query timing logs.
   */
  var loggingSQLAndTime: LoggingSQLAndTimeSettings = LoggingSQLAndTimeSettings()

  /**
   * Settings on SQL formatter which is used in query timing logs.
   */
  var sqlFormatter: SQLFormatterSettings = SQLFormatterSettings()

  /**
   * Settings on string-style param binding validator.
   */
  var nameBindingSQLValidator: NameBindingSQLValidatorSettings =
    NameBindingSQLValidatorSettings()

  type QueryCompletionListener = (String, collection.Seq[Any], Long) => Unit

  /**
   * Event handler to be called every query completion.
   */
  var queryCompletionListener: QueryCompletionListener =
    (statement: String, params: collection.Seq[Any], millis: Long) => ()

  type QueryFailureListener = (String, collection.Seq[Any], Throwable) => Unit

  /**
   * Event handler to be called every query failure.
   */
  var queryFailureListener: QueryFailureListener =
    (statement: String, params: collection.Seq[Any], e: Throwable) => ()

  type TaggedQueryCompletionListener =
    (String, collection.Seq[Any], Long, collection.Seq[String]) => Unit

  /**
   * Event handler to be called every query completion when specifying tags.
   */
  var taggedQueryCompletionListener: TaggedQueryCompletionListener = {
    (
      statement: String,
      params: collection.Seq[Any],
      millis: Long,
      tags: collection.Seq[String]
    ) => ()
  }

  type TaggedQueryFailureListener =
    (String, collection.Seq[Any], Throwable, collection.Seq[String]) => Unit

  /**
   * Event handler to be called every query failure when specifying tags.
   */
  var taggedQueryFailureListener: TaggedQueryFailureListener = {
    (
      statement: String,
      params: collection.Seq[Any],
      e: Throwable,
      tags: collection.Seq[String]
    ) => ()
  }

}