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
t

slick

Database

trait Database[F[_], S[_]] extends Closeable

Effect-polymorphic database API.

F[_] is the effect type used for non-streaming execution (for example cats.effect.IO or scala.concurrent.Future), and S[_] is the stream type used for streaming results.

Concrete wrappers (for example slick.cats.Database, slick.future.Database, slick.zio.Database) delegate to an underlying Slick backend database and adapt it into their effect/stream abstractions.

Source
Database.scala
Linear Supertypes
Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
Database
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Database
  2. Closeable
  3. AutoCloseable
  4. AnyRef
  5. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Unit

    Free all resources allocated for this database instance.

    Free all resources allocated for this database instance.

    Implementations must be idempotent (safe to call more than once) and thread-safe, as required by the java.io.Closeable contract.

    Definition Classes
    Database → Closeable → AutoCloseable
  2. abstract def controlStatus: F[ControlStatus]

    Inspect current admission and connection-slot control status.

  3. abstract def run[R](a: DBIOAction[R, NoStream, Nothing]): F[R]

    Run a DBIOAction and return its result in F[R].

  4. abstract def stream[T](a: DBIOAction[_, Streaming[T], Nothing]): S[T]

    Open a streaming DBIOAction as S[T].

    Open a streaming DBIOAction as S[T].

    Resource acquisition and release semantics are defined by the concrete wrapper implementation, but must ensure backend resources are released when the stream completes, fails, or is canceled.

Concrete 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): (Database[F, S], B)
    Implicit
    This member is added by an implicit conversion from Database[F, S] toArrowAssoc[Database[F, S]] 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. def ensuring(cond: (Database[F, S]) => Boolean, msg: => Any): Database[F, S]
    Implicit
    This member is added by an implicit conversion from Database[F, S] toEnsuring[Database[F, S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Database[F, S]) => Boolean): Database[F, S]
    Implicit
    This member is added by an implicit conversion from Database[F, S] toEnsuring[Database[F, S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): Database[F, S]
    Implicit
    This member is added by an implicit conversion from Database[F, S] toEnsuring[Database[F, S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Database[F, S]
    Implicit
    This member is added by an implicit conversion from Database[F, S] toEnsuring[Database[F, S]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. 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 Database[F, S] toStringFormat[Database[F, S]] 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): (Database[F, S], B)
    Implicit
    This member is added by an implicit conversion from Database[F, S] toArrowAssoc[Database[F, S]] 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 Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromDatabase[F, S] to StringFormat[Database[F, S]]

Inherited by implicit conversion Ensuring fromDatabase[F, S] to Ensuring[Database[F, S]]

Inherited by implicit conversion ArrowAssoc fromDatabase[F, S] to ArrowAssoc[Database[F, S]]

Ungrouped