Packages

  • package root

    edit this text on github Slick logo

    edit this text on github Slick logo

    Scala Language-Integrated Connection Kit

    This is the API documentation for the Slick database library. It should be used as an additional resource to the user manual.

    Further documentation for Slick can be found on the documentation pages.

    To the slick package list...

    Definition Classes
    root
  • package slick
    Definition Classes
    root
  • package ast

    Abstract Syntax Tree (AST) for representing queries during compilation

    Abstract Syntax Tree (AST) for representing queries during compilation

    Definition Classes
    slick
  • package basic

    Contains the abstract BasicProfile, BasicBackend and related code.

    Contains the abstract BasicProfile, BasicBackend and related code.

    Definition Classes
    slick
  • package cats
    Definition Classes
    slick
  • package collection

    HList implementation

    HList implementation

    Definition Classes
    slick
  • package compiler

    Slick AST to database query compiler

    Slick AST to database query compiler

    Definition Classes
    slick
  • package dbio

    The dbio package contains the Database I/O Action implementation.

    The dbio package contains the Database I/O Action implementation. See DBIOAction for details.

    Definition Classes
    slick
  • package jdbc

    Contains the abstract JdbcProfile and related code.

    Contains the abstract JdbcProfile and related code. This includes all JDBC-related code, facilities for Plain SQL queries, and JDBC-specific profile components.

    Definition Classes
    slick
  • package lifted

    Lifted embedding: Stable query api based on implicits and overloading lifting Scala code into Slick ASTs

    Lifted embedding: Stable query api based on implicits and overloading lifting Scala code into Slick ASTs

    Definition Classes
    slick
  • package memory
    Definition Classes
    slick
  • package model

    Slick schema model

    Slick schema model

    Definition Classes
    slick
  • package relational

    Contains the abstract RelationalProfile and related code.

    Contains the abstract RelationalProfile and related code.

    Definition Classes
    slick
  • package sql

    Contains the abstract SqlProfile and related code.

    Contains the abstract SqlProfile and related code.

    Definition Classes
    slick
  • package util

    Helper code for various things.

    Helper code for various things. Tuples, Logging, SQL, ...

    Definition Classes
    slick
  • ControlStatus
  • ControlsConfig
  • Database
  • DatabaseConfig
  • SlickException
  • SlickTreeException

final case class ControlsConfig(maxConnections: Int = 20, queueSize: Int = 1000, maxInflight: Option[Int] = None, inflightAdmissionTimeout: Option[FiniteDuration] = None, connectionAcquireTimeout: Option[FiniteDuration] = None) extends Product with Serializable

Configuration for concurrency controls (connection pool sizing, queue limits, and timeouts).

Use slick.DatabaseConfig#withControls to attach a custom config to any database config:

val config = DatabaseConfig.forConfig[H2Profile]("db")
  .withControls(ControlsConfig(maxConnections = 10, queueSize = 500))
maxConnections

Maximum number of concurrent database connections.

queueSize

Maximum number of actions waiting for a connection slot before being rejected.

maxInflight

Maximum number of actions that may be in-flight at once (i.e. admitted past the queue but not yet holding a connection). Defaults to None, which means 2 * maxConnections. The effective value is always at least maxConnections.

inflightAdmissionTimeout

How long an action may wait to be admitted as in-flight before timing out. None means wait indefinitely.

connectionAcquireTimeout

How long an action may wait to acquire a connection before timing out. None means wait indefinitely.

Source
ControlsConfig.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ControlsConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ControlsConfig(maxConnections: Int = 20, queueSize: Int = 1000, maxInflight: Option[Int] = None, inflightAdmissionTimeout: Option[FiniteDuration] = None, connectionAcquireTimeout: Option[FiniteDuration] = None)

    maxConnections

    Maximum number of concurrent database connections.

    queueSize

    Maximum number of actions waiting for a connection slot before being rejected.

    maxInflight

    Maximum number of actions that may be in-flight at once (i.e. admitted past the queue but not yet holding a connection). Defaults to None, which means 2 * maxConnections. The effective value is always at least maxConnections.

    inflightAdmissionTimeout

    How long an action may wait to be admitted as in-flight before timing out. None means wait indefinitely.

    connectionAcquireTimeout

    How long an action may wait to acquire a connection before timing out. None means wait indefinitely.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (ControlsConfig, B)
    Implicit
    This member is added by an implicit conversion from ControlsConfig toArrowAssoc[ControlsConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. val connectionAcquireTimeout: Option[FiniteDuration]
  8. def ensuring(cond: (ControlsConfig) => Boolean, msg: => Any): ControlsConfig
    Implicit
    This member is added by an implicit conversion from ControlsConfig toEnsuring[ControlsConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ControlsConfig) => Boolean): ControlsConfig
    Implicit
    This member is added by an implicit conversion from ControlsConfig toEnsuring[ControlsConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ControlsConfig
    Implicit
    This member is added by an implicit conversion from ControlsConfig toEnsuring[ControlsConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ControlsConfig
    Implicit
    This member is added by an implicit conversion from ControlsConfig toEnsuring[ControlsConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. val inflightAdmissionTimeout: Option[FiniteDuration]
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val maxConnections: Int
  17. val maxInflight: Option[Int]
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val queueSize: Int
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ControlsConfig toStringFormat[ControlsConfig] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (ControlsConfig, B)
    Implicit
    This member is added by an implicit conversion from ControlsConfig toArrowAssoc[ControlsConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromControlsConfig to StringFormat[ControlsConfig]

Inherited by implicit conversion Ensuring fromControlsConfig to Ensuring[ControlsConfig]

Inherited by implicit conversion ArrowAssoc fromControlsConfig to ArrowAssoc[ControlsConfig]

Ungrouped