Apache Cassandra Connector

This connector provides sinks that writes data into a Apache Cassandra database.

To use this connector, add the following dependency to your project:

There is no connector (yet) available for Flink version 1.18.

Note that the streaming connectors are currently NOT part of the binary distribution. See how to link with them for cluster execution here.

Installing Apache Cassandra

There are multiple ways to bring up a Cassandra instance on local machine:

  1. Follow the instructions from Cassandra Getting Started page.
  2. Launch a container running Cassandra from Official Docker Repository

Cassandra Sinks

Configurations

Flink’s Cassandra sink are created by using the static CassandraSink.addSink(DataStream input) method. This method returns a CassandraSinkBuilder, which offers methods to further configure the sink, and finally build() the sink instance.

The following configuration methods can be used:

  1. setQuery(String query)
    • Sets the upsert query that is executed for every record the sink receives.
    • The query is internally treated as CQL statement.
    • DO set the upsert query for processing Tuple data type.
    • DO NOT set the query for processing POJO data types.
  2. setClusterBuilder(ClusterBuilder clusterBuilder)
    • Sets the cluster builder that is used to configure the connection to cassandra with more sophisticated settings such as consistency level, retry policy and etc.
  3. setHost(String host[, int port])
    • Simple version of setClusterBuilder() with host/port information to connect to Cassandra instances
  4. setMapperOptions(MapperOptions options)
    • Sets the mapper options that are used to configure the DataStax ObjectMapper.
    • Only applies when processing POJO data types.
  5. setMaxConcurrentRequests(int maxConcurrentRequests, Duration timeout)
    • Sets the maximum allowed number of concurrent requests with a timeout for acquiring permits to execute.
    • Only applies when enableWriteAheadLog() is not configured.
  6. enableWriteAheadLog([CheckpointCommitter committer])
    • An optional setting
    • Allows exactly-once processing for non-deterministic algorithms.
  7. setFailureHandler([CassandraFailureHandler failureHandler])
    • An optional setting
    • Sets the custom failure handler.
  8. setDefaultKeyspace(String keyspace)
    • Sets the default keyspace to be used.
  9. enableIgnoreNullFields()
    • Enables ignoring null values, treats null values as unset and avoids writing null fields and creating tombstones.
  10. build()
    • Finalizes the configuration and constructs the CassandraSink instance.

Write-ahead Log

A checkpoint committer stores additional information about completed checkpoints in some resource. This information is used to prevent a full replay of the last completed checkpoint in case of a failure. You can use a CassandraCommitter to store these in a separate table in cassandra. Note that this table will NOT be cleaned up by Flink.

Flink can provide exactly-once guarantees if the query is idempotent (meaning it can be applied multiple times without changing the result) and checkpointing is enabled. In case of a failure the failed checkpoint will be replayed completely.

Furthermore, for non-deterministic programs the write-ahead log has to be enabled. For such a program the replayed checkpoint may be completely different than the previous attempt, which may leave the database in an inconsistent state since part of the first attempt may already be written. The write-ahead log guarantees that the replayed checkpoint is identical to the first attempt. Note that that enabling this feature will have an adverse impact on latency.

Note: The write-ahead log functionality is currently experimental. In many cases it is sufficient to use the connector without enabling it. Please report problems to the development mailing list.

Checkpointing and Fault Tolerance

With checkpointing enabled, Cassandra Sink guarantees at-least-once delivery of action requests to C* instance.

More details on checkpoints docs and fault tolerance guarantee docs

Examples

The Cassandra sink currently supports both Tuple and POJO data types, and Flink automatically detects which type of input is used. For general use of those streaming data types, please refer to Supported Data Types. We show two implementations based on SocketWindowWordCount , for POJO and Tuple data types respectively.

In all these examples, we assumed the associated Keyspace example and Table wordcount have been created.

CQL

  1. CREATE KEYSPACE IF NOT EXISTS example
  2.     WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '1'};
  4. CREATE TABLE IF NOT EXISTS example.wordcount (
  5.     word text,
  6.     count bigint,
  7.     PRIMARY KEY(word)
  8. );

Cassandra Sink Example for Streaming Tuple Data Type

While storing the result with Java/Scala Tuple data type to a Cassandra sink, it is required to set a CQL upsert statement (via setQuery(‘stmt’)) to persist each record back to the database. With the upsert query cached as PreparedStatement, each Tuple element is converted to parameters of the statement.

For details about PreparedStatement and BoundStatement, please visit DataStax Java Driver manual

