Hadoop Compatibility Beta

Flink is compatible with Apache Hadoop MapReduce interfaces and therefore allows reusing code that was implemented for Hadoop MapReduce.

You can:

This document shows how to use existing Hadoop MapReduce code with Flink. Please refer to the Connecting to other systems guide for reading from Hadoop supported file systems.

Project Configuration

Support for Hadoop input/output formats is part of the flink-java and flink-scala Maven modules that are always required when writing Flink jobs. The code is located in org.apache.flink.api.java.hadoop and org.apache.flink.api.scala.hadoop in an additional sub-package for the mapred and mapreduce API.

Support for Hadoop Mappers and Reducers is contained in the flink-hadoop-compatibility Maven module. This code resides in the org.apache.flink.hadoopcompatibility package.

Add the following dependency to your pom.xml if you want to reuse Mappers and Reducers.

  1. <dependency>
  2.     <groupId>org.apache.flink</groupId>
  3.     <artifactId>flink-hadoop-compatibility_2.11</artifactId>
  4.     <version>1.12.0</version>
  5. </dependency>

If you want to run your Flink application locally (e.g. from your IDE), you also need to add a hadoop-client dependency such as:

  1. <dependency>
  2.     <groupId>org.apache.hadoop</groupId>
  3.     <artifactId>hadoop-client</artifactId>
  4.     <version>2.8.3</version>
  5.     <scope>provided</scope>
  6. </dependency>

Using Hadoop InputFormats

To use Hadoop InputFormats with Flink the format must first be wrapped using either readHadoopFile or createHadoopInput of the HadoopInputs utility class. The former is used for input formats derived from FileInputFormat while the latter has to be used for general purpose input formats. The resulting InputFormat can be used to create a data source by using ExecutionEnvironmen#createInput.

The resulting DataSet contains 2-tuples where the first field is the key and the second field is the value retrieved from the Hadoop InputFormat.

The following example shows how to use Hadoop’s TextInputFormat.

  1. ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
  3. DataSet<Tuple2<LongWritable, Text>> input =
  4.     env.createInput(HadoopInputs.readHadoopFile(new TextInputFormat(),
  5.                         LongWritable.class, Text.class, textPath));
  7. // Do something with the data.
  8. [...]
  1. val env = ExecutionEnvironment.getExecutionEnvironment
  3. val input: DataSet[(LongWritable, Text)] =
  4.   env.createInput(HadoopInputs.readHadoopFile(
  5.                     new TextInputFormat, classOf[LongWritable], classOf[Text], textPath))
  7. // Do something with the data.
  8. [...]

Using Hadoop OutputFormats

Flink provides a compatibility wrapper for Hadoop OutputFormats. Any class that implements org.apache.hadoop.mapred.OutputFormat or extends org.apache.hadoop.mapreduce.OutputFormat is supported. The OutputFormat wrapper expects its input data to be a DataSet containing 2-tuples of key and value. These are to be processed by the Hadoop OutputFormat.

The following example shows how to use Hadoop’s TextOutputFormat.

  1. // Obtain the result we want to emit
  2. DataSet<Tuple2<Text, IntWritable>> hadoopResult = [...]
  4. // Set up the Hadoop TextOutputFormat.
  5. HadoopOutputFormat<Text, IntWritable> hadoopOF =
  6.   // create the Flink wrapper.
  7.   new HadoopOutputFormat<Text, IntWritable>(
  8.     // set the Hadoop OutputFormat and specify the job.
  9.     new TextOutputFormat<Text, IntWritable>(), job
  10.   );
  11. hadoopOF.getConfiguration().set("mapreduce.output.textoutputformat.separator", " ");
  12. TextOutputFormat.setOutputPath(job, new Path(outputPath));
  14. // Emit data using the Hadoop TextOutputFormat.
  15. hadoopResult.output(hadoopOF);
  1. // Obtain your result to emit.
  2. val hadoopResult: DataSet[(Text, IntWritable)] = [...]
  4. val hadoopOF = new HadoopOutputFormat[Text,IntWritable](
  5.   new TextOutputFormat[Text, IntWritable],
  6.   new JobConf)
  8. hadoopOF.getJobConf.set("mapred.textoutputformat.separator", " ")
  9. FileOutputFormat.setOutputPath(hadoopOF.getJobConf, new Path(resultPath))
  11. hadoopResult.output(hadoopOF)

