Packages

object JdbcProjection

Source
JdbcProjection.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JdbcProjection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def atLeastOnce[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: Supplier[JdbcHandler[Envelope, S]], system: ActorSystem[_]): AtLeastOnceProjection[Offset, Envelope]

    Create a akka.projection.Projection with at-least-once processing semantics.

    Create a akka.projection.Projection with at-least-once processing semantics.

    It stores the offset in a relational database table using JDBC after the handler has processed the envelope. This means that if the projection is restarted from previously stored offset then some elements may be processed more than once.

    The offset is stored after a time window, or limited by a number of envelopes, whatever happens first. This window can be defined with AtLeastOnceProjection.withSaveOffset of the returned AtLeastOnceProjection. The default settings for the window is defined in configuration section akka.projection.at-least-once.

  2. def atLeastOnceAsync[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: Supplier[Handler[Envelope]], system: ActorSystem[_]): AtLeastOnceProjection[Offset, Envelope]

    Create a akka.projection.Projection with at-least-once processing semantics.

    Create a akka.projection.Projection with at-least-once processing semantics.

    Compared to JdbcProjection.atLeastOnce the Handler is not storing the projected result in the database, but is integrating with something else.

    It stores the offset in a relational database table using JDBC after the handler has processed the envelope. This means that if the projection is restarted from previously stored offset then some elements may be processed more than once.

    The offset is stored after a time window, or limited by a number of envelopes, whatever happens first. This window can be defined with AtLeastOnceProjection.withSaveOffset of the returned AtLeastOnceProjection. The default settings for the window is defined in configuration section akka.projection.at-least-once.

  3. def atLeastOnceFlow[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: FlowWithContext[Envelope, ProjectionContext, Done, ProjectionContext, _], system: ActorSystem[_]): AtLeastOnceFlowProjection[Offset, Envelope]

    Create a akka.projection.Projection with a FlowWithContext as the envelope handler.

    Create a akka.projection.Projection with a FlowWithContext as the envelope handler. It has at-least-once processing semantics.

    The flow should emit a Done element for each completed envelope. The offset of the envelope is carried in the context of the FlowWithContext and is stored in the database when corresponding Done is emitted. Since the offset is stored after processing the envelope it means that if the projection is restarted from previously stored offset then some envelopes may be processed more than once.

    If the flow filters out envelopes the corresponding offset will not be stored, and such envelope will be processed again if the projection is restarted and no later offset was stored.

    The flow should not duplicate emitted envelopes (mapConcat) with same offset, because then it can result in that the first offset is stored and when the projection is restarted that offset is considered completed even though more of the duplicated envelopes were never processed.

    The flow must not reorder elements, because the offsets may be stored in the wrong order and and when the projection is restarted all envelopes up to the latest stored offset are considered completed even though some of them may not have been processed. This is the reason the flow is restricted to FlowWithContext rather than ordinary Flow.

  4. def createTablesIfNotExists[S <: JdbcSession](sessionFactory: Supplier[S], system: ActorSystem[_]): CompletionStage[Done]

    For testing purposes the projection offset and management tables can be created programmatically.

    For testing purposes the projection offset and management tables can be created programmatically. For production it's recommended to create the table with DDL statements before the system is started.

  5. def dropTablesIfExists[S <: JdbcSession](sessionFactory: Supplier[S], system: ActorSystem[_]): CompletionStage[Done]

    For testing purposes the projection offset and management tables can be dropped programmatically.

  6. def exactlyOnce[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: Supplier[JdbcHandler[Envelope, S]], system: ActorSystem[_]): ExactlyOnceProjection[Offset, Envelope]

    Create a akka.projection.Projection with exactly-once processing semantics.

    Create a akka.projection.Projection with exactly-once processing semantics.

    It stores the offset in a relational database table using JDBC in the same transaction as the user defined handler.

  7. def groupedWithin[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: Supplier[JdbcHandler[List[Envelope], S]], system: ActorSystem[_]): GroupedProjection[Offset, Envelope]

    Create a akka.projection.Projection that groups envelopes and calls the handler with a group of Envelopes.

    Create a akka.projection.Projection that groups envelopes and calls the handler with a group of Envelopes. The envelopes are grouped within a time window, or limited by a number of envelopes, whatever happens first. This window can be defined with GroupedProjection.withGroup of the returned GroupedProjection. The default settings for the window is defined in configuration section akka.projection.grouped.

    It stores the offset in a relational database table using JDBC in the same transaction as the user defined handler.

  8. def groupedWithinAsync[Offset, Envelope, S <: JdbcSession](projectionId: ProjectionId, sourceProvider: SourceProvider[Offset, Envelope], sessionCreator: Supplier[S], handler: Supplier[Handler[List[Envelope]]], system: ActorSystem[_]): GroupedProjection[Offset, Envelope]

    Create a akka.projection.Projection that groups envelopes and calls the handler with a group of Envelopes.

    Create a akka.projection.Projection that groups envelopes and calls the handler with a group of Envelopes. The envelopes are grouped within a time window, or limited by a number of envelopes, whatever happens first. This window can be defined with GroupedProjection.withGroup of the returned GroupedProjection. The default settings for the window is defined in configuration section akka.projection.grouped.

    Compared to JdbcProjection.groupedWithin the Handler is not storing the projected result in the database, but is integrating with something else.

    It stores the offset in a relational database table using JDBC immediately after the handler has processed the envelopes, but that is still with at-least-once processing semantics. This means that if the projection is restarted from previously stored offset the previous group of envelopes may be processed more than once.

Deprecated Value Members

  1. def createOffsetTableIfNotExists[S <: JdbcSession](sessionFactory: Supplier[S], system: ActorSystem[_]): CompletionStage[Done]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2.0) Renamed to createTablesIfNotExists

  2. def dropOffsetTableIfExists[S <: JdbcSession](sessionFactory: Supplier[S], system: ActorSystem[_]): CompletionStage[Done]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2.0) Renamed to dropTablesIfExists