Packages

c

slick.dbio

CleanUpAction

case class CleanUpAction[+R, +S <: NoStream, -E <: Effect](base: DBIOAction[R, S, E], f: (Option[Throwable]) => DBIOAction[_, NoStream, E], keepFailure: Boolean, executor: ExecutionContext) extends DBIOAction[R, S, E] with Product with Serializable

A DBIOAction that represents a cleanUp operation for sequencing in the DBIOAction monad.

Source
DBIOAction.scala
Linear Supertypes
Serializable, Product, Equals, DBIOAction[R, S, E], Dumpable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CleanUpAction
  2. Serializable
  3. Product
  4. Equals
  5. DBIOAction
  6. Dumpable
  7. AnyRef
  8. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CleanUpAction(base: DBIOAction[R, S, E], f: (Option[Throwable]) => DBIOAction[_, NoStream, E], keepFailure: Boolean, executor: ExecutionContext)

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): (CleanUpAction[R, S, E], B)
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toArrowAssoc[CleanUpAction[R, S, E]] 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 >>[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, E with E2]

    A shortcut for andThen.

    A shortcut for andThen.

    Definition Classes
    DBIOAction
  6. def andFinally[E2 <: Effect](a: DBIOAction[_, NoStream, E2]): DBIOAction[R, S, E with E2]

    Run another action after this action, whether it succeeds or fails, and then return the result of the first action.

    Run another action after this action, whether it succeeds or fails, and then return the result of the first action. If the first action fails, its failure is propagated, whether the second action fails or succeeds. If the first action succeeds, a failure of the second action is propagated.

    Definition Classes
    DBIOAction
  7. def andThen[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, E with E2]

    Run another action after this action, if it completed successfully, and return the result of the second action.

    Run another action after this action, if it completed successfully, and return the result of the second action. If either of the two actions fails, the resulting action also fails.

    Definition Classes
    DBIOAction
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asTry: DBIOAction[Try[R], NoStream, E]

    Convert a successful result v of this action into a successful result Success(v) and a failure t into a successful result Failure(t).

    Convert a successful result v of this action into a successful result Success(v) and a failure t into a successful result Failure(t). This is the most generic combinator that can be used for error recovery. If possible, use andFinally or cleanUp instead, because those combinators, unlike asTry, support streaming.

    Definition Classes
    DBIOAction
  10. val base: DBIOAction[R, S, E]
  11. def cleanUp[E2 <: Effect](f: (Option[Throwable]) => DBIOAction[_, NoStream, E2], keepFailure: Boolean = true)(implicit executor: ExecutionContext): DBIOAction[R, S, E with E2]

    Run another action after this action, whether it succeeds or fails, in order to clean up or transform an error produced by this action.

    Run another action after this action, whether it succeeds or fails, in order to clean up or transform an error produced by this action. The clean-up action is computed from the failure of this action, wrapped in Some, or None if this action succeeded.

    keepFailure

    If this action returns successfully, the resulting action also returns successfully unless the clean-up action fails. If this action fails and keepFailure is set to true (the default), the resulting action fails with the same error, no matter whether the clean-up action succeeds or fails. If keepFailure is set to false, an error from the clean-up action will override the error from this action.

    Definition Classes
    DBIOAction
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def collect[R2](pf: PartialFunction[R, R2])(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, E]

    Transform the result of a successful execution of this action, if the given partial function is defined at that value, otherwise, the result DBIOAction will fail with a NoSuchElementException.

    Transform the result of a successful execution of this action, if the given partial function is defined at that value, otherwise, the result DBIOAction will fail with a NoSuchElementException.

    If this action fails, the resulting action also fails.

    Definition Classes
    DBIOAction
  14. def ensuring(cond: (CleanUpAction[R, S, E]) => Boolean, msg: => Any): CleanUpAction[R, S, E]
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toEnsuring[CleanUpAction[R, S, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (CleanUpAction[R, S, E]) => Boolean): CleanUpAction[R, S, E]
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toEnsuring[CleanUpAction[R, S, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): CleanUpAction[R, S, E]
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toEnsuring[CleanUpAction[R, S, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): CleanUpAction[R, S, E]
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toEnsuring[CleanUpAction[R, S, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val executor: ExecutionContext
  20. val f: (Option[Throwable]) => DBIOAction[_, NoStream, E]
  21. def failed: DBIOAction[Throwable, NoStream, E]

    Return an action which contains the Throwable with which this action failed as its result.

    Return an action which contains the Throwable with which this action failed as its result. If this action succeeded, the resulting action fails with a NoSuchElementException.

    Definition Classes
    DBIOAction
  22. final def filter(p: (R) => Boolean)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, E]

    Filter the result of this action with the given predicate.

    Filter the result of this action with the given predicate. If the predicate matches, the original result is returned, otherwise the resulting action fails with a NoSuchElementException.

    Definition Classes
    DBIOAction
  23. def flatMap[R2, S2 <: NoStream, E2 <: Effect](f: (R) => DBIOAction[R2, S2, E2])(implicit executor: ExecutionContext): DBIOAction[R2, S2, E with E2]

    Use the result produced by the successful execution of this action to compute and then run the next action in sequence.

    Use the result produced by the successful execution of this action to compute and then run the next action in sequence. The resulting action fails if either this action, the computation, or the computed action fails.

    Definition Classes
    DBIOAction
  24. def flatten[R2, S2 <: NoStream, E2 <: Effect](implicit ev: <:<[R, DBIOAction[R2, S2, E2]]): DBIOAction[R2, S2, E with E2]

    Creates a new DBIOAction with one level of nesting flattened, this method is equivalent to flatMap(identity).

    Creates a new DBIOAction with one level of nesting flattened, this method is equivalent to flatMap(identity).

    Definition Classes
    DBIOAction
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def getDumpInfo: DumpInfo

    Return the name, main info, attribute info and named children

    Return the name, main info, attribute info and named children

    Definition Classes
    CleanUpAction → Dumpable
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isLogged: Boolean

    Whether or not this action should be included in log output by default.

    Whether or not this action should be included in log output by default.

    Definition Classes
    DBIOAction
  29. val keepFailure: Boolean
  30. def map[R2](f: (R) => R2)(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, E]

    Transform the result of a successful execution of this action.

    Transform the result of a successful execution of this action. If this action fails, the resulting action also fails.

    Definition Classes
    DBIOAction
  31. def named(name: String): DBIOAction[R, S, E]

    Get a wrapping action which has a name that will be included in log output.

    Get a wrapping action which has a name that will be included in log output.

    Definition Classes
    DBIOAction
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def nonFusedEquivalentAction: DBIOAction[R, S, E]

    Get the equivalent non-fused action if this action has been fused, otherwise this action is returned.

    Get the equivalent non-fused action if this action has been fused, otherwise this action is returned.

    Definition Classes
    DBIOAction
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def withFilter(p: (R) => Boolean)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, E]
    Definition Classes
    DBIOAction
  42. def withPinnedSession: DBIOAction[R, S, E]

    Use a pinned database session when running this action.

    Use a pinned database session when running this action. If it is composed of multiple database actions, they will all use the same session, even when sequenced with non-database actions. For non-composite or non-database actions, this has no effect.

    Definition Classes
    DBIOAction
  43. def zip[R2, E2 <: Effect](a: DBIOAction[R2, NoStream, E2]): DBIOAction[(R, R2), NoStream, E with E2]

    Run another action after this action, if it completed successfully, and return the result of both actions.

    Run another action after this action, if it completed successfully, and return the result of both actions. If either of the two actions fails, the resulting action also fails.

    Definition Classes
    DBIOAction
  44. def zipWith[R2, E2 <: Effect, R3](a: DBIOAction[R2, NoStream, E2])(f: (R, R2) => R3)(implicit executor: ExecutionContext): DBIOAction[R3, NoStream, E with E2]

    Run another action after this action, if it completed successfully, and zip the result of both actions with a function f, then create a new DBIOAction holding this result, If either of the two actions fails, the resulting action also fails.

    Run another action after this action, if it completed successfully, and zip the result of both actions with a function f, then create a new DBIOAction holding this result, If either of the two actions fails, the resulting action also fails.

    Definition Classes
    DBIOAction

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toStringFormat[CleanUpAction[R, S, E]] 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): (CleanUpAction[R, S, E], B)
    Implicit
    This member is added by an implicit conversion from CleanUpAction[R, S, E] toArrowAssoc[CleanUpAction[R, S, E]] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from DBIOAction[R, S, E]

Inherited from Dumpable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromCleanUpAction[R, S, E] to StringFormat[CleanUpAction[R, S, E]]

Inherited by implicit conversion Ensuring fromCleanUpAction[R, S, E] to Ensuring[CleanUpAction[R, S, E]]

Inherited by implicit conversion ArrowAssoc fromCleanUpAction[R, S, E] to ArrowAssoc[CleanUpAction[R, S, E]]

Ungrouped