Class

com.github.tminglei.slickpg.lobj

LargeObjectStreamingDBIOAction

Related Doc: package lobj

Permalink

case class LargeObjectStreamingDBIOAction(largeObjectId: Long, bufferSize: Int = 1024 * 8) extends SynchronousDatabaseAction[Array[Byte], Streaming[Array[Byte]], JdbcBackend, All] with Product with Serializable

Action for streaming Postgres LargeObject instances from a Postgres DB.

largeObjectId

The oid of the LargeObject to stream.

bufferSize

The chunk size in bytes. Default to 8KB.

Linear Supertypes
Serializable, Serializable, Product, Equals, SynchronousDatabaseAction[Array[Byte], Streaming[Array[Byte]], JdbcBackend, All], DatabaseAction[Array[Byte], Streaming[Array[Byte]], All], DBIOAction[Array[Byte], Streaming[Array[Byte]], All], Dumpable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LargeObjectStreamingDBIOAction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SynchronousDatabaseAction
  7. DatabaseAction
  8. DBIOAction
  9. Dumpable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LargeObjectStreamingDBIOAction(largeObjectId: Long, bufferSize: Int = 1024 * 8)

    Permalink

    largeObjectId

    The oid of the LargeObject to stream.

    bufferSize

    The chunk size in bytes. Default to 8KB.

Type Members

  1. type StreamState = (InputStream, Int)

    Permalink
    Definition Classes
    LargeObjectStreamingDBIOAction → SynchronousDatabaseAction

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    DBIOAction
  5. def andFinally[E2 <: Effect](a: DBIOAction[_, NoStream, E2]): DBIOAction[Array[Byte], Streaming[Array[Byte]], All with E2]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  6. def andThen[R2, S2 <: NoStream, E2 <: Effect](a: DBIOAction[R2, S2, E2]): DBIOAction[R2, S2, All with E2]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def asTry: DBIOAction[Try[Array[Byte]], NoStream, All]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  9. val bufferSize: Int

    Permalink

    The chunk size in bytes.

    The chunk size in bytes. Default to 8KB.

  10. def cancelStream(context: JdbcStreamingActionContext, state: StreamState): Unit

    Permalink

    Cancels this stream and closes the underlying InputStream.

    Cancels this stream and closes the underlying InputStream.

    context

    The current database context.

    state

    The current StreamState at the time of the cancelling.

    Definition Classes
    LargeObjectStreamingDBIOAction → SynchronousDatabaseAction
  11. def cleanUp[E2 <: Effect](f: (Option[Throwable]) ⇒ DBIOAction[_, NoStream, E2], keepFailure: Boolean)(implicit executor: ExecutionContext): DBIOAction[Array[Byte], Streaming[Array[Byte]], All with E2]

    Permalink
    Definition Classes
    DBIOAction
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  13. def collect[R2](pf: PartialFunction[Array[Byte], R2])(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, All]

    Permalink
    Definition Classes
    DBIOAction
  14. def emitStream(context: JdbcStreamingActionContext, limit: Long, state: StreamState): StreamState

    Permalink

    Emits at most limit number of events to the context's stream.

    Emits at most limit number of events to the context's stream.

    context

    The current database context.

    limit

    The maximum number of events to emit back to the stream.

    state

    The state of the stream as returned by the previous iteration.

    returns

    The new stream state.

    Definition Classes
    LargeObjectStreamingDBIOAction → SynchronousDatabaseAction
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def failed: DBIOAction[Throwable, NoStream, All]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  17. final def filter(p: (Array[Byte]) ⇒ Boolean)(implicit executor: ExecutionContext): DBIOAction[Array[Byte], NoStream, All]

    Permalink
    Definition Classes
    DBIOAction
  18. def flatMap[R2, S2 <: NoStream, E2 <: Effect](f: (Array[Byte]) ⇒ DBIOAction[R2, S2, E2])(implicit executor: ExecutionContext): DBIOAction[R2, S2, All with E2]

    Permalink
    Definition Classes
    DBIOAction
  19. def flatten[R2, S2 <: NoStream, E2 <: Effect](implicit ev: <:<[Array[Byte], DBIOAction[R2, S2, E2]]): DBIOAction[R2, S2, All with E2]

    Permalink
    Definition Classes
    DBIOAction
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  21. def getDumpInfo: DumpInfo

    Permalink
    Definition Classes
    LargeObjectStreamingDBIOAction → Dumpable
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isLogged: Boolean

    Permalink
    Definition Classes
    DatabaseAction → DBIOAction
  24. val largeObjectId: Long

    Permalink

    The oid of the LargeObject to stream.

  25. def map[R2](f: (Array[Byte]) ⇒ R2)(implicit executor: ExecutionContext): DBIOAction[R2, NoStream, All]

    Permalink
    Definition Classes
    DBIOAction
  26. def named(name: String): DBIOAction[Array[Byte], Streaming[Array[Byte]], All]

    Permalink
    Definition Classes
    DBIOAction
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def nonFusedEquivalentAction: DBIOAction[Array[Byte], Streaming[Array[Byte]], All]

    Permalink
    Definition Classes
    DBIOAction
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  31. def run(context: JdbcActionContext): Array[Byte]

    Permalink

    Run this action.

    Run this action. This is currently unsupported as this action only works for streaming and will throw an UnsupportedOperationException.

    context

    The current database context.

    returns

    An UnsupportedOperationException with a friendly message.

    Definition Classes
    LargeObjectStreamingDBIOAction → SynchronousDatabaseAction
  32. def supportsStreaming: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  34. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withFilter(p: (Array[Byte]) ⇒ Boolean)(implicit executor: ExecutionContext): DBIOAction[Array[Byte], NoStream, All]

    Permalink
    Definition Classes
    DBIOAction
  38. def withPinnedSession: DBIOAction[Array[Byte], Streaming[Array[Byte]], All]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  39. def zip[R2, E2 <: Effect](a: DBIOAction[R2, NoStream, E2]): DBIOAction[(Array[Byte], R2), NoStream, All with E2]

    Permalink
    Definition Classes
    SynchronousDatabaseAction → DBIOAction
  40. def zipWith[R2, E2 <: Effect, R3](a: DBIOAction[R2, NoStream, E2])(f: (Array[Byte], R2) ⇒ R3)(implicit executor: ExecutionContext): DBIOAction[R3, NoStream, All with E2]

    Permalink
    Definition Classes
    DBIOAction

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SynchronousDatabaseAction[Array[Byte], Streaming[Array[Byte]], JdbcBackend, All]

Inherited from DatabaseAction[Array[Byte], Streaming[Array[Byte]], All]

Inherited from DBIOAction[Array[Byte], Streaming[Array[Byte]], All]

Inherited from Dumpable

Inherited from AnyRef

Inherited from Any

Ungrouped