Packages

trait Database extends slick.Database[IO, StreamIO]

Cats Effect / fs2 facade for Slick's effect-polymorphic database API.

Source
Database.scala
Linear Supertypes
slick.Database[IO, StreamIO], Closeable, AutoCloseable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Database
  2. Database
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Unit

    Free all resources allocated for this database instance.

    Free all resources allocated for this database instance.

    Implementations must be idempotent (safe to call more than once) and thread-safe, as required by the java.io.Closeable contract.

    Definition Classes
    Database → Closeable → AutoCloseable
  2. abstract def controlStatus: IO[ControlStatus]

    Inspect current admission and connection-slot control status.

    Inspect current admission and connection-slot control status.

    Definition Classes
    Database
  3. abstract def run[R](a: DBIOAction[R, NoStream, Nothing]): IO[R]

    Run a non-streaming action as IO[R].

    Run a non-streaming action as IO[R].

    The returned IO is lazy: the underlying DBIOAction starts when the IO is run, not when it is created.

    If the same IO value is run multiple times, each run performs a fresh, independent execution of the action.

    Definition Classes
    Database → Database
  4. abstract def stream[T](a: DBIOAction[_, Streaming[T], Nothing]): Stream[IO, T]

    Open a streaming action as an fs2.Stream[IO, T].

    Open a streaming action as an fs2.Stream[IO, T].

    The returned stream is lazy: the underlying DBIOAction starts when the stream is consumed, not when it is created.

    If the same stream value is consumed multiple times, each consumption performs a fresh, independent execution of the action.

    Definition Classes
    Database → Database

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Database, B)
    Implicit
    This member is added by an implicit conversion from Database toArrowAssoc[Database] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def ensuring(cond: (Database) => Boolean, msg: => Any): Database
    Implicit
    This member is added by an implicit conversion from Database toEnsuring[Database] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Database) => Boolean): Database
    Implicit
    This member is added by an implicit conversion from Database toEnsuring[Database] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): Database
    Implicit
    This member is added by an implicit conversion from Database toEnsuring[Database] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Database
    Implicit
    This member is added by an implicit conversion from Database toEnsuring[Database] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. 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 Database toStringFormat[Database] 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): (Database, B)
    Implicit
    This member is added by an implicit conversion from Database toArrowAssoc[Database] 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 slick.Database[IO, StreamIO]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromDatabase to StringFormat[Database]

Inherited by implicit conversion Ensuring fromDatabase to Ensuring[Database]

Inherited by implicit conversion ArrowAssoc fromDatabase to ArrowAssoc[Database]

Ungrouped