trait StreamingInvokerAction[R, T, -E <: Effect] extends SynchronousDatabaseAction[R, Streaming[T], JdbcBackend, E] with FixedSqlStreamingAction[R, T, E]
A streaming Action that wraps an Invoker. It is used for the Lifted Embedding, Direct Embedding, Plain SQL queries, and JDBC metadata.
- Self Type
- StreamingInvokerAction[R, T, E]
- Source
- StreamingInvokerAction.scala
- Alphabetic
- By Inheritance
- StreamingInvokerAction
- FixedSqlStreamingAction
- FixedSqlAction
- SqlStreamingAction
- SqlAction
- BasicStreamingAction
- BasicAction
- SynchronousDatabaseAction
- DatabaseAction
- DBIOAction
- Dumpable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- type ResultAction[+R, +S <: NoStream, -E <: Effect] = SqlAction[R, S, E]
- Definition Classes
- FixedSqlAction → SqlAction → BasicAction
- type StreamState = CloseableIterator[T]
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
- StreamingInvokerAction → SynchronousDatabaseAction
Abstract Value Members
- abstract def createBuilder: Builder[T, R]
- Attributes
- protected[this]
- abstract def createInvoker(sql: Iterable[String]): Invoker[T]
- Attributes
- protected[this]
- abstract def statements: Iterable[String]
Return the SQL statements that will be executed for this Action
Return the SQL statements that will be executed for this Action
- Definition Classes
- SqlAction
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toany2stringadd[StreamingInvokerAction[R, T, E]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (StreamingInvokerAction[R, T, E], B)
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toArrowAssoc[StreamingInvokerAction[R, T, E]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- def andFinally[E2 <: Effect](a: DBIOAction[_, NoStream, E2]): DBIOAction[R, Streaming[T], 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
- SynchronousDatabaseAction → DBIOAction
- 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
- SynchronousDatabaseAction → DBIOAction
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asTry: DBIOAction[Try[R], NoStream, E]
Convert a successful result
v
of this action into a successful resultSuccess(v)
and a failuret
into a successful resultFailure(t)
.Convert a successful result
v
of this action into a successful resultSuccess(v)
and a failuret
into 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
- final def cancelStream(ctx: JdbcStreamingActionContext, state: StreamState): Unit
Dispose of a
StreamState
when a streaming action is cancelled.Dispose of a
StreamState
when a streaming action is cancelled. WheneveremitStream
returnsnull
or throws an Exception, it needs to dispose of the state itself. This method will not be called in these cases.- Definition Classes
- StreamingInvokerAction → SynchronousDatabaseAction
- def cleanUp[E2 <: Effect](f: (Option[Throwable]) => DBIOAction[_, NoStream, E2], keepFailure: Boolean = true)(implicit executor: ExecutionContext): DBIOAction[R, Streaming[T], 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
, orNone
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 totrue
(the default), the resulting action fails with the same error, no matter whether the clean-up action succeeds or fails. IfkeepFailure
is 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[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
- final def emitStream(ctx: JdbcStreamingActionContext, 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
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
- StreamingInvokerAction → SynchronousDatabaseAction
- def ensuring(cond: (StreamingInvokerAction[R, T, E]) => Boolean, msg: => Any): StreamingInvokerAction[R, T, E]
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toEnsuring[StreamingInvokerAction[R, T, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (StreamingInvokerAction[R, T, E]) => Boolean): StreamingInvokerAction[R, T, E]
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toEnsuring[StreamingInvokerAction[R, T, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): StreamingInvokerAction[R, T, E]
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toEnsuring[StreamingInvokerAction[R, T, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): StreamingInvokerAction[R, T, E]
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toEnsuring[StreamingInvokerAction[R, T, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
- SynchronousDatabaseAction → DBIOAction
- 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
- 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
- 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
- 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
- StreamingInvokerAction → SqlAction → Dumpable
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def head: FixedSqlAction[T, NoStream, E]
Create an Action that returns only the first value of this stream of data.
Create an Action that returns only the first value of this stream of data. The Action will fail if the stream is empty. Only available on streaming Actions.
- Definition Classes
- StreamingInvokerAction → BasicStreamingAction
- final def headOption: FixedSqlAction[Option[T], NoStream, E]
Create an Action that returns only the first value of this stream of data as an
Option
.Create an Action that returns only the first value of this stream of data as an
Option
. Only available on streaming Actions.- Definition Classes
- StreamingInvokerAction → BasicStreamingAction
- 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: (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
- def named(name: String): DBIOAction[R, Streaming[T], 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nonFusedEquivalentAction: DBIOAction[R, Streaming[T], 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def overrideStatements(_statements: Iterable[String]): FixedSqlAction[R, Streaming[T], E]
Create an Action that uses the specified SQL statement(s) but otherwise behaves the same as this Action.
Create an Action that uses the specified SQL statement(s) but otherwise behaves the same as this Action.
- Definition Classes
- StreamingInvokerAction → SqlAction
- final def run(ctx: JdbcActionContext): R
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
- StreamingInvokerAction → SynchronousDatabaseAction
- def supportsStreaming: Boolean
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 aNoStream
result 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: (R) => Boolean)(implicit executor: ExecutionContext): DBIOAction[R, NoStream, E]
- Definition Classes
- DBIOAction
- def withPinnedSession: DBIOAction[R, Streaming[T], 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
- SynchronousDatabaseAction → DBIOAction
- 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
- SynchronousDatabaseAction → DBIOAction
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toStringFormat[StreamingInvokerAction[R, T, 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (StreamingInvokerAction[R, T, E], B)
- Implicit
- This member is added by an implicit conversion from StreamingInvokerAction[R, T, E] toArrowAssoc[StreamingInvokerAction[R, T, 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.
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...