Using Hadoop Mappers and Reducers

Hadoop Mappers are semantically equivalent to Flink’s FlatMapFunctions and Hadoop Reducers are equivalent to Flink’s GroupReduceFunctions. Flink provides wrappers for implementations of Hadoop MapReduce’s Mapper and Reducer interfaces, i.e., you can reuse your Hadoop Mappers and Reducers in regular Flink programs. At the moment, only the Mapper and Reduce interfaces of Hadoop’s mapred API (org.apache.hadoop.mapred) are supported.

The wrappers take a DataSet<Tuple2<KEYIN,VALUEIN>> as input and produce a DataSet<Tuple2<KEYOUT,VALUEOUT>> as output where KEYIN and KEYOUT are the keys and VALUEIN and VALUEOUT are the values of the Hadoop key-value pairs that are processed by the Hadoop functions. For Reducers, Flink offers a wrapper for a GroupReduceFunction with (HadoopReduceCombineFunction) and without a Combiner (HadoopReduceFunction). The wrappers accept an optional JobConf object to configure the Hadoop Mapper or Reducer.

Flink’s function wrappers are

  • org.apache.flink.hadoopcompatibility.mapred.HadoopMapFunction,
  • org.apache.flink.hadoopcompatibility.mapred.HadoopReduceFunction, and
  • org.apache.flink.hadoopcompatibility.mapred.HadoopReduceCombineFunction.

and can be used as regular Flink FlatMapFunctions or GroupReduceFunctions.

The following example shows how to use Hadoop Mapper and Reducer functions.

  1. // Obtain data to process somehow.
  2. DataSet<Tuple2<LongWritable, Text>> text = [...]
  4. DataSet<Tuple2<Text, LongWritable>> result = text
  5.   // use Hadoop Mapper (Tokenizer) as MapFunction
  6.   .flatMap(new HadoopMapFunction<LongWritable, Text, Text, LongWritable>(
  7.     new Tokenizer()
  8.   ))
  9.   .groupBy(0)
  10.   // use Hadoop Reducer (Counter) as Reduce- and CombineFunction
  11.   .reduceGroup(new HadoopReduceCombineFunction<Text, LongWritable, Text, LongWritable>(
  12.     new Counter(), new Counter()
  13.   ));

Please note: The Reducer wrapper works on groups as defined by Flink’s groupBy() operation. It does not consider any custom partitioners, sort or grouping comparators you might have set in the JobConf.

Complete Hadoop WordCount Example

The following example shows a complete WordCount implementation using Hadoop data types, Input- and OutputFormats, and Mapper and Reducer implementations.

  1. ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
  3. // Set up the Hadoop TextInputFormat.
  4. Job job = Job.getInstance();
  5. HadoopInputFormat<LongWritable, Text> hadoopIF =
  6.   new HadoopInputFormat<LongWritable, Text>(
  7.     new TextInputFormat(), LongWritable.class, Text.class, job
  8.   );
  9. TextInputFormat.addInputPath(job, new Path(inputPath));
  11. // Read data using the Hadoop TextInputFormat.
  12. DataSet<Tuple2<LongWritable, Text>> text = env.createInput(hadoopIF);
  14. DataSet<Tuple2<Text, LongWritable>> result = text
  15.   // use Hadoop Mapper (Tokenizer) as MapFunction
  16.   .flatMap(new HadoopMapFunction<LongWritable, Text, Text, LongWritable>(
  17.     new Tokenizer()
  18.   ))
  19.   .groupBy(0)
  20.   // use Hadoop Reducer (Counter) as Reduce- and CombineFunction
  21.   .reduceGroup(new HadoopReduceCombineFunction<Text, LongWritable, Text, LongWritable>(
  22.     new Counter(), new Counter()
  23.   ));
  25. // Set up the Hadoop TextOutputFormat.
  26. HadoopOutputFormat<Text, LongWritable> hadoopOF =
  27.   new HadoopOutputFormat<Text, LongWritable>(
  28.     new TextOutputFormat<Text, LongWritable>(), job
  29.   );
  30. hadoopOF.getConfiguration().set("mapreduce.output.textoutputformat.separator", " ");
  31. TextOutputFormat.setOutputPath(job, new Path(outputPath));
  33. // Emit data using the Hadoop TextOutputFormat.
  34. result.output(hadoopOF);
  36. // Execute Program
  37. env.execute("Hadoop WordCount");