http://git-wip-us.apache.org/repos/asf/flink/blob/844c874b/docs/apis/common/index.md ---------------------------------------------------------------------- diff --git a/docs/apis/common/index.md b/docs/apis/common/index.md deleted file mode 100644 index 05d87ce..0000000 --- a/docs/apis/common/index.md +++ /dev/null @@ -1,1352 +0,0 @@ ---- -title: "Basic API Concepts" - -# Top-level navigation -top-nav-group: apis -top-nav-pos: 1 -top-nav-title: <strong>Basic API Concepts</strong> ---- -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -Flink programs are regular programs that implement transformations on distributed collections -(e.g., filtering, mapping, updating state, joining, grouping, defining windows, aggregating). -Collections are initially created from sources (e.g., by reading files, kafka, or from local -collections). Results are returned via sinks, which may for example write the data to -(distributed) files, or to standard output (for example the command line terminal). -Flink programs run in a variety of contexts, standalone, or embedded in other programs. -The execution can happen in a local JVM, or on clusters of many machines. - -Depending on the type of data sources, i.e. bounded or unbounded sources you would either -write a batch program or a streaming program where the DataSet API is used for the former -and the DataStream API is used for the latter. This guide will introduce the basic concepts -that are common to both APIs but please see our -[Streaming Guide]({{ site.baseurl }}/apis/streaming/index.html) and -[Batch Guide]({{ site.baseurl }}/apis/batch/index.html) for concrete information about -writing programs with each API. - -**NOTE:** When showing actual examples of how the APIs can be used we will use -`StreamingExecutionEnvironment` and the `DataStream` API. The concepts are exactly the same -in the `DataSet` API, just replace by `ExecutionEnvironment` and `DataSet`. - -* This will be replaced by the TOC -{:toc} - -Linking with Flink ------------------- - -To write programs with Flink, you need to include the Flink library corresponding to -your programming language in your project. - -The simplest way to do this is to use one of the quickstart scripts: either for -[Java]({{ site.baseurl }}/quickstart/java_api_quickstart.html) or for [Scala]({{ site.baseurl }}/quickstart/scala_api_quickstart.html). They -create a blank project from a template (a Maven Archetype), which sets up everything for you. To -manually create the project, you can use the archetype and create a project by calling: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight bash %} -mvn archetype:generate \ - -DarchetypeGroupId=org.apache.flink \ - -DarchetypeArtifactId=flink-quickstart-java \ - -DarchetypeVersion={{site.version }} -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight bash %} -mvn archetype:generate \ - -DarchetypeGroupId=org.apache.flink \ - -DarchetypeArtifactId=flink-quickstart-scala \ - -DarchetypeVersion={{site.version }} -{% endhighlight %} -</div> -</div> - -The archetypes are working for stable releases and preview versions (`-SNAPSHOT`). - -If you want to add Flink to an existing Maven project, add the following entry to your -*dependencies* section in the *pom.xml* file of your project: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight xml %} -<!-- Use this dependency if you are using the DataStream API --> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-streaming-java{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version }}</version> -</dependency> -<!-- Use this dependency if you are using the DataSet API --> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-java</artifactId> - <version>{{site.version }}</version> -</dependency> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-clients{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version }}</version> -</dependency> -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight xml %} -<!-- Use this dependency if you are using the DataStream API --> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-streaming-scala{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version }}</version> -</dependency> -<!-- Use this dependency if you are using the DataSet API --> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-scala{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version }}</version> -</dependency> -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-clients{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version }}</version> -</dependency> -{% endhighlight %} - -**Important:** When working with the Scala API you must have one of these two imports: -{% highlight scala %} -import org.apache.flink.api.scala._ -{% endhighlight %} - -or - -{% highlight scala %} -import org.apache.flink.api.scala.createTypeInformation -{% endhighlight %} - -The reason is that Flink analyzes the types that are used in a program and generates serializers -and comparaters for them. By having either of those imports you enable an implicit conversion -that creates the type information for Flink operations. -</div> -</div> - -#### Scala Dependency Versions - -Because Scala 2.10 binary is not compatible with Scala 2.11 binary, we provide multiple artifacts -to support both Scala versions. - -Starting from the 0.10 line, we cross-build all Flink modules for both 2.10 and 2.11. If you want -to run your program on Flink with Scala 2.11, you need to add a `_2.11` suffix to the `artifactId` -values of the Flink modules in your dependencies section. - -If you are looking for building Flink with Scala 2.11, please check -[build guide]({{ site.baseurl }}/setup/building.html#scala-versions). - -#### Hadoop Dependency Versions - -If you are using Flink together with Hadoop, the version of the dependency may vary depending on the -version of Hadoop (or more specifically, HDFS) that you want to use Flink with. Please refer to the -[downloads page](http://flink.apache.org/downloads.html) for a list of available versions, and instructions -on how to link with custom versions of Hadoop. - -In order to link against the latest SNAPSHOT versions of the code, please follow -[this guide](http://flink.apache.org/how-to-contribute.html#snapshots-nightly-builds). - -The *flink-clients* dependency is only necessary to invoke the Flink program locally (for example to -run it standalone for testing and debugging). If you intend to only export the program as a JAR -file and [run it on a cluster]({{ site.baseurl }}/apis/cluster_execution.html), you can skip that dependency. - -{% top %} - -DataSet and DataStream ----------------------- - -Flink has the special classes `DataSet` and `DataStream` to represent data in a program. You -can think of them as immutable collections of data that can contain duplicates. In the case -of `DataSet` the data is finite while for a `DataStream` the number of elements can be unbounded. - -These collections differ from regular Java collections in some key ways. First, they -are immutable, meaning that once they are created you cannot add or remove elements. You can also -not simply inspect the elements inside. - -A collection is initially created by adding a source in a Flink program and new collections are -derived from these by transforming them using API methods such as `map`, `filter` and so on. - -Anatomy of a Flink Program --------------------------- - -Flink program programs look like regular programs that transform collections of data. -Each program consists of the same basic parts: - -1. Obtain an `execution environment`, -2. Load/create the initial data, -3. Specify transformations on this data, -4. Specify where to put the results of your computations, -5. Trigger the program execution - - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> - - -We will now give an overview of each of those steps, please refer to the respective sections for -more details. Note that all core classes of the Java DataSet API are found in the package -{% gh_link /flink-java/src/main/java/org/apache/flink/api/java "org.apache.flink.api.java" %} -while the classes of the Java DataStream API can be found in -{% gh_link /flink-streaming-java/src/main/java/org/apache/flink/streaming/api "org.apache.flink.streaming.api" %}. - -The `StreamExecutionEnvironment` is the basis for all Flink programs. You can -obtain one using these static methods on `StreamExecutionEnvironment`: - -{% highlight java %} -getExecutionEnvironment() - -createLocalEnvironment() - -createRemoteEnvironment(String host, int port, String... jarFiles) -{% endhighlight %} - -Typically, you only need to use `getExecutionEnvironment()`, since this -will do the right thing depending on the context: if you are executing -your program inside an IDE or as a regular Java program it will create -a local environment that will execute your program on your local machine. If -you created a JAR file from your program, and invoke it through the -[command line]({{ site.baseurl }}/apis/cli.html), the Flink cluster manager -will execute your main method and `getExecutionEnvironment()` will return -an execution environment for executing your program on a cluster. - -For specifying data sources the execution environment has several methods -to read from files using various methods: you can just read them line by line, -as CSV files, or using completely custom data input formats. To just read -a text file as a sequence of lines, you can use: - -{% highlight java %} -final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); - -DataStream<String> text = env.readTextFile("file:///path/to/file"); -{% endhighlight %} - -This will give you a DataStream on which you can then apply transformations to create new -derived DataStreams. - -You apply transformations by calling methods on DataStream with a transformation -functions. For example, a map transformation looks like this: - -{% highlight java %} -DataStream<String> input = ...; - -DataStream<Integer> parsed = input.map(new MapFunction<String, Integer>() { - @Override - public Integer map(String value) { - return Integer.parseInt(value); - } -}); -{% endhighlight %} - -This will create a new DataStream by converting every String in the original -collection to an Integer. - -Once you have a DataStream containing your final results, you can write it to an outside system -by creating a sink. These are just some example methods for creating a sink: - -{% highlight java %} -writeAsText(String path) - -print() -{% endhighlight %} - -</div> -<div data-lang="scala" markdown="1"> - -We will now give an overview of each of those steps, please refer to the respective sections for -more details. Note that all core classes of the Scala DataSet API are found in the package -{% gh_link /flink-scala/src/main/scala/org/apache/flink/api/scala "org.apache.flink.api.scala" %} -while the classes of the Scala DataStream API can be found in -{% gh_link /flink-streaming-scala/src/main/java/org/apache/flink/streaming/api/scala "org.apache.flink.streaming.api.scala" %}. - -The `StreamExecutionEnvironment` is the basis for all Flink programs. You can -obtain one using these static methods on `StreamExecutionEnvironment`: - -{% highlight scala %} -getExecutionEnvironment() - -createLocalEnvironment() - -createRemoteEnvironment(host: String, port: Int, jarFiles: String*) -{% endhighlight %} - -Typically, you only need to use `getExecutionEnvironment()`, since this -will do the right thing depending on the context: if you are executing -your program inside an IDE or as a regular Java program it will create -a local environment that will execute your program on your local machine. If -you created a JAR file from your program, and invoke it through the -[command line]({{ site.baseurl }}/apis/cli.html), the Flink cluster manager -will execute your main method and `getExecutionEnvironment()` will return -an execution environment for executing your program on a cluster. - -For specifying data sources the execution environment has several methods -to read from files using various methods: you can just read them line by line, -as CSV files, or using completely custom data input formats. To just read -a text file as a sequence of lines, you can use: - -{% highlight scala %} -val env = StreamExecutionEnvironment.getExecutionEnvironment() - -val text: DataStream[String] = env.readTextFile("file:///path/to/file") -{% endhighlight %} - -This will give you a DataStream on which you can then apply transformations to create new -derived DataStreams. - -You apply transformations by calling methods on DataSet with a transformation -functions. For example, a map transformation looks like this: - -{% highlight scala %} -val input: DataSet[String] = ... - -val mapped = input.map { x => x.toInt } -{% endhighlight %} - -This will create a new DataStream by converting every String in the original -collection to an Integer. - -Once you have a DataStream containing your final results, you can write it to an outside system -by creating a sink. These are just some example methods for creating a sink: - -{% highlight scala %} -writeAsText(path: String) - -print() -{% endhighlight %} - -</div> -</div> - -Once you specified the complete program you need to **trigger the program execution** by calling -`execute()` on the `StreamExecutionEnvironment`. -Depending on the type of the `ExecutionEnvironment` the execution will be triggered on your local -machine or submit your program for execution on a cluster. - -The `execute()` method is returning a `JobExecutionResult`, this contains execution -times and accumulator results. - -Please see the [Streaming Guide]({{ site.baseurl }}/apis/streaming/index.html) -for information about streaming data sources and sink and for more in-depths information -about the supported transformations on DataStream. - -Check out the [Batch Guide]({{ site.baseurl }}/apis/batch/index.html) -for information about batch data sources and sink and for more in-depths information -about the supported transformations on DataSet. - - -{% top %} - -Lazy Evaluation ---------------- - -All Flink programs are executed lazily: When the program's main method is executed, the data loading -and transformations do not happen directly. Rather, each operation is created and added to the -program's plan. The operations are actually executed when the execution is explicitly triggered by -an `execute()` call on the execution environment. Whether the program is executed locally -or on a cluster depends on the type of execution environment - -The lazy evaluation lets you construct sophisticated programs that Flink executes as one -holistically planned unit. - -{% top %} - -Specifying Keys ---------------- - -Some transformations (join, coGroup, keyBy, groupBy) require that a key be defined on -a collection of elements. Other transformations (Reduce, GroupReduce, -Aggregate, Windows) allow data being grouped on a key before they are -applied. - -A DataSet is grouped as -{% highlight java %} -DataSet<...> input = // [...] -DataSet<...> reduced = input - .groupBy(/*define key here*/) - .reduceGroup(/*do something*/); -{% endhighlight %} - -while a key can be specified on a DataStream using -{% highlight java %} -DataStream<...> input = // [...] -DataStream<...> windowed = input - .key(/*define key here*/) - .window(/*window specification*/); -{% endhighlight %} - -The data model of Flink is not based on key-value pairs. Therefore, -you do not need to physically pack the data set types into keys and -values. Keys are "virtual": they are defined as functions over the -actual data to guide the grouping operator. - -**NOTE:** In the following discussion we will use the `DataStream` API and `keyBy`. -For the DataSet API you just have to replace by `DataSet` and `groupBy`. - -### Define keys for Tuples -{:.no_toc} - -The simplest case is grouping Tuples on one or more -fields of the Tuple: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -DataStream<Tuple3<Integer,String,Long>> input = // [...] -KeyedStream<Tuple3<Integer,String,Long> keyed = input.keyBy(0) -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val input: DataStream[(Int, String, Long)] = // [...] -val keyed = input.keyBy(0) -{% endhighlight %} -</div> -</div> - -The tuples is grouped on the first field (the one of -Integer type). - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -DataStream<Tuple3<Integer,String,Long>> input = // [...] -KeyedStream<Tuple3<Integer,String,Long> keyed = input.keyBy(0,1) -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val input: DataSet[(Int, String, Long)] = // [...] -val grouped = input.groupBy(0,1) -{% endhighlight %} -</div> -</div> - -Here, we group the tuples on a composite key consisting of the first and the -second field. - -A note on nested Tuples: If you have a DataStream with a nested tuple, such as: - -{% highlight java %} -DataStream<Tuple3<Tuple2<Integer, Float>,String,Long>> ds; -{% endhighlight %} - -Specifying `keyBy(0)` will cause the system to use the full `Tuple2` as a key (with the Integer and Float being the key). If you want to "navigate" into the nested `Tuple2`, you have to use field expression keys which are explained below. - -### Define keys using Field Expressions -{:.no_toc} - -You can use String-based field expressions to reference nested fields and define keys for grouping, sorting, joining, or coGrouping. - -Field expressions make it very easy to select fields in (nested) composite types such as [Tuple](#tuples-and-case-classes) and [POJO](#pojos) types. - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> - -In the example below, we have a `WC` POJO with two fields "word" and "count". To group by the field `word`, we just pass its name to the `groupBy()` function. -{% highlight java %} -// some ordinary POJO (Plain old Java Object) -public class WC { - public String word; - public int count; -} -DataStream<WC> words = // [...] -DataStream<WC> wordCounts = words.keyBy("word").window(/*window specification*/); -{% endhighlight %} - -**Field Expression Syntax**: - -- Select POJO fields by their field name. For example `"user"` refers to the "user" field of a POJO type. - -- Select Tuple fields by their field name or 0-offset field index. For example `"f0"` and `"5"` refer to the first and sixth field of a Java Tuple type, respectively. - -- You can select nested fields in POJOs and Tuples. For example `"user.zip"` refers to the "zip" field of a POJO which is stored in the "user" field of a POJO type. Arbitrary nesting and mixing of POJOs and Tuples is supported such as `"f1.user.zip"` or `"user.f3.1.zip"`. - -- You can select the full type using the `"*"` wildcard expressions. This does also work for types which are not Tuple or POJO types. - -**Field Expression Example**: - -{% highlight java %} -public static class WC { - public ComplexNestedClass complex; //nested POJO - private int count; - // getter / setter for private field (count) - public int getCount() { - return count; - } - public void setCount(int c) { - this.count = c; - } -} -public static class ComplexNestedClass { - public Integer someNumber; - public float someFloat; - public Tuple3<Long, Long, String> word; - public IntWritable hadoopCitizen; -} -{% endhighlight %} - -These are valid field expressions for the example code above: - -- `"count"`: The count field in the `WC` class. - -- `"complex"`: Recursively selects all fields of the field complex of POJO type `ComplexNestedClass`. - -- `"complex.word.f2"`: Selects the last field of the nested `Tuple3`. - -- `"complex.hadoopCitizen"`: Selects the Hadoop `IntWritable` type. - -</div> -<div data-lang="scala" markdown="1"> - -In the example below, we have a `WC` POJO with two fields "word" and "count". To group by the field `word`, we just pass its name to the `groupBy()` function. -{% highlight java %} -// some ordinary POJO (Plain old Java Object) -class WC(var word: String, var count: Int) { - def this() { this("", 0L) } -} -val words: DataStream[WC] = // [...] -val wordCounts = words.keyBy("word").window(/*window specification*/) - -// or, as a case class, which is less typing -case class WC(word: String, count: Int) -val words: DataStream[WC] = // [...] -val wordCounts = words.keyBy("word").window(/*window specification*/) -{% endhighlight %} - -**Field Expression Syntax**: - -- Select POJO fields by their field name. For example `"user"` refers to the "user" field of a POJO type. - -- Select Tuple fields by their 1-offset field name or 0-offset field index. For example `"_1"` and `"5"` refer to the first and sixth field of a Scala Tuple type, respectively. - -- You can select nested fields in POJOs and Tuples. For example `"user.zip"` refers to the "zip" field of a POJO which is stored in the "user" field of a POJO type. Arbitrary nesting and mixing of POJOs and Tuples is supported such as `"_2.user.zip"` or `"user._4.1.zip"`. - -- You can select the full type using the `"_"` wildcard expressions. This does also work for types which are not Tuple or POJO types. - -**Field Expression Example**: - -{% highlight scala %} -class WC(var complex: ComplexNestedClass, var count: Int) { - def this() { this(null, 0) } -} - -class ComplexNestedClass( - var someNumber: Int, - someFloat: Float, - word: (Long, Long, String), - hadoopCitizen: IntWritable) { - def this() { this(0, 0, (0, 0, ""), new IntWritable(0)) } -} -{% endhighlight %} - -These are valid field expressions for the example code above: - -- `"count"`: The count field in the `WC` class. - -- `"complex"`: Recursively selects all fields of the field complex of POJO type `ComplexNestedClass`. - -- `"complex.word._3"`: Selects the last field of the nested `Tuple3`. - -- `"complex.hadoopCitizen"`: Selects the Hadoop `IntWritable` type. - -</div> -</div> - -### Define keys using Key Selector Functions -{:.no_toc} - -An additional way to define keys are "key selector" functions. A key selector function -takes a single element as input and returns the key for the element. The key can be of any type and be derived from arbitrary computations. - -The following example shows a key selector function that simply returns the field of an object: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -// some ordinary POJO -public class WC {public String word; public int count;} -DataStream<WC> words = // [...] -KeyedStream<WC> kyed = words - .keyBy(new KeySelector<WC, String>() { - public String getKey(WC wc) { return wc.word; } - }); -{% endhighlight %} - -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -// some ordinary case class -case class WC(word: String, count: Int) -val words: DataStream[WC] = // [...] -val keyed = words.keyBy( _.word ) -{% endhighlight %} -</div> -</div> - -{% top %} - -Specifying Transformation Functions --------------------------- - -Most transformations require user-defined functions. This section lists different ways -of how they can be specified - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> - -#### Implementing an interface - -The most basic way is to implement one of the provided interfaces: - -{% highlight java %} -class MyMapFunction implements MapFunction<String, Integer> { - public Integer map(String value) { return Integer.parseInt(value); } -}); -data.map(new MyMapFunction()); -{% endhighlight %} - -#### Anonymous classes - -You can pass a function as an anonymous class: -{% highlight java %} -data.map(new MapFunction<String, Integer> () { - public Integer map(String value) { return Integer.parseInt(value); } -}); -{% endhighlight %} - -#### Java 8 Lambdas - -Flink also supports Java 8 Lambdas in the Java API. Please see the full [Java 8 Guide]({{ site.baseurl }}/apis/java8.html). - -{% highlight java %} -data.filter(s -> s.startsWith("http://";)); -{% endhighlight %} - -{% highlight java %} -data.reduce((i1,i2) -> i1 + i2); -{% endhighlight %} - -#### Rich functions - -All transformations that require a user-defined function can -instead take as argument a *rich* function. For example, instead of - -{% highlight java %} -class MyMapFunction implements MapFunction<String, Integer> { - public Integer map(String value) { return Integer.parseInt(value); } -}); -{% endhighlight %} - -you can write - -{% highlight java %} -class MyMapFunction extends RichMapFunction<String, Integer> { - public Integer map(String value) { return Integer.parseInt(value); } -}); -{% endhighlight %} - -and pass the function as usual to a `map` transformation: - -{% highlight java %} -data.map(new MyMapFunction()); -{% endhighlight %} - -Rich functions can also be defined as an anonymous class: -{% highlight java %} -data.map (new RichMapFunction<String, Integer>() { - public Integer map(String value) { return Integer.parseInt(value); } -}); -{% endhighlight %} - -</div> -<div data-lang="scala" markdown="1"> - - -#### Lambda Functions - -As already seen in previous examples all operations accept lambda functions for describing -the operation: -{% highlight scala %} -val data: DataSet[String] = // [...] -data.filter { _.startsWith("http://";) } -{% endhighlight %} - -{% highlight scala %} -val data: DataSet[Int] = // [...] -data.reduce { (i1,i2) => i1 + i2 } -// or -data.reduce { _ + _ } -{% endhighlight %} - -#### Rich functions - -All transformations that take as argument a lambda function can -instead take as argument a *rich* function. For example, instead of - -{% highlight scala %} -data.map { x => x.toInt } -{% endhighlight %} - -you can write - -{% highlight scala %} -class MyMapFunction extends RichMapFunction[String, Int] { - def map(in: String):Int = { in.toInt } -}) -{% endhighlight %} - -and pass the function to a `map` transformation: - -{% highlight scala %} -data.map(new MyMapFunction()) -{% endhighlight %} - -Rich functions can also be defined as an anonymous class: -{% highlight scala %} -data.map (new RichMapFunction[String, Int] { - def map(in: String):Int = { in.toInt } -}) -{% endhighlight %} -</div> - -</div> - -Rich functions provide, in addition to the user-defined function (map, -reduce, etc), four methods: `open`, `close`, `getRuntimeContext`, and -`setRuntimeContext`. These are useful for parameterizing the function -(see [Passing Parameters to Functions]({{ site.baseurl }}/apis/batch/index.html#passing-parameters-to-functions)), -creating and finalizing local state, accessing broadcast variables (see -[Broadcast Variables]({{ site.baseurl }}/apis/batch/index.html#broadcast-variables), and for accessing runtime -information such as accumulators and counters (see -[Accumulators and Counters](#accumulators--counters), and information -on iterations (see [Iterations]({{ site.baseurl }}/apis/batch/iterations.html)). - -{% top %} - -Supported Data Types --------------------- - -Flink places some restrictions on the type of elements that can be in a DataSet or DataStream. -The reason for this is that the system analyzes the types to determine -efficient execution strategies. - -There are six different categories of data types: - -1. **Java Tuples** and **Scala Case Classes** -2. **Java POJOs** -3. **Primitive Types** -4. **Regular Classes** -5. **Values** -6. **Hadoop Writables** -7. **Special Types** - -#### Tuples and Case Classes - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> - -Tuples are composite types that contain a fixed number of fields with various types. -The Java API provides classes from `Tuple1` up to `Tuple25`. Every field of a tuple -can be an arbitrary Flink type including further tuples, resulting in nested tuples. Fields of a -tuple can be accessed directly using the field's name as `tuple.f4`, or using the generic getter method -`tuple.getField(int position)`. The field indices start at 0. Note that this stands in contrast -to the Scala tuples, but it is more consistent with Java's general indexing. - -{% highlight java %} -DataStream<Tuple2<String, Integer>> wordCounts = env.fromElements( - new Tuple2<String, Integer>("hello", 1), - new Tuple2<String, Integer>("world", 2)); - -wordCounts.map(new MapFunction<Tuple2<String, Integer>, Integer>() { - @Override - public String map(Tuple2<String, Integer> value) throws Exception { - return value.f1; - } -}); - -wordCounts.keyBy(0); // also valid .keyBy("f0") - - -{% endhighlight %} - -</div> -<div data-lang="scala" markdown="1"> - -Scala case classes (and Scala tuples which are a special case of case classes), are composite types that contain a fixed number of fields with various types. Tuple fields are addressed by their 1-offset names such as `_1` for the first field. Case class fields are accessed by their name. - -{% highlight scala %} -case class WordCount(word: String, count: Int) -val input = env.fromElements( - WordCount("hello", 1), - WordCount("world", 2)) // Case Class Data Set - -input.keyBy("word")// key by field expression "word" - -val input2 = env.fromElements(("hello", 1), ("world", 2)) // Tuple2 Data Set - -input2.keyBy(0, 1) // key by field positions 0 and 1 -{% endhighlight %} - -</div> -</div> - -#### POJOs - -Java and Scala classes are treated by Flink as a special POJO data type if they fulfill the following requirements: - -- The class must be public. - -- It must have a public constructor without arguments (default constructor). - -- All fields are either public or must be accessible through getter and setter functions. For a field called `foo` the getter and setter methods must be named `getFoo()` and `setFoo()`. - -- The type of a field must be supported by Flink. At the moment, Flink uses [Avro](http://avro.apache.org) to serialize arbitrary objects (such as `Date`). - -Flink analyzes the structure of POJO types, i.e., it learns about the fields of a POJO. As a result POJO types are easier to use than general types. Moreover, Flink can process POJOs more efficiently than general types. - -The following example shows a simple POJO with two public fields. - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -public class WordWithCount { - - public String word; - public int count; - - public WordWithCount() {} - - public WordWithCount(String word, int count) { - this.word = word; - this.count = count; - } -} - -DataStream<WordWithCount> wordCounts = env.fromElements( - new WordWithCount("hello", 1), - new WordWithCount("world", 2)); - -wordCounts.keyBy("word"); // key by field expression "word" - -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -class WordWithCount(var word: String, var count: Int) { - def this() { - this(null, -1) - } -} - -val input = env.fromElements( - new WordWithCount("hello", 1), - new WordWithCount("world", 2)) // Case Class Data Set - -input.keyBy("word")// key by field expression "word" - -{% endhighlight %} -</div> -</div> - -#### Primitive Types - -Flink supports all Java and Scala primitive types such as `Integer`, `String`, and `Double`. - -#### General Class Types - -Flink supports most Java and Scala classes (API and custom). -Restrictions apply to classes containing fields that cannot be serialized, like file pointers, I/O streams, or other native -resources. Classes that follow the Java Beans conventions work well in general. - -All classes that are not identified as POJO types (see POJO requirements above) are handled by Flink as general class types. -Flink treats these data types as black boxes and is not able to access their their content (i.e., for efficient sorting). General types are de/serialized using the serialization framework [Kryo](https://github.com/EsotericSoftware/kryo). - -#### Values - -*Value* types describe their serialization and deserialization manually. Instead of going through a -general purpose serialization framework, they provide custom code for those operations by means of -implementing the `org.apache.flinktypes.Value` interface with the methods `read` and `write`. Using -a Value type is reasonable when general purpose serialization would be highly inefficient. An -example would be a data type that implements a sparse vector of elements as an array. Knowing that -the array is mostly zero, one can use a special encoding for the non-zero elements, while the -general purpose serialization would simply write all array elements. - -The `org.apache.flinktypes.CopyableValue` interface supports manual internal cloning logic in a -similar way. - -Flink comes with pre-defined Value types that correspond to basic data types. (`ByteValue`, -`ShortValue`, `IntValue`, `LongValue`, `FloatValue`, `DoubleValue`, `StringValue`, `CharValue`, -`BooleanValue`). These Value types act as mutable variants of the basic data types: Their value can -be altered, allowing programmers to reuse objects and take pressure off the garbage collector. - - -#### Hadoop Writables - -You can use types that implement the `org.apache.hadoop.Writable` interface. The serialization logic -defined in the `write()`and `readFields()` methods will be used for serialization. - -#### Special Types - -You can use special types, including Scala's `Either`, `Option`, and `Try`. -The Java API has its own custom implementation of `Either`. -Similarly to Scala's `Either`, it represents a value of one two possible types, *Left* or *Right*. -`Either` can be useful for error handling or operators that need to output two different types of records. - -#### Type Erasure & Type Inference - -*Note: This Section is only relevant for Java.* - -The Java compiler throws away much of the generic type information after compilation. This is -known as *type erasure* in Java. It means that at runtime, an instance of an object does not know -its generic type any more. For example, instances of `DataStream<String>` and `DataStream<Long>` look the -same to the JVM. - -Flink requires type information at the time when it prepares the program for execution (when the -main method of the program is called). The Flink Java API tries to reconstruct the type information -that was thrown away in various ways and store it explicitly in the data sets and operators. You can -retrieve the type via `DataStream.getType()`. The method returns an instance of `TypeInformation`, -which is Flink's internal way of representing types. - -The type inference has its limits and needs the "cooperation" of the programmer in some cases. -Examples for that are methods that create data sets from collections, such as -`ExecutionEnvironment.fromCollection(),` where you can pass an argument that describes the type. But -also generic functions like `MapFunction<I, O>` may need extra type information. - -The -{% gh_link /flink-core/src/main/java/org/apache/flink/api/java/typeutils/ResultTypeQueryable.java "ResultTypeQueryable" %} -interface can be implemented by input formats and functions to tell the API -explicitly about their return type. The *input types* that the functions are invoked with can -usually be inferred by the result types of the previous operations. - -Execution Configuration ------------------------ - -The `StreamExecutionEnvironment` also contains the `ExecutionConfig` which allows to set job specific configuration values for the runtime. - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); -ExecutionConfig executionConfig = env.getConfig(); -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val env = StreamExecutionEnvironment.getExecutionEnvironment -var executionConfig = env.getConfig -{% endhighlight %} -</div> -</div> - -The following configuration options are available: (the default is bold) - -- **`enableClosureCleaner()`** / `disableClosureCleaner()`. The closure cleaner is enabled by default. The closure cleaner removes unneeded references to the surrounding class of anonymous functions inside Flink programs. -With the closure cleaner disabled, it might happen that an anonymous user function is referencing the surrounding class, which is usually not Serializable. This will lead to exceptions by the serializer. - -- `getParallelism()` / `setParallelism(int parallelism)` Set the default parallelism for the job. - -- `getNumberOfExecutionRetries()` / `setNumberOfExecutionRetries(int numberOfExecutionRetries)` Sets the number of times that failed tasks are re-executed. A value of zero effectively disables fault tolerance. A value of `-1` indicates that the system default value (as defined in the configuration) should be used. - -- `getExecutionRetryDelay()` / `setExecutionRetryDelay(long executionRetryDelay)` Sets the delay in milliseconds that the system waits after a job has failed, before re-executing it. The delay starts after all tasks have been successfully been stopped on the TaskManagers, and once the delay is past, the tasks are re-started. This parameter is useful to delay re-execution in order to let certain time-out related failures surface fully (like broken connections that have not fully timed out), before attempting a re-execution and immediately failing again due to the same problem. This parameter only has an effect if the number of execution re-tries is one or more. - -- `getExecutionMode()` / `setExecutionMode()`. The default execution mode is PIPELINED. Sets the execution mode to execute the program. The execution mode defines whether data exchanges are performed in a batch or on a pipelined manner. - -- `enableForceKryo()` / **`disableForceKryo`**. Kryo is not forced by default. Forces the GenericTypeInformation to use the Kryo serializer for POJOS even though we could analyze them as a POJO. In some cases this might be preferable. For example, when Flink's internal serializers fail to handle a POJO properly. - -- `enableForceAvro()` / **`disableForceAvro()`**. Avro is not forced by default. Forces the Flink AvroTypeInformation to use the Avro serializer instead of Kryo for serializing Avro POJOs. - -- `enableObjectReuse()` / **`disableObjectReuse()`** By default, objects are not reused in Flink. Enabling the object reuse mode will instruct the runtime to reuse user objects for better performance. Keep in mind that this can lead to bugs when the user-code function of an operation is not aware of this behavior. - -- **`enableSysoutLogging()`** / `disableSysoutLogging()` JobManager status updates are printed to `System.out` by default. This setting allows to disable this behavior. - -- `getGlobalJobParameters()` / `setGlobalJobParameters()` This method allows users to set custom objects as a global configuration for the job. Since the `ExecutionConfig` is accessible in all user defined functions, this is an easy method for making configuration globally available in a job. - -- `addDefaultKryoSerializer(Class<?> type, Serializer<?> serializer)` Register a Kryo serializer instance for the given `type`. - -- `addDefaultKryoSerializer(Class<?> type, Class<? extends Serializer<?>> serializerClass)` Register a Kryo serializer class for the given `type`. - -- `registerTypeWithKryoSerializer(Class<?> type, Serializer<?> serializer)` Register the given type with Kryo and specify a serializer for it. By registering a type with Kryo, the serialization of the type will be much more efficient. - -- `registerKryoType(Class<?> type)` If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags (integer IDs) are written. If a type is not registered with Kryo, its entire class-name will be serialized with every instance, leading to much higher I/O costs. - -- `registerPojoType(Class<?> type)` Registers the given type with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written. If a type is not registered with Kryo, its entire class-name will be serialized with every instance, leading to much higher I/O costs. - -Note that types registered with `registerKryoType()` are not available to Flink's Kryo serializer instance. - -- `disableAutoTypeRegistration()` Automatic type registration is enabled by default. The automatic type registration is registering all types (including sub-types) used by usercode with Kryo and the POJO serializer. - -- `setTaskCancellationInterval(long interval)` Sets the the interval (in milliseconds) to wait between consecutive attempts to cancel a running task. When a task is canceled a new thread is created which periodically calls `interrupt()` on the task thread, if the task thread does not terminate within a certain time. This parameter refers to the time between consecutive calls to `interrupt()` and is set by default to **30000** milliseconds, or **30 seconds**. - -The `RuntimeContext` which is accessible in `Rich*` functions through the `getRuntimeContext()` method also allows to access the `ExecutionConfig` in all user defined functions. - -{% top %} - -Program Packaging and Distributed Execution ------------------------------------------ - -As described earlier, Flink programs can be executed on -clusters by using a `remote environment`. Alternatively, programs can be packaged into JAR Files -(Java Archives) for execution. Packaging the program is a prerequisite to executing them through the -[command line interface]({{ site.baseurl }}/apis/cli.html). - -#### Packaging Programs - -To support execution from a packaged JAR file via the command line or web interface, a program must -use the environment obtained by `StreamExecutionEnvironment.getExecutionEnvironment()`. This environment -will act as the cluster's environment when the JAR is submitted to the command line or web -interface. If the Flink program is invoked differently than through these interfaces, the -environment will act like a local environment. - -To package the program, simply export all involved classes as a JAR file. The JAR file's manifest -must point to the class that contains the program's *entry point* (the class with the public -`main` method). The simplest way to do this is by putting the *main-class* entry into the -manifest (such as `main-class: org.apache.flinkexample.MyProgram`). The *main-class* attribute is -the same one that is used by the Java Virtual Machine to find the main method when executing a JAR -files through the command `java -jar pathToTheJarFile`. Most IDEs offer to include that attribute -automatically when exporting JAR files. - - -#### Packaging Programs through Plans - -Additionally, we support packaging programs as *Plans*. Instead of defining a progam in the main -method and calling -`execute()` on the environment, plan packaging returns the *Program Plan*, which is a description of -the program's data flow. To do that, the program must implement the -`org.apache.flink.api.common.Program` interface, defining the `getPlan(String...)` method. The -strings passed to that method are the command line arguments. The program's plan can be created from -the environment via the `ExecutionEnvironment#createProgramPlan()` method. When packaging the -program's plan, the JAR manifest must point to the class implementing the -`org.apache.flinkapi.common.Program` interface, instead of the class with the main method. - - -#### Summary - -The overall procedure to invoke a packaged program is as follows: - -1. The JAR's manifest is searched for a *main-class* or *program-class* attribute. If both -attributes are found, the *program-class* attribute takes precedence over the *main-class* -attribute. Both the command line and the web interface support a parameter to pass the entry point -class name manually for cases where the JAR manifest contains neither attribute. - -2. If the entry point class implements the `org.apache.flinkapi.common.Program`, then the system -calls the `getPlan(String...)` method to obtain the program plan to execute. - -3. If the entry point class does not implement the `org.apache.flinkapi.common.Program` interface, -the system will invoke the main method of the class. - -{% top %} - -Accumulators & Counters ---------------------------- - -Accumulators are simple constructs with an **add operation** and a **final accumulated result**, -which is available after the job ended. - -The most straightforward accumulator is a **counter**: You can increment it using the -```Accumulator.add(V value)``` method. At the end of the job Flink will sum up (merge) all partial -results and send the result to the client. Accumulators are useful during debugging or if you -quickly want to find out more about your data. - -Flink currently has the following **built-in accumulators**. Each of them implements the -{% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/Accumulator.java "Accumulator" %} -interface. - -- {% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/IntCounter.java "__IntCounter__" %}, - {% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/LongCounter.java "__LongCounter__" %} - and {% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/DoubleCounter.java "__DoubleCounter__" %}: - See below for an example using a counter. -- {% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/Histogram.java "__Histogram__" %}: - A histogram implementation for a discrete number of bins. Internally it is just a map from Integer - to Integer. You can use this to compute distributions of values, e.g. the distribution of - words-per-line for a word count program. - -__How to use accumulators:__ - -First you have to create an accumulator object (here a counter) in the user-defined transformation -function where you want to use it. - -{% highlight java %} -private IntCounter numLines = new IntCounter(); -{% endhighlight %} - -Second you have to register the accumulator object, typically in the ```open()``` method of the -*rich* function. Here you also define the name. - -{% highlight java %} -getRuntimeContext().addAccumulator("num-lines", this.numLines); -{% endhighlight %} - -You can now use the accumulator anywhere in the operator function, including in the ```open()``` and -```close()``` methods. - -{% highlight java %} -this.numLines.add(1); -{% endhighlight %} - -The overall result will be stored in the ```JobExecutionResult``` object which is -returned from the `execute()` method of the execution environment -(currently this only works if the execution waits for the -completion of the job). - -{% highlight java %} -myJobExecutionResult.getAccumulatorResult("num-lines") -{% endhighlight %} - -All accumulators share a single namespace per job. Thus you can use the same accumulator in -different operator functions of your job. Flink will internally merge all accumulators with the same -name. - -A note on accumulators and iterations: Currently the result of accumulators is only available after -the overall job ended. We plan to also make the result of the previous iteration available in the -next iteration. You can use -{% gh_link /flink-java/src/main/java/org/apache/flink/api/java/operators/IterativeDataSet.java#L98 "Aggregators" %} -to compute per-iteration statistics and base the termination of iterations on such statistics. - -__Custom accumulators:__ - -To implement your own accumulator you simply have to write your implementation of the Accumulator -interface. Feel free to create a pull request if you think your custom accumulator should be shipped -with Flink. - -You have the choice to implement either -{% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/Accumulator.java "Accumulator" %} -or {% gh_link /flink-core/src/main/java/org/apache/flink/api/common/accumulators/SimpleAccumulator.java "SimpleAccumulator" %}. - -```Accumulator<V,R>``` is most flexible: It defines a type ```V``` for the value to add, and a -result type ```R``` for the final result. E.g. for a histogram, ```V``` is a number and ```R``` is - a histogram. ```SimpleAccumulator``` is for the cases where both types are the same, e.g. for counters. - -{% top %} - -Parallel Execution ------------------- - -This section describes how the parallel execution of programs can be configured in Flink. A Flink -program consists of multiple tasks (transformations/operators, data sources, and sinks). A task is split into -several parallel instances for execution and each parallel instance processes a subset of the task's -input data. The number of parallel instances of a task is called its *parallelism*. - - -The parallelism of a task can be specified in Flink on different levels. - -### Operator Level - -The parallelism of an individual operator, data source, or data sink can be defined by calling its -`setParallelism()` method. For example, like this: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); - -DataStream<String> text = [...] -DataStream<Tuple2<String, Integer>> wordCounts = text - .flatMap(new LineSplitter()) - .keyBy(0) - .timeWindow(Time.seconds(5)) - .sum(1).setParallelism(5); - -wordCounts.print(); - -env.execute("Word Count Example"); -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val env = StreamExecutionEnvironment.getExecutionEnvironment - -val text = [...] -val wordCounts = text - .flatMap{ _.split(" ") map { (_, 1) } } - .keyBy(0) - .timeWindow(Time.seconds(5)) - .sum(1).setParallelism(5) -wordCounts.print() - -env.execute("Word Count Example") -{% endhighlight %} -</div> -</div> - -### Execution Environment Level - -As mentioned [here](#anatomy-of-a-flink-program) Flink programs are executed in the context -of an execution environment. An -execution environment defines a default parallelism for all operators, data sources, and data sinks -it executes. Execution environment parallelism can be overwritten by explicitly configuring the -parallelism of an operator. - -The default parallelism of an execution environment can be specified by calling the -`setParallelism()` method. To execute all operators, data sources, and data sinks with a parallelism -of `3`, set the default parallelism of the execution environment as follows: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); -env.setParallelism(3); - -DataStream<String> text = [...] -DataStream<Tuple2<String, Integer>> wordCounts = [...] -wordCounts.print(); - -env.execute("Word Count Example"); -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val env = StreamExecutionEnvironment.getExecutionEnvironment -env.setParallelism(3) - -val text = [...] -val wordCounts = text - .flatMap{ _.split(" ") map { (_, 1) } } - .keyBy(0) - .timeWindow(Time.seconds(5)) - .sum(1) -wordCounts.print() - -env.execute("Word Count Example") -{% endhighlight %} -</div> -</div> - -### Client Level - -The parallelism can be set at the Client when submitting jobs to Flink. The -Client can either be a Java or a Scala program. One example of such a Client is -Flink's Command-line Interface (CLI). - -For the CLI client, the parallelism parameter can be specified with `-p`. For -example: - - ./bin/flink run -p 10 ../examples/*WordCount-java*.jar - - -In a Java/Scala program, the parallelism is set as follows: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} - -try { - PackagedProgram program = new PackagedProgram(file, args); - InetSocketAddress jobManagerAddress = RemoteExecutor.getInetFromHostport("localhost:6123"); - Configuration config = new Configuration(); - - Client client = new Client(jobManagerAddress, config, program.getUserCodeClassLoader()); - - // set the parallelism to 10 here - client.run(program, 10, true); - -} catch (ProgramInvocationException e) { - e.printStackTrace(); -} - -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -try { - PackagedProgram program = new PackagedProgram(file, args) - InetSocketAddress jobManagerAddress = RemoteExecutor.getInetFromHostport("localhost:6123") - Configuration config = new Configuration() - - Client client = new Client(jobManagerAddress, new Configuration(), program.getUserCodeClassLoader()) - - // set the parallelism to 10 here - client.run(program, 10, true) - -} catch { - case e: Exception => e.printStackTrace -} -{% endhighlight %} -</div> -</div> - - -### System Level - -A system-wide default parallelism for all execution environments can be defined by setting the -`parallelism.default` property in `./conf/flink-conf.yaml`. See the -[Configuration]({{ site.baseurl }}/setup/config.html) documentation for details. - -{% top %} - -Execution Plans ---------------- - -Depending on various parameters such as data size or number of machines in the cluster, Flink's -optimizer automatically chooses an execution strategy for your program. In many cases, it can be -useful to know how exactly Flink will execute your program. - -__Plan Visualization Tool__ - -Flink comes packaged with a visualization tool for execution plans. The HTML document containing -the visualizer is located under ```tools/planVisualizer.html```. It takes a JSON representation of -the job execution plan and visualizes it as a graph with complete annotations of execution -strategies. - -The following code shows how to print the execution plan JSON from your program: - -<div class="codetabs" markdown="1"> -<div data-lang="java" markdown="1"> -{% highlight java %} -final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment(); - -... - -System.out.println(env.getExecutionPlan()); -{% endhighlight %} -</div> -<div data-lang="scala" markdown="1"> -{% highlight scala %} -val env = ExecutionEnvironment.getExecutionEnvironment - -... - -println(env.getExecutionPlan()) -{% endhighlight %} -</div> -</div> - - -To visualize the execution plan, do the following: - -1. **Open** ```planVisualizer.html``` with your web browser, -2. **Paste** the JSON string into the text field, and -3. **Press** the draw button. - -After these steps, a detailed execution plan will be visualized. - -<img alt="A flink job execution graph." src="fig/plan_visualizer.png" width="80%"> - - -__Web Interface__ - -Flink offers a web interface for submitting and executing jobs. The interface is part of the JobManager's -web interface for monitoring, per default running on port 8081. Job submission via this interfaces requires -that you have set `jobmanager.web.submit.enable: true` in `flink-conf.yaml`. - -You may specify program arguments before the job is executed. The plan visualization enables you to show -the execution plan before executing the Flink job. - -{% top %}
http://git-wip-us.apache.org/repos/asf/flink/blob/844c874b/docs/apis/connectors.md ---------------------------------------------------------------------- diff --git a/docs/apis/connectors.md b/docs/apis/connectors.md deleted file mode 100644 index 6568073..0000000 --- a/docs/apis/connectors.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Connectors" ---- -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -The *Connectors* have been moved. Redirecting to [{{ site.baseurl }}/apis/batch/connectors.html]({{ site.baseurl }}/apis/batch/connectors.html) in 1 second. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flink/blob/844c874b/docs/apis/index.md ---------------------------------------------------------------------- diff --git a/docs/apis/index.md b/docs/apis/index.md deleted file mode 100644 index ab12b79..0000000 --- a/docs/apis/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Programming Guides" ---- -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> http://git-wip-us.apache.org/repos/asf/flink/blob/844c874b/docs/apis/java8.md ---------------------------------------------------------------------- diff --git a/docs/apis/java8.md b/docs/apis/java8.md deleted file mode 100644 index c820355..0000000 --- a/docs/apis/java8.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: "Java 8 Programming Guide" -# Top-level navigation -top-nav-group: apis -top-nav-pos: 12 -top-nav-title: Java 8 ---- -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -Java 8 introduces several new language features designed for faster and clearer coding. With the most important feature, -the so-called "Lambda Expressions", Java 8 opens the door to functional programming. Lambda Expressions allow for implementing and -passing functions in a straightforward way without having to declare additional (anonymous) classes. - -The newest version of Flink supports the usage of Lambda Expressions for all operators of the Java API. -This document shows how to use Lambda Expressions and describes current limitations. For a general introduction to the -Flink API, please refer to the [Programming Guide](programming_guide.html) - -* TOC -{:toc} - -### Examples - -The following example illustrates how to implement a simple, inline `map()` function that squares its input using a Lambda Expression. -The types of input `i` and output parameters of the `map()` function need not to be declared as they are inferred by the Java 8 compiler. - -~~~java -env.fromElements(1, 2, 3) -// returns the squared i -.map(i -> i*i) -.print(); -~~~ - -The next two examples show different implementations of a function that uses a `Collector` for output. -Functions, such as `flatMap()`, require a output type (in this case `String`) to be defined for the `Collector` in order to be type-safe. -If the `Collector` type can not be inferred from the surrounding context, it need to be declared in the Lambda Expression's parameter list manually. -Otherwise the output will be treated as type `Object` which can lead to undesired behaviour. - -~~~java -DataSet<Integer> input = env.fromElements(1, 2, 3); - -// collector type must be declared -input.flatMap((Integer number, Collector<String> out) -> { - StringBuilder builder = new StringBuilder(); - for(int i = 0; i < number; i++) { - builder.append("a"); - out.collect(builder.toString()); - } -}) -// returns (on separate lines) "a", "a", "aa", "a", "aa", "aaa" -.print(); -~~~ - -~~~java -DataSet<Integer> input = env.fromElements(1, 2, 3); - -// collector type must not be declared, it is inferred from the type of the dataset -DataSet<String> manyALetters = input.flatMap((number, out) -> { - StringBuilder builder = new StringBuilder(); - for(int i = 0; i < number; i++) { - builder.append("a"); - out.collect(builder.toString()); - } -}); - -// returns (on separate lines) "a", "a", "aa", "a", "aa", "aaa" -manyALetters.print(); -~~~ - -The following code demonstrates a word count which makes extensive use of Lambda Expressions. - -~~~java -DataSet<String> input = env.fromElements("Please count", "the words", "but not this"); - -// filter out strings that contain "not" -input.filter(line -> !line.contains("not")) -// split each line by space -.map(line -> line.split(" ")) -// emit a pair <word,1> for each array element -.flatMap((String[] wordArray, Collector<Tuple2<String, Integer>> out) - -> Arrays.stream(wordArray).forEach(t -> out.collect(new Tuple2<>(t, 1))) - ) -// group and sum up -.groupBy(0).sum(1) -// print -.print(); -~~~ - -### Compiler Limitations -Currently, Flink only supports jobs containing Lambda Expressions completely if they are **compiled with the Eclipse JDT compiler contained in Eclipse Luna 4.4.2 (and above)**. - -Only the Eclipse JDT compiler preserves the generic type information necessary to use the entire Lambda Expressions feature type-safely. -Other compilers such as the OpenJDK's and Oracle JDK's `javac` throw away all generic parameters related to Lambda Expressions. This means that types such as `Tuple2<String,Integer` or `Collector<String>` declared as a Lambda function input or output parameter will be pruned to `Tuple2` or `Collector` in the compiled `.class` files, which is too little information for the Flink Compiler. - -How to compile a Flink job that contains Lambda Expressions with the JDT compiler will be covered in the next section. - -However, it is possible to implement functions such as `map()` or `filter()` with Lambda Expressions in Java 8 compilers other than the Eclipse JDT compiler as long as the function has no `Collector`s or `Iterable`s *and* only if the function handles unparameterized types such as `Integer`, `Long`, `String`, `MyOwnClass` (types without Generics!). - -#### Compile Flink jobs with the Eclipse JDT compiler and Maven - -If you are using the Eclipse IDE, you can run and debug your Flink code within the IDE without any problems after some configuration steps. The Eclipse IDE by default compiles its Java sources with the Eclipse JDT compiler. The next section describes how to configure the Eclipse IDE. - -If you are using a different IDE such as IntelliJ IDEA or you want to package your Jar-File with Maven to run your job on a cluster, you need to modify your project's `pom.xml` file and build your program with Maven. The [quickstart]({{site.baseurl}}/quickstart/setup_quickstart.html) contains preconfigured Maven projects which can be used for new projects or as a reference. Uncomment the mentioned lines in your generated quickstart `pom.xml` file if you want to use Java 8 with Lambda Expressions. - -Alternatively, you can manually insert the following lines to your Maven `pom.xml` file. Maven will then use the Eclipse JDT compiler for compilation. - -~~~xml -<!-- put these lines under "project/build/pluginManagement/plugins" of your pom.xml --> - -<plugin> - <!-- Use compiler plugin with tycho as the adapter to the JDT compiler. --> - <artifactId>maven-compiler-plugin</artifactId> - <configuration> - <source>1.8</source> - <target>1.8</target> - <compilerId>jdt</compilerId> - </configuration> - <dependencies> - <!-- This dependency provides the implementation of compiler "jdt": --> - <dependency> - <groupId>org.eclipse.tycho</groupId> - <artifactId>tycho-compiler-jdt</artifactId> - <version>0.21.0</version> - </dependency> - </dependencies> -</plugin> -~~~ - -If you are using Eclipse for development, the m2e plugin might complain about the inserted lines above and marks your `pom.xml` as invalid. If so, insert the following lines to your `pom.xml`. - -~~~xml -<!-- put these lines under "project/build/pluginManagement/plugins/plugin[groupId="org.eclipse.m2e", artifactId="lifecycle-mapping"]/configuration/lifecycleMappingMetadata/pluginExecutions" of your pom.xml --> - -<pluginExecution> - <pluginExecutionFilter> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <versionRange>[3.1,)</versionRange> - <goals> - <goal>testCompile</goal> - <goal>compile</goal> - </goals> - </pluginExecutionFilter> - <action> - <ignore></ignore> - </action> -</pluginExecution> -~~~ - -#### Run and debug Flink jobs within the Eclipse IDE - -First of all, make sure you are running a current version of Eclipse IDE (4.4.2 or later). Also make sure that you have a Java 8 Runtime Environment (JRE) installed in Eclipse IDE (`Window` -> `Preferences` -> `Java` -> `Installed JREs`). - -Create/Import your Eclipse project. - -If you are using Maven, you also need to change the Java version in your `pom.xml` for the `maven-compiler-plugin`. Otherwise right click the `JRE System Library` section of your project and open the `Properties` window in order to switch to a Java 8 JRE (or above) that supports Lambda Expressions. - -The Eclipse JDT compiler needs a special compiler flag in order to store type information in `.class` files. Open the JDT configuration file at `{project directoy}/.settings/org.eclipse.jdt.core.prefs` with your favorite text editor and add the following line: - -~~~ -org.eclipse.jdt.core.compiler.codegen.lambda.genericSignature=generate -~~~ - -If not already done, also modify the Java versions of the following properties to `1.8` (or above): - -~~~ -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8 -org.eclipse.jdt.core.compiler.compliance=1.8 -org.eclipse.jdt.core.compiler.source=1.8 -~~~ - -After you have saved the file, perform a complete project refresh in Eclipse IDE. - -If you are using Maven, right click your Eclipse project and select `Maven` -> `Update Project...`. - -You have configured everything correctly, if the following Flink program runs without exceptions: - -~~~java -final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment(); -env.fromElements(1, 2, 3).map((in) -> new Tuple1<String>(" " + in)).print(); -env.execute(); -~~~ http://git-wip-us.apache.org/repos/asf/flink/blob/844c874b/docs/apis/local_execution.md ---------------------------------------------------------------------- diff --git a/docs/apis/local_execution.md b/docs/apis/local_execution.md deleted file mode 100644 index 07e15fa..0000000 --- a/docs/apis/local_execution.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Local Execution" -# Top-level navigation -top-nav-group: apis -top-nav-pos: 7 ---- -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -Flink can run on a single machine, even in a single Java Virtual Machine. This allows users to test and debug Flink programs locally. This section gives an overview of the local execution mechanisms. - -The local environments and executors allow you to run Flink programs in a local Java Virtual Machine, or with within any JVM as part of existing programs. Most examples can be launched locally by simply hitting the "Run" button of your IDE. - -There are two different kinds of local execution supported in Flink. The `LocalExecutionEnvironment` is starting the full Flink runtime, including a JobManager and a TaskManager. These include memory management and all the internal algorithms that are executed in the cluster mode. - -The `CollectionEnvironment` is executing the Flink program on Java collections. This mode will not start the full Flink runtime, so the execution is very low-overhead and lightweight. For example a `DataSet.map()`-transformation will be executed by applying the `map()` function to all elements in a Java list. - -* TOC -{:toc} - - -## Debugging - -If you are running Flink programs locally, you can also debug your program like any other Java program. You can either use `System.out.println()` to write out some internal variables or you can use the debugger. It is possible to set breakpoints within `map()`, `reduce()` and all the other methods. -Please also refer to the [debugging section](programming_guide.html#debugging) in the Java API documentation for a guide to testing and local debugging utilities in the Java API. - -## Maven Dependency - -If you are developing your program in a Maven project, you have to add the `flink-clients` module using this dependency: - -~~~xml -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-clients{{ site.scala_version_suffix }}</artifactId> - <version>{{site.version}}</version> -</dependency> -~~~ - -## Local Environment - -The `LocalEnvironment` is a handle to local execution for Flink programs. Use it to run a program within a local JVM - standalone or embedded in other programs. - -The local environment is instantiated via the method `ExecutionEnvironment.createLocalEnvironment()`. By default, it will use as many local threads for execution as your machine has CPU cores (hardware contexts). You can alternatively specify the desired parallelism. The local environment can be configured to log to the console using `enableLogging()`/`disableLogging()`. - -In most cases, calling `ExecutionEnvironment.getExecutionEnvironment()` is the even better way to go. That method returns a `LocalEnvironment` when the program is started locally (outside the command line interface), and it returns a pre-configured environment for cluster execution, when the program is invoked by the [command line interface](cli.html). - -~~~java -public static void main(String[] args) throws Exception { - ExecutionEnvironment env = ExecutionEnvironment.createLocalEnvironment(); - - DataSet<String> data = env.readTextFile("file:///path/to/file"); - - data - .filter(new FilterFunction<String>() { - public boolean filter(String value) { - return value.startsWith("http://";); - } - }) - .writeAsText("file:///path/to/result"); - - JobExecutionResult res = env.execute(); -} -~~~ - -The `JobExecutionResult` object, which is returned after the execution finished, contains the program runtime and the accumulator results. - -The `LocalEnvironment` allows also to pass custom configuration values to Flink. - -~~~java -Configuration conf = new Configuration(); -conf.setFloat(ConfigConstants.TASK_MANAGER_MEMORY_FRACTION_KEY, 0.5f); -final ExecutionEnvironment env = ExecutionEnvironment.createLocalEnvironment(conf); -~~~ - -*Note:* The local execution environments do not start any web frontend to monitor the execution. - -## Collection Environment - -The execution on Java Collections using the `CollectionEnvironment` is a low-overhead approach for executing Flink programs. Typical use-cases for this mode are automated tests, debugging and code re-use. - -Users can use algorithms implemented for batch processing also for cases that are more interactive. A slightly changed variant of a Flink program could be used in a Java Application Server for processing incoming requests. - -**Skeleton for Collection-based execution** - -~~~java -public static void main(String[] args) throws Exception { - // initialize a new Collection-based execution environment - final ExecutionEnvironment env = new CollectionEnvironment(); - - DataSet<User> users = env.fromCollection( /* get elements from a Java Collection */); - - /* Data Set transformations ... */ - - // retrieve the resulting Tuple2 elements into a ArrayList. - Collection<...> result = new ArrayList<...>(); - resultDataSet.output(new LocalCollectionOutputFormat<...>(result)); - - // kick off execution. - env.execute(); - - // Do some work with the resulting ArrayList (=Collection). - for(... t : result) { - System.err.println("Result = "+t); - } -} -~~~ - -The `flink-examples-batch` module contains a full example, called `CollectionExecutionExample`. - -Please note that the execution of the collection-based Flink programs is only possible on small data, which fits into the JVM heap. The execution on collections is not multi-threaded, only one thread is used.