Java

  1. // get the execution environment
  2. final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
  4. // get input data by connecting to the socket
  5. DataStream<String> text = env.socketTextStream(hostname, port, "\n");
  7. // parse the data, group it, window it, and aggregate the counts
  8. DataStream<Tuple2<String, Long>> result = text
  9.         .flatMap(new FlatMapFunction<String, Tuple2<String, Long>>() {
  10.             @Override
  11.             public void flatMap(String value, Collector<Tuple2<String, Long>> out) {
  12.                 // normalize and split the line
  13.                 String[] words = value.toLowerCase().split("\\s");
  15.                 // emit the pairs
  16.                 for (String word : words) {
  17.                     //Do not accept empty word, since word is defined as primary key in C* table
  18.                     if (!word.isEmpty()) {
  19.                         out.collect(new Tuple2<String, Long>(word, 1L));
  20.                     }
  21.                 }
  22.             }
  23.         })
  24.         .keyBy(value -> value.f0)
  25.         .window(TumblingProcessingTimeWindows.of(Time.seconds(5)))
  26.         .sum(1);
  28. CassandraSink.addSink(result)
  29.         .setQuery("INSERT INTO example.wordcount(word, count) values (?, ?);")
  30.         .setHost("127.0.0.1")
  31.         .build();

Scala

  1. val env: StreamExecutionEnvironment = StreamExecutionEnvironment.getExecutionEnvironment
  3. // get input data by connecting to the socket
  4. val text: DataStream[String] = env.socketTextStream(hostname, port, '\n')
  6. // parse the data, group it, window it, and aggregate the counts
  7. val result: DataStream[(String, Long)] = text
  8.   // split up the lines in pairs (2-tuples) containing: (word,1)
  9.   .flatMap(_.toLowerCase.split("\\s"))
  10.   .filter(_.nonEmpty)
  11.   .map((_, 1L))
  12.   // group by the tuple field "0" and sum up tuple field "1"
  13.   .keyBy(_._1)
  14.   .window(TumblingProcessingTimeWindows.of(Time.seconds(5)))
  15.   .sum(1)
  17. CassandraSink.addSink(result)
  18.   .setQuery("INSERT INTO example.wordcount(word, count) values (?, ?);")
  19.   .setHost("127.0.0.1")
  20.   .build()
  22. result.print().setParallelism(1)

Cassandra Sink Example for Streaming POJO Data Type

An example of streaming a POJO data type and store the same POJO entity back to Cassandra. In addition, this POJO implementation needs to follow DataStax Java Driver Manual to annotate the class as each field of this entity is mapped to an associated column of the designated table using the DataStax Java Driver com.datastax.driver.mapping.Mapper class.

The mapping of each table column can be defined through annotations placed on a field declaration in the Pojo class. For details of the mapping, please refer to CQL documentation on Definition of Mapped Classes and CQL Data types

Java

  1. // get the execution environment
  2. final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
  4. // get input data by connecting to the socket
  5. DataStream<String> text = env.socketTextStream(hostname, port, "\n");
  7. // parse the data, group it, window it, and aggregate the counts
  8. DataStream<WordCount> result = text
  9.         .flatMap(new FlatMapFunction<String, WordCount>() {
  10.             public void flatMap(String value, Collector<WordCount> out) {
  11.                 // normalize and split the line
  12.                 String[] words = value.toLowerCase().split("\\s");
  14.                 // emit the pairs
  15.                 for (String word : words) {
  16.                     if (!word.isEmpty()) {
  17.                         //Do not accept empty word, since word is defined as primary key in C* table
  18.                         out.collect(new WordCount(word, 1L));
  19.                     }
  20.                 }
  21.             }
  22.         })
  23.         .keyBy(WordCount::getWord)
  24.         .window(TumblingProcessingTimeWindows.of(Time.seconds(5)))
  26.         .reduce(new ReduceFunction<WordCount>() {
  27.             @Override
  28.             public WordCount reduce(WordCount a, WordCount b) {
  29.                 return new WordCount(a.getWord(), a.getCount() + b.getCount());
  30.             }
  31.         });
  33. CassandraSink.addSink(result)
  34.         .setHost("127.0.0.1")
  35.         .setMapperOptions(() -> new Mapper.Option[]{Mapper.Option.saveNullFields(true)})
  36.         .build();
  39. @Table(keyspace = "example", name = "wordcount")
  40. public class WordCount {
  42.     @Column(name = "word")
  43.     private String word = "";
  45.     @Column(name = "count")
  46.     private long count = 0;
  48.     public WordCount() {}
  50.     public WordCount(String word, long count) {
  51.         this.setWord(word);
  52.         this.setCount(count);
  53.     }
  55.     public String getWord() {
  56.         return word;
  57.     }
  59.     public void setWord(String word) {
  60.         this.word = word;
  61.     }
  63.     public long getCount() {
  64.         return count;
  65.     }
  67.     public void setCount(long count) {
  68.         this.count = count;
  69.     }
  71.     @Override
  72.     public String toString() {
  73.         return getWord() + " : " + getCount();
  74.     }
  75. }