Repository files navigation

Apache Flink is an open source stream processing framework with powerful stream- and batch-processing capabilities.

Learn more about Flink athttps://flink.apache.org/

• A streaming-first runtime that supports both batch processing and data streaming programs

• Elegant and fluent APIs in Java

• A runtime that supports very high throughput and low event latency at the same time

• Support forevent time andout-of-order processing in the DataStream API, based on theDataflow Model

• Flexible windowing (time, count, sessions, custom triggers) across different time semantics (event time, processing time)

• Fault-tolerance withexactly-once processing guarantees

• Natural back-pressure in streaming programs

• Libraries for Graph processing (batch), Machine Learning (batch), and Complex Event Processing (streaming)

• Custom memory management for efficient and robust switching between in-memory and out-of-core data processing algorithms

• Compatibility layers for Apache Hadoop MapReduce

• Integration with YARN, HDFS, HBase, and other components of the Apache Hadoop ecosystem

// pojo class WordWithCountpublicclassWordWithCount {publicStringword;publicintcount;publicWordWithCount() {}publicWordWithCount(Stringword,intcount) {this.word =word;this.count =count;    }}// main methodStreamExecutionEnvironmentenv =StreamExecutionEnvironment.getExecutionEnvironment();DataStreamSource<String>text =env.socketTextStream(host,port);DataStream<WordWithCount>windowCounts =text    .flatMap(        (FlatMapFunction<String,String>) (line,collector)             ->Arrays.stream(line.split("\\s")).forEach(collector::collect)    ).returns(String.class)    .map(word ->newWordWithCount(word,1)).returns(TypeInformation.of(WordWithCount.class))    .keyBy(wordWithCnt ->wordWithCnt.word)    .window(TumblingProcessingTimeWindows.of(Duration.ofSeconds(5)))    .sum("count").returns(TypeInformation.of(WordWithCount.class));windowCounts.print();env.execute();}

// pojo class WordWithCountpublicclassWordWithCount {publicStringword;publicintcount;publicWordWithCount() {}publicWordWithCount(Stringword,intcount) {this.word =word;this.count =count;    }}// main methodStreamExecutionEnvironmentenv =StreamExecutionEnvironment.getExecutionEnvironment();env.setRuntimeMode(RuntimeExecutionMode.BATCH);FileSource<String>source =FileSource.forRecordStreamFormat(newTextLineInputFormat(),newPath("MyInput.txt")).build();DataStreamSource<String>text =env.fromSource(source,WatermarkStrategy.noWatermarks(),"MySource");DataStream<WordWithCount>windowCounts =text        .flatMap((FlatMapFunction<String,String>) (line,collector) ->Arrays                .stream(line.split("\\s"))                .forEach(collector::collect)).returns(String.class)        .map(word ->newWordWithCount(word,1)).returns(TypeInformation.of(WordWithCount.class))        .keyBy(wordWintCount ->wordWintCount.word)        .sum("count").returns(TypeInformation.of(WordWithCount.class));windowCounts.print();env.execute();

Prerequisites for building Flink:

• Unix-like environment (we use Linux, Mac OS X, Cygwin, WSL)
• Git
• Maven (we require version 3.8.6)
• Java (version 11, 17, or 21)

First, clone the repository:

git clone https://github.com/apache/flink.gitcd flink

Then, choose one of the following commands based on your preferred Java version:

For Java 11

./mvnw clean package -DskipTests -Djdk11 -Pjava11-target

For Java 17 (Default)

./mvnw clean package -DskipTests -Djdk17 -Pjava17-target

For Java 21

./mvnw clean package -DskipTests -Djdk21 -Pjava21-target

The build process will take approximately 10 minutes to complete.Flink will be installed inbuild-target.

• Make sure your JAVA_HOME environment variable points to the correct JDK version
• The build command uses Maven wrapper (mvnw) which ensures the correct Maven version is used
• The -DskipTests flag skips running tests to speed up the build process
• Each Java version requires its corresponding profile (-Pjava-target) and JDK flag (-Djdk)

The Flink committers use IntelliJ IDEA to develop the Flink codebase.We recommend IntelliJ IDEA for developing projects that involve Scala code.

Minimal requirements for an IDE are:

• Support for Java and Scala (also mixed projects)
• Support for Maven with Java and Scala

The IntelliJ IDE supports Maven out of the box and offers a plugin for Scala development.

• IntelliJ download:https://www.jetbrains.com/idea/
• IntelliJ Scala Plugin:https://plugins.jetbrains.com/plugin/?id=1347

Check out ourSetting up IntelliJ guide for details.

NOTE: From our experience, this setup does not work with Flinkdue to deficiencies of the old Eclipse version bundled with Scala IDE 3.0.3 ordue to version incompatibilities with the bundled Scala version in Scala IDE 4.4.1.

We recommend to use IntelliJ instead (see above)

Don’t hesitate to ask!

Contact the developers and community on themailing lists if you need any help.

Open an issue if you find a bug in Flink.

The documentation of Apache Flink is located on the website:https://flink.apache.orgor in thedocs/ directory of the source code.

This is an active open-source project. We are always open to people who want to use the system or contribute to it.Contact us if you are looking for implementation tasks that fit your skills.This article describeshow to contribute to Apache Flink.

Most Flink connectors have been externalized to individual repos under theApache Software Foundation:

• flink-connector-aws
• flink-connector-cassandra
• flink-connector-elasticsearch
• flink-connector-gcp-pubsub
• flink-connector-hbase
• flink-connector-hive
• flink-connector-jdbc
• flink-connector-kafka
• flink-connector-mongodb
• flink-connector-opensearch
• flink-connector-prometheus
• flink-connector-pulsar
• flink-connector-rabbitmq

Apache Flink is an open source project of The Apache Software Foundation (ASF).The Apache Flink project originated from theStratosphere research project.