trait BasicDatabaseDef[F[_]] extends AnyDatabaseDef
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:
asyncFcontrols(admission control + connection arbiter)
- Self Type
- Database[F]
- Source
- BasicBackend.scala
- Alphabetic
- By Inheritance
- BasicDatabaseDef
- AnyDatabaseDef
- Closeable
- AutoCloseable
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val actionListener: ActionListener[F]
- implicit abstract val asyncF: Async[F]
- abstract def close(): Unit
Free all resources allocated by Slick for this Database.
Free all resources allocated by Slick for this Database.
Implementations must be idempotent (safe to call more than once) and thread-safe (safe to call concurrently from multiple threads). A second or concurrent call must not throw an exception and must not corrupt the state of any remaining resources.
- Definition Classes
- BasicDatabaseDef → Closeable → AutoCloseable
- abstract val controls: Controls[F]
Concurrency controls for admission and connection-slot arbitration.
- abstract def createSession(): Session
Create a new session.
Create a new session. The session needs to be closed explicitly by calling its close() method.
- Definition Classes
- BasicDatabaseDef → AnyDatabaseDef
- abstract def sessionAsContext(session: Session, state: ExecState): Context
Wrap a Session and ExecState as a Context for passing to SynchronousDatabaseAction.run.
Wrap a Session and ExecState as a Context for passing to SynchronousDatabaseAction.run.
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (BasicDatabaseDef[F], B)
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toArrowAssoc[BasicDatabaseDef[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def admissionControl: AdmissionControl[F]
- Attributes
- protected
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def commitTransaction(session: Session, previousIsolationLevel: Option[Int]): Unit
Commit the transaction on the session, restoring the given isolation level if provided.
Commit the transaction on the session, restoring the given isolation level if provided. Override in JdbcBackend.
- Attributes
- protected
- final def connectionArbiter: ConnectionArbiter[F]
- Attributes
- protected
- final def controlStatus: F[ControlStatus]
- def ensuring(cond: (BasicDatabaseDef[F]) => Boolean, msg: => Any): BasicDatabaseDef[F]
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toEnsuring[BasicDatabaseDef[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (BasicDatabaseDef[F]) => Boolean): BasicDatabaseDef[F]
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toEnsuring[BasicDatabaseDef[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): BasicDatabaseDef[F]
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toEnsuring[BasicDatabaseDef[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): BasicDatabaseDef[F]
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toEnsuring[BasicDatabaseDef[F]] 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()
- def interpret[R](a: DBIOAction[R, NoStream, Nothing], ctx: Ref[F, ExecState]): F[R]
The core recursive interpreter for
DBIOActionvalues.The core recursive interpreter for
DBIOActionvalues.-
SynchronousDatabaseActionsteps run inF.blockingon the CE3 blocking pool. - No explicit stack-level tracking: CE3flatMapis stack-safe. - Execution state (session, transaction depth, pinning) is tracked in aRef[F, ExecState]. - Cancellation triggers rollback viaguaranteeCase.- Attributes
- protected
- def interpretStream[T](a: DBIOAction[_, Streaming[T], Nothing], ctx: Ref[F, ExecState]): F[(CloseableIterator[T], (Option[Throwable]) => F[Unit])]
- Attributes
- protected
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def rollbackTransaction(session: Session, previousIsolationLevel: Option[Int]): Unit
Rollback the transaction on the session, restoring the given isolation level if provided.
Rollback the transaction on the session, restoring the given isolation level if provided. Override in JdbcBackend.
- Attributes
- protected
- final def run[R](a: DBIOAction[R, NoStream, Nothing]): F[R]
Run a DBIOAction and return the result in F[R].
- def setupTransaction(session: Session, isolationLevel: Option[Int]): Option[Int]
Set up a transaction on a freshly-acquired connection.
Set up a transaction on a freshly-acquired connection. Returns the previous isolation level (to be restored after the transaction ends), or None if the isolation level was not changed. Override in JdbcBackend.
- Attributes
- protected
- final def stream[T](a: DBIOAction[_, Streaming[T], Nothing]): Resource[F, Iterator[T]]
Open a streaming DBIOAction as a Resource-backed Iterator.
Open a streaming DBIOAction as a Resource-backed Iterator.
Finalizer order is: 1) iterator.close() 2) transactional / pin-scope cleanup 3) session / permit release 4) inflight-release
- 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 BasicDatabaseDef[F] toStringFormat[BasicDatabaseDef[F]] 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): (BasicDatabaseDef[F], B)
- Implicit
- This member is added by an implicit conversion from BasicDatabaseDef[F] toArrowAssoc[BasicDatabaseDef[F]] 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...