Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 4.82 KB

home.md

File metadata and controls

77 lines (45 loc) · 4.82 KB

Overview

The Alpakka project is an open source initiative to implement stream-aware and reactive integration pipelines for Java and Scala. It is built on top of @extrefAkka Streams, and has been designed from the ground up to understand streaming natively and provide a DSL for reactive and stream-oriented programming, with built-in support for backpressure. Akka Streams is a Reactive Streams and JDK 9+ @extrefjava.util.concurrent.Flow-compliant implementation and therefore @extreffully interoperable with other implementations.

This Alpakka Kafka connector lets you connect Apache Kafka to Akka Streams. It was formerly known as Akka Streams Kafka and even Reactive Kafka.

Project Info

@@project-info{ projectId="core" }

Matching Kafka Versions

Kafka client Scala Versions Akka version Alpakka Kafka Connector
2.1.1 2.13, 2.12, 2.11 2.5.x @ref:release 1.0.4
2.1.1 2.12, 2.11 2.5.x @ref:release 1.0.1
2.1.0 2.12, 2.11 2.5.x @ref:release 1.0
2.0.x 2.12, 2.11 2.5.x @ref:release 1.0-M1
1.1.x 2.12, 2.11 2.5.x release 0.20+
1.0.x 2.12, 2.11 2.5.x release 0.20+
0.11.x 2.12, 2.11 2.5.x release 0.19

@@@ note

As Kafka's client protocol negotiates the version to use with the Kafka broker, you may use a Kafka client version that is different than the Kafka broker's version.

These client can communicate with brokers that are version 0.10.0 or newer. Older or newer brokers may not support certain features. For example, 0.10.0 brokers do not support offsetsForTimes, because this feature was added in version 0.10.1. You will receive an UnsupportedVersionException when invoking an API that is not available on the running broker version.

-- Javadoc for KafkaConsumer

@@@

Dependencies

@@dependency [Maven,sbt,Gradle] { group=com.typesafe.akka artifact=akka-stream-kafka_$scala.binary.version$ version=$project.version$ }

This connector depends on Akka 2.5.x and note that it is important that all akka-* dependencies are in the same version, so it is recommended to depend on them explicitly to avoid problems with transient dependencies causing an unlucky mix of versions.

The table below shows Alpakka Kafka's direct dependencies and the second tab shows all libraries it depends on transitively.

@@dependencies { projectId="core" }

  • Akka Streams $akka.version$ @extrefdocumentation and sources
  • Apache Kafka client $kafka.version$ @extrefdocumentation and sources

Scala and Java APIs

Following Akka's conventions there are two separate packages named akka.kafka.scaladsl and akka.kafka.javadsl with the API for Scala and Java. These packages contain Producer and Consumer classes with factory methods for the various Akka Streams Flow, Sink and Source that are producing or consuming messages to/from Kafka.

Examples

A few self-contained examples using Alpakka are available as Alpakka Samples.

To read and see how others use Alpakka see the Alpakka documentation's Webinars, Presentations and Articles listing.

Contributing

Please feel free to contribute to Alpakka and the Alpakka Kafka connector by reporting issues you identify, or by suggesting changes to the code. Please refer to our contributing instructions to learn how it can be done.

We want Akka and Alpakka to strive in a welcoming and open atmosphere and expect all contributors to respect our code of conduct.

@@@ index

@@@