Packages

trait JdbcBackend extends RelationalBackend

A JDBC-based database back-end that is used by slick.jdbc.JdbcProfile.

Source
JdbcBackend.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JdbcBackend
  2. RelationalBackend
  3. BasicBackend
  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

Type Members

  1. 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
  2. trait BasicActionContext extends AnyRef

    The context object passed to SynchronousDatabaseAction instances by the execution engine.

    The context object passed to SynchronousDatabaseAction instances 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
  3. 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). All run and stream calls on a given database instance use the same effect type.

    Concrete subclasses supply:

    • asyncF
    • controls (admission control + connection arbiter)
    Definition Classes
    BasicBackend
  4. 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
  5. 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.run execution state carried through the interpreter via a CE3 Ref.

    Per-db.run execution state carried through the interpreter via a CE3 Ref.

    session is typed as Option[AnyRef] rather than Option[Session] to avoid path-dependent type issues with the abstract Session type member in Scala 2.13. Callers cast to Session as needed.

    sessionRelease holds the finalizer produced by Resource.allocated for 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
  6. class BaseSession[F[_]] extends JdbcSessionDef
  7. type Context = JdbcActionContext

    The type of the context used for running SynchronousDatabaseActions

    The type of the context used for running SynchronousDatabaseActions

    Definition Classes
    JdbcBackendBasicBackend
  8. 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
    JdbcBackendBasicBackend
  9. 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.

  10. trait JdbcActionContext extends BasicActionContext
  11. 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 via DatabaseConfig.forConfig[IO](...) etc. — this returns a Resource[IO, Database[IO]] that manages connection pool lifecycle.

  12. trait JdbcSessionDef extends BasicSessionDef
  13. type Session = JdbcSessionDef

    The type of session objects used by this backend.

    The type of session objects used by this backend.

    Definition Classes
    JdbcBackendBasicBackend

Value Members

  1. object ExecState extends Serializable
    Definition Classes
    BasicBackend
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. lazy val actionLogger: SlickLogger
    Attributes
    protected
    Definition Classes
    BasicBackend
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val backend: JdbcBackend
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. final def defaultActionLogger[F[_]]: ActionListener[F]
    Attributes
    protected
    Definition Classes
    BasicBackend
  11. 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
  12. 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
  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def logAction(a: DBIOAction[_, NoStream, Nothing]): Unit
    Attributes
    protected[this]
    Definition Classes
    BasicBackend
  21. def makeDatabase[F[_]](config: JdbcDatabaseConfig[_])(implicit arg0: Async[F]): F[Database[F]]
  22. def makeDatabase[F[_]](config: JdbcDatabaseConfig[_], actionListener: ActionListener[F])(implicit arg0: Async[F]): F[Database[F]]
  23. 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
    JdbcBackendBasicBackend
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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 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 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): (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.

Inherited from RelationalBackend

Inherited from BasicBackend

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromJdbcBackend to StringFormat[JdbcBackend]

Inherited by implicit conversion Ensuring fromJdbcBackend to Ensuring[JdbcBackend]

Inherited by implicit conversion ArrowAssoc fromJdbcBackend to ArrowAssoc[JdbcBackend]

Ungrouped