Packages

o

akka.kafka.scaladsl

Transactional

object Transactional

Akka Stream connector to support transactions between Kafka topics.

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

Value Members

  1. def flow[K, V](settings: ProducerSettings[K, V]): Flow[Envelope[K, V, PartitionOffset], Results[K, V, PartitionOffset], NotUsed]

    Publish records to Kafka topics and then continue the flow.

    Publish records to Kafka topics and then continue the flow. The flow can only be used with a Transactional.source that emits a ConsumerMessage.TransactionalMessage. The flow will override producer properties to enable Kafka exactly-once transactional support. A UUID is used for transaction id, optionally prefixed through ProducerSettings.transactionIdPrefix

    Annotations
    @nowarn()
  2. def flowWithOffsetContext[K, V](settings: ProducerSettings[K, V]): FlowWithContext[Envelope[K, V, NotUsed], PartitionOffset, Results[K, V, PartitionOffset], PartitionOffset, NotUsed]

    API MAY CHANGE

    API MAY CHANGE

    Publish records to Kafka topics and then continue the flow. The flow can only be used with a Transactional.sourceWithOffsetContext which carries ConsumerMessage.PartitionOffset as context. The flow requires a unique transactional.id across all app instances. The flow will override producer properties to enable Kafka exactly-once transactional support.

    This flow is intended to be used with Akka's [flow with context](https://doc.akka.io/libraries/akka-core/current/stream/operators/Flow/asFlowWithContext.html) and Transactional.sourceWithOffsetContext.

    Annotations
    @ApiMayChange()
  3. def sink[K, V](settings: ProducerSettings[K, V]): Sink[Envelope[K, V, PartitionOffset], Future[Done]]

    Sink that is aware of the ConsumerMessage.TransactionalMessage.partitionOffset from a Transactional.source.

    Sink that is aware of the ConsumerMessage.TransactionalMessage.partitionOffset from a Transactional.source. It will initialize, begin, produce, and commit the consumer offset as part of a transaction.

  4. def sinkWithOffsetContext[K, V](settings: ProducerSettings[K, V]): Sink[(Envelope[K, V, NotUsed], PartitionOffset), Future[Done]]

    API MAY CHANGE

    API MAY CHANGE

    Sink that requires the context to be ConsumerMessage.PartitionOffset from a Transactional.sourceWithOffsetContext. It will initialize, begin, produce, and commit the consumer offset as part of a transaction.

    Annotations
    @ApiMayChange()
  5. def source[K, V](settings: ConsumerSettings[K, V], subscription: Subscription): Source[TransactionalMessage[K, V], Control]

    Transactional source to setup a stream for Exactly Only Once (EoS) kafka message semantics.

    Transactional source to setup a stream for Exactly Only Once (EoS) kafka message semantics. To enable EoS it's necessary to use the Transactional.sink or Transactional.flow (for passthrough).

  6. def sourceWithOffsetContext[K, V](settings: ConsumerSettings[K, V], subscription: Subscription): SourceWithContext[ConsumerRecord[K, V], PartitionOffset, Control]

    API MAY CHANGE

    API MAY CHANGE

    This source is intended to be used with Akka's [flow with context](https://doc.akka.io/libraries/akka-core/current/stream/operators/Flow/asFlowWithContext.html) and Transactional.flowWithOffsetContext.

    Annotations
    @ApiMayChange()

Deprecated Value Members

  1. def flow[K, V](settings: ProducerSettings[K, V], transactionalId: String): Flow[Envelope[K, V, PartitionOffset], Results[K, V, PartitionOffset], NotUsed]

    Publish records to Kafka topics and then continue the flow.

    Publish records to Kafka topics and then continue the flow. The flow can only be used with a Transactional.source that emits a ConsumerMessage.TransactionalMessage. The flow requires a unique transactional.id across all app instances. The flow will override producer properties to enable Kafka exactly-once transactional support.

    Annotations
    @deprecated
    Deprecated

    Use the 'flow' factory without a transactionalId parameter

  2. def sink[K, V](settings: ProducerSettings[K, V], transactionalId: String): Sink[Envelope[K, V, PartitionOffset], Future[Done]]

    Sink that is aware of the ConsumerMessage.TransactionalMessage.partitionOffset from a Transactional.source.

    Sink that is aware of the ConsumerMessage.TransactionalMessage.partitionOffset from a Transactional.source. It will initialize, begin, produce, and commit the consumer offset as part of a transaction.

    Annotations
    @nowarn() @deprecated
    Deprecated

    Use the 'sink' factory method without a transactionalId parameter