Class

slick.dbio

SuccessAction

Related Doc: package dbio

Permalink

case class SuccessAction[+R](value: R) extends SynchronousDatabaseAction[R, NoStream, BasicBackend, Effect] with Product with Serializable

A DBIOAction that returns a constant value.

Source
DBIOAction.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, SynchronousDatabaseAction[R, NoStream, BasicBackend, Effect], DatabaseAction[R, NoStream, Effect], DBIOAction[R, NoStream, Effect], Dumpable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SuccessAction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SynchronousDatabaseAction
  7. DatabaseAction
  8. DBIOAction
  9. Dumpable
  10. AnyRef
  11. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SuccessAction(value: R)

    Permalink

Type Members

  1. abstract type StreamState >: Null <: AnyRef

    Permalink

    The type used by this action for the state of a suspended stream.

    The type used by this action for the state of a suspended stream. A call to emitStream produces such a state which is then fed back into the next call.

    Definition Classes
    SynchronousDatabaseAction

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to any2stringadd[SuccessAction[R]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SuccessAction[R], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to ArrowAssoc[SuccessAction[R]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def >>[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, Effect with E2]

    Permalink

    A shortcut for andThen.

    A shortcut for andThen.

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

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  8. def andThen[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, Effect with E2]

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def asTry: DBIOAction[Try[R], NoStream, Effect]

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  11. def cancelStream(context: StreamingContext, state: StreamState): Unit

    Permalink

    Dispose of a StreamState when a streaming action is cancelled.

    Dispose of a StreamState when a streaming action is cancelled. Whenever emitStream returns null or throws an Exception, it needs to dispose of the state itself. This method will not be called in these cases.

    Definition Classes
    SynchronousDatabaseAction
  12. def cleanUp[E2 <: Effect](f: (Option[Throwable]) ⇒ DBIOAction[_, NoStream, E2], keepFailure: Boolean = true)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, Effect with E2]

    Permalink

    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
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def collect[R2](pf: PartialFunction[R, R2])(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, Effect]

    Permalink

    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
  15. def emitStream(context: StreamingContext, limit: Long, state: StreamState): StreamState

    Permalink

    Run this action synchronously and emit results to the context.

    Run this action synchronously and emit results to the context. This methods may throw an Exception to indicate a failure.

    limit

    The maximum number of results to emit, or Long.MaxValue for no limit.

    state

    The state returned by a previous invocation of this method, or null if a new stream should be produced.

    returns

    A stream state if there are potentially more results available, or null if the stream is finished.

    Definition Classes
    SynchronousDatabaseAction
  16. def ensuring(cond: (SuccessAction[R]) ⇒ Boolean, msg: ⇒ Any): SuccessAction[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to Ensuring[SuccessAction[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (SuccessAction[R]) ⇒ Boolean): SuccessAction[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to Ensuring[SuccessAction[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: ⇒ Any): SuccessAction[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to Ensuring[SuccessAction[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): SuccessAction[R]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to Ensuring[SuccessAction[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def failed: DBIOAction[Throwable, NoStream, Effect]

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  22. final def filter(p: (R) ⇒ Boolean)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, Effect]

    Permalink

    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 finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def flatMap[R2, S2 <: NoStream, E2 <: Effect](f: (R) ⇒ DBIOAction[R2, S2, E2])(implicit executor: ExecutionContext): DBIOAction[R2, S2, Effect with E2]

    Permalink

    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
  25. def flatten[R2, S2 <: NoStream, E2 <: Effect](implicit ev: <:<[R, DBIOAction[R2, S2, E2]]): DBIOAction[R2, S2, Effect with E2]

    Permalink

    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
  26. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to StringFormat[SuccessAction[R]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def getDumpInfo: DumpInfo

    Permalink

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

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

    Definition Classes
    SuccessActionDumpable
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def isLogged: Boolean

    Permalink

    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
    DatabaseActionDBIOAction
  31. def map[R2](f: (R) ⇒ R2)(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, Effect]

    Permalink

    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
  32. def named(name: String): DBIOAction[R, NoStream, Effect]

    Permalink

    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
  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. def nonFusedEquivalentAction: DBIOAction[R, NoStream, Effect]

    Permalink

    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
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. def run(ctx: Context): R

    Permalink

    Run this action synchronously and produce a result, or throw an Exception to indicate a failure.

    Run this action synchronously and produce a result, or throw an Exception to indicate a failure.

    Definition Classes
    SuccessActionSynchronousDatabaseAction
  38. def supportsStreaming: Boolean

    Permalink

    Whether or not this action supports streaming results.

    Whether or not this action supports streaming results. An action with a Streaming result type must either support streaming directly or have a nonFusedEquivalentAction which supports streaming. This flag is not used if the Action has a NoStream result type.

    Definition Classes
    SynchronousDatabaseAction
  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  40. val value: R

    Permalink
  41. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withFilter(p: (R) ⇒ Boolean)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, Effect]

    Permalink
    Definition Classes
    DBIOAction
  45. def withPinnedSession: DBIOAction[R, NoStream, Effect]

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  46. def zip[R2, E2 <: Effect](a: DBIOAction[R2, NoStream, E2]): DBIOAction[(R, R2), NoStream, Effect with E2]

    Permalink

    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
    SynchronousDatabaseActionDBIOAction
  47. def zipWith[R2, E2 <: Effect, R3](a: DBIOAction[R2, NoStream, E2])(f: (R, R2) ⇒ R3)(implicit executor: ExecutionContext): DBIOAction[R3, NoStream, Effect with E2]

    Permalink

    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
  48. def [B](y: B): (SuccessAction[R], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SuccessAction[R] to ArrowAssoc[SuccessAction[R]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DatabaseAction[R, NoStream, Effect]

Inherited from DBIOAction[R, NoStream, Effect]

Inherited from Dumpable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SuccessAction[R] to any2stringadd[SuccessAction[R]]

Inherited by implicit conversion StringFormat from SuccessAction[R] to StringFormat[SuccessAction[R]]

Inherited by implicit conversion Ensuring from SuccessAction[R] to Ensuring[SuccessAction[R]]

Inherited by implicit conversion ArrowAssoc from SuccessAction[R] to ArrowAssoc[SuccessAction[R]]

Ungrouped