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.  trait AnyHeapDatabaseDef extends AnyDatabaseDef

   Non-parameterized base for HeapDatabaseDef, providing table management operations that do not depend on the effect type F.

   Non-parameterized base for HeapDatabaseDef, providing table management operations that do not depend on the effect type F. Used by HeapSessionDef.

7.  type Context = BasicActionContext

   The type of the context used for running SynchronousDatabaseActions

   The type of the context used for running SynchronousDatabaseActions

   Definition Classes

   HeapBackend → BasicBackend

8.  type Database[F[_]] = HeapDatabaseDef[F]

   Definition Classes

   HeapBackend → BasicBackend

9.  type DatabaseFactory = HeapDatabaseFactoryDef
10.  class HeapDatabaseDef[F[_]] extends BasicDatabaseDef[F] with AnyHeapDatabaseDef
11.  class HeapDatabaseFactoryDef extends AnyRef
12.  class HeapSessionDef extends BasicSessionDef
13.  class HeapTable extends AnyRef
14.  type Row = IndexedSeq[Any]
15.  type Session = HeapSessionDef

    The type of session objects used by this backend.

    The type of session objects used by this backend.

    Definition Classes

    HeapBackend → BasicBackend

16.  trait Verifier extends AnyRef

    A Verifier is called before and after data is updated in a table.

    A Verifier is called before and after data is updated in a table. It ensures that no constraints are violated before the update and updates the indices afterwards.