object PopStatementParameters extends SynchronousDatabaseAction[Unit, NoStream, Backend, Effect]
- Attributes
- protected
- Source
- JdbcActionComponent.scala
- Alphabetic
- By Inheritance
- PopStatementParameters
- SynchronousDatabaseAction
- DatabaseAction
- DBIOAction
- Dumpable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type StreamState >: Null <: AnyRef
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
emitStreamproduces such a state which is then fed back into the next call.- Definition Classes
- SynchronousDatabaseAction
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def >>[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, Effect with E2]
A shortcut for
andThen.A shortcut for
andThen.- Definition Classes
- DBIOAction
- def andFinally[E2 <: Effect](a: DBIOAction[_, NoStream, E2]): DBIOAction[Unit, NoStream, Effect 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
- SynchronousDatabaseAction → DBIOAction
- def andThen[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, Effect 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
- SynchronousDatabaseAction → DBIOAction
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asTry: DBIOAction[Try[Unit], NoStream, Effect]
Convert a successful result
vof this action into a successful resultSuccess(v)and a failuretinto a successful resultFailure(t).Convert a successful result
vof this action into a successful resultSuccess(v)and a failuretinto a successful resultFailure(t). This is the most generic combinator that can be used for error recovery. If possible, use andFinally or cleanUp instead, because those combinators, unlikeasTry, support streaming.- Definition Classes
- SynchronousDatabaseAction → DBIOAction
- def cancelStream(context: StreamingContext, state: StreamState): Unit
Dispose of a
StreamStatewhen a streaming action is cancelled.Dispose of a
StreamStatewhen a streaming action is cancelled. WheneveremitStreamreturnsnullor throws an Exception, it needs to dispose of the state itself. This method will not be called in these cases.- Definition Classes
- SynchronousDatabaseAction
- def cleanUp[E2 <: Effect](f: (Option[Throwable]) => DBIOAction[_, NoStream, E2], keepFailure: Boolean = true)(implicit executor: ExecutionContext): DBIOAction[Unit, NoStream, Effect 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, orNoneif 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
keepFailureis set totrue(the default), the resulting action fails with the same error, no matter whether the clean-up action succeeds or fails. IfkeepFailureis set tofalse, an error from the clean-up action will override the error from this action.
- Definition Classes
- DBIOAction
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def collect[R2](pf: PartialFunction[Unit, R2])(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, Effect]
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
- def emitStream(context: StreamingContext, limit: Long, state: StreamState): StreamState
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
nullif 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def failed: DBIOAction[Throwable, NoStream, Effect]
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
- SynchronousDatabaseAction → DBIOAction
- final def filter(p: (Unit) => Boolean)(implicit executor: ExecutionContext): DBIOAction[Unit, NoStream, Effect]
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
- def flatMap[R2, S2 <: NoStream, E2 <: Effect](f: (Unit) => DBIOAction[R2, S2, E2])(implicit executor: ExecutionContext): DBIOAction[R2, S2, Effect 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
- def flatten[R2, S2 <: NoStream, E2 <: Effect](implicit ev: <:<[Unit, DBIOAction[R2, S2, E2]]): DBIOAction[R2, S2, Effect 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- PopStatementParameters → Dumpable
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- DatabaseAction → DBIOAction
- def map[R2](f: (Unit) => R2)(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, Effect]
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
- def named(name: String): DBIOAction[Unit, NoStream, Effect]
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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nonFusedEquivalentAction: DBIOAction[Unit, NoStream, Effect]
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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def run(ctx: JdbcActionContext): Unit
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
- PopStatementParameters → SynchronousDatabaseAction
- def supportsStreaming: Boolean
Whether or not this action supports streaming results.
Whether or not this action supports streaming results. An action with a
Streamingresult type must either support streaming directly or have a nonFusedEquivalentAction which supports streaming. This flag is not used if the Action has aNoStreamresult type.- Definition Classes
- SynchronousDatabaseAction
- 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])
- def withFilter(p: (Unit) => Boolean)(implicit executor: ExecutionContext): DBIOAction[Unit, NoStream, Effect]
- Definition Classes
- DBIOAction
- def withPinnedSession: DBIOAction[Unit, NoStream, Effect]
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
- SynchronousDatabaseAction → DBIOAction
- def zip[R2, E2 <: Effect](a: DBIOAction[R2, NoStream, E2]): DBIOAction[(Unit, R2), NoStream, Effect 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
- SynchronousDatabaseAction → DBIOAction
- def zipWith[R2, E2 <: Effect, R3](a: DBIOAction[R2, NoStream, E2])(f: (Unit, R2) => R3)(implicit executor: ExecutionContext): DBIOAction[R3, NoStream, Effect 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
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...