Packages

t

slick.relational

RelationalBackend

trait RelationalBackend extends BasicBackend

The required backend level for RelationalProfile.

Source
RelationalBackend.scala
Linear Supertypes
BasicBackend, AnyRef, Any
Known Subclasses
JdbcBackend, JdbcBackend, DistributedBackend, DistributedBackend, HeapBackend, HeapBackend
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RelationalBackend
  2. BasicBackend
  3. AnyRef
  4. 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. abstract type Context >: Null <: BasicActionContext

    The type of the context used for running SynchronousDatabaseActions

    The type of the context used for running SynchronousDatabaseActions

    Definition Classes
    BasicBackend
  7. abstract type Database[F[_]] >: Null <: BasicDatabaseDef[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
    BasicBackend
  8. abstract type Session >: Null <: BasicSessionDef

    The type of session objects used by this backend.

    The type of session objects used by this backend.

    Definition Classes
    BasicBackend

Abstract Value Members

  1. abstract 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
    BasicBackend

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromRelationalBackend to StringFormat[RelationalBackend]

Inherited by implicit conversion Ensuring fromRelationalBackend to Ensuring[RelationalBackend]

Inherited by implicit conversion ArrowAssoc fromRelationalBackend to ArrowAssoc[RelationalBackend]

Ungrouped