[GitHub] incubator-flink pull request: [FLINK-1107] Hadoop Compatibility La...

[rmetzger <gi...@git.apache.org>]

Github user rmetzger commented on a diff in the pull request:

    https://github.com/apache/incubator-flink/pull/131#discussion_r18385767
  
    --- Diff: docs/hadoop_compatibility.md ---
    @@ -1,5 +1,75 @@
     ---
    -title: "Hadoop Compatability"
    +title: "Hadoop I/O Compatibility"
     ---
     
    -To be written.
    \ No newline at end of file
    +Flink not only supports types that implement Apache Hadoop's `Writable` interface by default, but also provides a compatibility 
    +layer that allows for using any class extending `org.apache.hadoop.mapred(uce).InputFormat` as a Flink `InputFormat` as well as any 
    +class extending `org.apache.hadoop.mapred(uce).OutputFormat` as a Flink `OutputFormat`. 
    +
    +Thus, Flink can handle Hadoop-related formats from the common `TextInputFormat` up to third-party components such as Hive through HCatalog's `HCatInputFormat`. Flink supports both the formats which use the old `org.apache.hadoop.mapred` API as well as the new `org.apache.hadoop.mapreduce` API.
    +
    +This document explains how to configure your Maven project correctly and shows an example.
    +
    +### Project Configuration
    +
    +The Hadoop Compatibility Layer is part of the *addons* Maven project. All relevant classes are located in the `org.apache.flink.hadoopcompatibility` package. The package includes separate packages and classes for the Hadoop `mapred` and `mapreduce` API.
    +
    +Add the following dependency to your `pom.xml` to use the Hadoop Compatibility Layer.
    +
    +~~~xml
    +<dependency>
    +	<groupId>org.apache.flink</groupId>
    +	<artifactId>flink-hadoop-compatibility</artifactId>
    +	<version>{{site.FLINK_VERSION_STABLE}}</version>
    +</dependency>
    +~~~
    --- End diff --
    
    can you add another headline here, that quickly explains the usage?
    Just how to read data from the environment to a data set using a hadoop input format (something like a copy-past skeleton).
    I think its better if you have a) a general definition how to use it
    and b) an example that people see how to use it in context.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---