flink README

The project's README from github.com/apache/flink. As one markdown file: README.md.

Apache Flink

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

Learn more about Flink at https://flink.apache.org/

Features

Streaming Example

// pojo class WordWithCount
public class WordWithCount {
    public String word;
    public int count;

    public WordWithCount() {}
    
    public WordWithCount(String word, int count) {
        this.word = word;
        this.count = count;
    }
}

// main method
StreamExecutionEnvironment env = 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 -> new WordWithCount(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();
}

Batch Example

// pojo class WordWithCount
public class WordWithCount {
    public String word;
    public int count;

    public WordWithCount() {}

    public WordWithCount(String word, int count) {
        this.word = word;
        this.count = count;
    }
}

// main method
StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
env.setRuntimeMode(RuntimeExecutionMode.BATCH);
FileSource<String> source = FileSource.forRecordStreamFormat(new TextLineInputFormat(), new Path("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 -> new WordWithCount(word, 1)).returns(TypeInformation.of(WordWithCount.class))
        .keyBy(wordWithCount -> wordWithCount.word)
        .sum("count").returns(TypeInformation.of(WordWithCount.class));

windowCounts.print();
env.execute();

Prerequisites for building Flink:

Basic Build Instructions

First, clone the repository:

git clone https://github.com/apache/flink.git
cd 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 in build-target.

Notes

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:

IntelliJ IDEA

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

Check out our DEVELOPMENT.md guide for detailed IDE setup instructions.

Eclipse Scala IDE

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

We recommend to use IntelliJ instead (see above)

Support

Don’t hesitate to ask!

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

Open an issue if you find a bug in Flink.

Documentation

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

Fork and Contribute

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 describes how to contribute to Apache Flink.

Externalized Connectors

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

About

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

flink (apache/flink)

Searching Database…

26.4K ·GitHub
这是什么?Apache Flink 是一个开源流处理框架,具备强大的流处理和批处理能力,可以在它自己的分布式运行时上运行你的程序。
这是我要加到自己应用里的库,还是需要部署后在其上运行程序的系统?它是一个框架,不是库:你的 Java 程序运行在 Flink 以流为核心的运行时上,通常部署在集群里,和 YARN、HDFS、HBase 等 Hadoop 组件一起使用。
怎么把它搭建起来跑起来?克隆仓库,然后根据你的 Java 版本运行对应的 Maven 包装器构建命令:大约需要 10 分钟,Flink 会安装到 build-target 目录。完整文档在项目官网上。
构建之前我需要装好哪些东西?需要一个类 Unix 环境(Linux、Mac OS X、Cygwin 或 WSL)、Git,以及 Java 11、17 或 21。必须使用 Maven 3.9.16,不过自带的 mvnw 包装器会确保用到正确的版本。
构建时有什么要注意的坑吗?JAVA_HOME 必须指向与你所选 Java 版本匹配的 JDK,而且每个版本都需要单独的 Maven profile 和 -Djdk 参数。README 建议加上 -DskipTests 来加快构建。
它怎么连接 Kafka、数据库和其他系统?通过 Apache 软件基金会下属的独立 connector 仓库:flink-connector-kafka、flink-connector-jdbc,另外还有 Elasticsearch、Cassandra、MongoDB、Pulsar、RabbitMQ 等系统的 connector。
“以流为核心”实际是什么意思?DataStream API 支持事件时间和乱序处理,窗口机制灵活(按时间、按条数、会话、自定义触发器),提供精确一次(exactly-once)的容错保障,事件延迟低,并且自带天然的反压机制。
除了核心 API 之外,它还自带哪些库?有用于图计算(批处理)、机器学习(批处理)和复杂事件处理(流处理)的库,另外还有自定义内存管理,可以在内存内处理和核外处理之间切换。
Flink 是怎么来的?它源自 Stratosphere 研究项目,现在是 Apache 软件基金会的项目;开发团队使用 IntelliJ IDEA 进行开发,IDE 的配置方法写在 DEVELOPMENT.md 里。
Creator
apache
Size
543.6 MB
Stars
26.4K
Updated
CommitOct 18
Age
12y
Commits · 90 Days