trait JdbcBackend extends RelationalBackend
A JDBC-based database back-end that is used by slick.jdbc.JdbcProfile.
- Source
- JdbcBackend.scala
- Alphabetic
- By Inheritance
- JdbcBackend
- RelationalBackend
- BasicBackend
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- trait AnyDatabaseDef extends Closeable
Non-parameterized marker trait for any database instance, regardless of effect type.
Non-parameterized marker trait for any database instance, regardless of effect type. Use this type when you need to refer to "any database" without knowing the effect type.
- Definition Classes
- BasicBackend
- trait BasicActionContext extends AnyRef
The context object passed to
SynchronousDatabaseActioninstances by the execution engine.The context object passed to
SynchronousDatabaseActioninstances by the execution engine. The heavy concurrency state lives in ExecState /Ref; this is a thin wrapper that gives SDAs access to the session and statement parameters.- Definition Classes
- BasicBackend
- trait BasicDatabaseDef[F[_]] extends AnyDatabaseDef
A database instance to which connections can be created.
A database instance to which connections can be created.
F[_]is the effect type (e.g.cats.effect.IO). Allrunandstreamcalls on a given database instance use the same effect type.Concrete subclasses supply:
asyncFcontrols(admission control + connection arbiter)
- Definition Classes
- BasicBackend
- trait BasicSessionDef extends Closeable
A logical session of a
Database.A logical session of a
Database. The underlying database connection is created lazily on demand.- Definition Classes
- BasicBackend
- case class ExecState(ordinal: Long, session: Option[AnyRef], sessionRelease: Option[AnyRef], transactionDepth: Int, isolationLevel: Option[Int], previousIsolationLevel: Option[Int], pinnedDepth: Int) extends Product with Serializable
Per-
db.runexecution state carried through the interpreter via a CE3Ref.Per-
db.runexecution state carried through the interpreter via a CE3Ref.sessionis typed asOption[AnyRef]rather thanOption[Session]to avoid path-dependent type issues with the abstractSessiontype member in Scala 2.13. Callers cast toSessionas needed.sessionReleaseholds the finalizer produced byResource.allocatedfor the currently-open session + semaphore permit pair. It is set when a session is first acquired and cleared (and run) when the session is released.- Definition Classes
- BasicBackend
- class BaseSession[F[_]] extends JdbcSessionDef
- type Context = JdbcActionContext
The type of the context used for running SynchronousDatabaseActions
The type of the context used for running SynchronousDatabaseActions
- Definition Classes
- JdbcBackend → BasicBackend
- type Database[F[_]] = JdbcDatabaseDef[F]
The type of database objects used by this backend, parameterized by effect type.
The type of database objects used by this backend, parameterized by effect type.
- Definition Classes
- JdbcBackend → BasicBackend
- class DatabaseCapabilities extends AnyRef
Describes capabilities of the database which can be determined from a DatabaseMetaData object and then cached and reused for all sessions.
- trait JdbcActionContext extends BasicActionContext
- abstract class JdbcDatabaseDef[F[_]] extends BasicDatabaseDef[F]
A JDBC database connected to a given DataSource.
A JDBC database connected to a given DataSource.
F[_]is the effect type (e.g.cats.effect.IO). Construct viaDatabaseConfig.forConfig[IO](...)etc. — this returns aResource[IO, Database[IO]]that manages connection pool lifecycle. - trait JdbcSessionDef extends BasicSessionDef
- type Session = JdbcSessionDef
The type of session objects used by this backend.
The type of session objects used by this backend.
- Definition Classes
- JdbcBackend → BasicBackend
Value Members
- object ExecState extends Serializable
- Definition Classes
- BasicBackend
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (JdbcBackend, B)
- Implicit
- This member is added by an implicit conversion from JdbcBackend toArrowAssoc[JdbcBackend] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- lazy val actionLogger: SlickLogger
- Attributes
- protected
- Definition Classes
- BasicBackend
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val backend: JdbcBackend
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def defaultActionLogger[F[_]]: ActionListener[F]
- Attributes
- protected
- Definition Classes
- BasicBackend
- def ensuring(cond: (JdbcBackend) => Boolean, msg: => Any): JdbcBackend
- Implicit
- This member is added by an implicit conversion from JdbcBackend toEnsuring[JdbcBackend] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (JdbcBackend) => Boolean): JdbcBackend
- Implicit
- This member is added by an implicit conversion from JdbcBackend toEnsuring[JdbcBackend] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): JdbcBackend
- Implicit
- This member is added by an implicit conversion from JdbcBackend toEnsuring[JdbcBackend] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): JdbcBackend
- Implicit
- This member is added by an implicit conversion from JdbcBackend toEnsuring[JdbcBackend] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logAction(a: DBIOAction[_, NoStream, Nothing]): Unit
- Attributes
- protected[this]
- Definition Classes
- BasicBackend
- def makeDatabase[F[_]](config: JdbcDatabaseConfig[_])(implicit arg0: Async[F]): F[Database[F]]
- def makeDatabase[F[_]](config: JdbcDatabaseConfig[_], actionListener: ActionListener[F])(implicit arg0: Async[F]): F[Database[F]]
- def makeDatabase[F[_]](config: BasicDatabaseConfig[_], actionListener: ActionListener[F] = defaultActionLogger[F])(implicit arg0: Async[F]): F[Database[F]]
Create a Database instance from a slick.basic.BasicDatabaseConfig.
Create a Database instance from a slick.basic.BasicDatabaseConfig.
- Definition Classes
- JdbcBackend → BasicBackend
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from JdbcBackend toStringFormat[JdbcBackend] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (JdbcBackend, B)
- Implicit
- This member is added by an implicit conversion from JdbcBackend toArrowAssoc[JdbcBackend] 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.

edit this text on github
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...