Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twitter/elephant-bird
Twitter's collection of LZO and Protocol Buffer-related Hadoop, Pig, Hive, and HBase code.
https://github.com/twitter/elephant-bird
Last synced: about 2 months ago
JSON representation
Twitter's collection of LZO and Protocol Buffer-related Hadoop, Pig, Hive, and HBase code.
- Host: GitHub
- URL: https://github.com/twitter/elephant-bird
- Owner: twitter
- License: apache-2.0
- Created: 2010-03-25T01:49:40.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2023-04-10T11:31:57.000Z (over 1 year ago)
- Last Synced: 2024-06-21T18:15:05.075Z (3 months ago)
- Language: Java
- Homepage:
- Size: 59.4 MB
- Stars: 1,138
- Watchers: 190
- Forks: 390
- Open Issues: 90
-
Metadata Files:
- Readme: Readme.md
- Changelog: Changes.md
- License: LICENSE
Awesome Lists containing this project
README
# Elephant Bird [](https://travis-ci.org/twitter/elephant-bird)
## About
Elephant Bird is Twitter's open source library of [LZO](https://github.com/twitter/hadoop-lzo), [Thrift](https://thrift.apache.org/), and/or [Protocol Buffer](https://code.google.com/p/protobuf)-related [Hadoop](https://hadoop.apache.org) InputFormats, OutputFormats, Writables, [Pig](https://pig.apache.org/) LoadFuncs, [Hive](https://hadoop.apache.org/hive) SerDe, [HBase](https://hadoop.apache.org/hbase) miscellanea, etc. The majority of these are in production at Twitter running over data every day.
Join the conversation about Elephant-Bird on the [developer mailing list](https://groups.google.com/forum/?fromgroups#!forum/elephantbird-dev).
## License
[Apache License, Version 2.0](https://apache.org/licenses/LICENSE-2.0).
## Quickstart
1. Make sure you have [Protocol Buffers](https://code.google.com/apis/protocolbuffers/) installed. Please see **Version compatibility** section below.
1. Make sure you have [Apache Thrift](https://thrift.apache.org) installed. Please see **Version compatibility** section below.
1. Get the code: `git clone git://github.com/twitter/elephant-bird.git`
1. Build the jar: `mvn package`
1. Explore what's available: `mvn javadoc:javadoc`
Note: For any of the LZO-based code, make sure that the native LZO libraries are on your `java.library.path`. Generally this is done by setting `JAVA_LIBRARY_PATH` in `pig-env.sh` or `hadoop-env.sh`. You can also add lines like
```
PIG_OPTS=-Djava.library.path=/path/to/my/libgplcompression/dir
```
to `pig-env.sh`. See the instructions for [Hadoop-LZO](https://www.github.com/kevinweil/hadoop-lzo) for more details.
There are a few simple examples that use the input formats. Note how the Protocol Buffer and Thrift
classes are passed to input formats through configuration.
## Maven repository
Elephant Bird release artifacts are published to the [Sonatype OSS](https://oss.sonatype.org/) [releases repository](https://oss.sonatype.org/content/repositories/releases/) and promoted from there to [Maven Central](https://search.maven.org/). From time to time we may also deploy snapshot releases to the Sonatype OSS [snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/).
## Version compatibility
1. Hadoop 20.2x, 1.x, 2.x
1. Pig 0.8+
1. Protocol Buffers 2.5.0, 2.4.1, 2.3.0 (default build version is 2.4.1 can be changed with `-Dprotobuf.version=2.3.0`)
1. Hive 0.7 (with HIVE-1616)
1. Thrift 0.5.0, 0.6.0, 0.7.0, greater versions than 0.9 are provided via thrift9 maven profile
1. Mahout 0.6
1. Cascading2 (as the API is evolving, see libraries.properties for the currently supported version)
1. Crunch 0.8.1+
### Runtime Dependencies
Elephant-Bird defines majority of its depenendencies in maven [provided scope](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope).
As a result these dependencies are not transitively Elephant-Bird modules. Please see [wiki page](https://github.com/kevinweil/elephant-bird/wiki/Build-and-Runtime-Dependencies) for more information.
## Contents
### Hadoop Input and Output Formats
Elephant-Bird provides input and output formats for working with a variety of plaintext formats stored in LZO compressed files.
* JSON data
* Line-based data (TextInputFormat but for LZO)
* [W3C logs](https://www.w3.org/TR/WD-logfile.html)
Additionally, protocol buffers and thrift messages can be stored in a variety of file formats.
* Block-based, into generic bytes
* Line-based, base64 encoded
* SequenceFile
* RCFile
### Hadoop API wrappers
Hadoop provides two API implementations: the the old-style `org.apache.hadoop.mapred` and new-style `org.apache.hadoop.mapreduce` packages. Elephant-Bird provides wrapper classes that allow unmodified usage of `mapreduce` input and output formats in contexts where the `mapred` interface is required.
For more information, see [DeprecatedInputFormatWrapper.java](https://github.com/kevinweil/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/mapred/input/DeprecatedInputFormatWrapper.java) and [DeprecatedOutputFormatWrapper.java](https://github.com/kevinweil/elephant-bird/blob/master/core/src/main/java/com/twitter/elephantbird/mapred/output/DeprecatedOutputFormatWrapper.java)
### Hadoop 2.x Support
Elephant-bird published packages are tested with both Hadoop 1.x and 2.x.
### Hadoop Writables
* Elephant-Bird provides protocol buffer and thrift writables for directly working with these formats in map-reduce jobs.
### Pig Support
Loaders and storers are available for the input and output formats listed above. Additionally, pig-specific features include:
* JSON loader (including nested structures)
* Regex-based loader
* Includes converter interface for turning Tuples into Writables and vice versa
* Provides implementations to convert generic Writables, Thrift, Protobufs, and other specialized classes, such as [Apache Mahout](https://mahout.apache.org/)'s [VectorWritable](https://svn.apache.org/repos/asf/mahout/trunk/core/src/main/java/org/apache/mahout/math/VectorWritable.java).
### Hive Support
Elephant-Bird provides Hive support for reading thrift and protocol buffers. For more information, see [How to use Elephant Bird with Hive](https://github.com/kevinweil/elephant-bird/wiki/How-to-use-Elephant-Bird-with-Hive).
### Lucene Integration
Elephant-Bird provides hadoop Input/Output Formats and pig Load/Store Funcs for creating + searching lucene indexes. See [Elephant Bird Lucene](https://github.com/kevinweil/elephant-bird/wiki/Elephant-Bird-Lucene)
### Utilities
* Counters in Pig
* Protocol Buffer utilities
* Thrift utilities
* Conversions from Protocol Buffers and Thrift messages to Pig tuples
* Conversions from Thrift to Protocol Buffer's `DynamicMessage`
* Reading and writing block-based Protocol Buffer format (see `ProtobufBlockWriter`)
### Protocol Buffer and Thrift compiler dependencies
Elephant Bird requires Protocol Buffer compiler at build time, as generated
classes are used internally. Thrift compiler is required to generate classes used in tests.
As these are native-code tools they must be installed on the build
machine (java library dependencies are pulled from maven repositories during the build).
## Working with Thrift and Protocol Buffers in Hadoop
We provide InputFormats, OutputFormats, Pig Load / Store functions, Hive SerDes,
and Writables for working with Thrift and Google Protocol Buffers.
We haven't written up the docs yet, but look at `ProtobufMRExample.java`, `ThriftMRExample.java`, `people_phone_number_count.pig`, `people_phone_number_count_thrift.pig` under `examples` directory for reflection-based dynamic usage.
We also provide utilities for generating Protobuf-specific Loaders, Input/Output Formats, etc, if for some reason you want to avoid
the dynamic bits.
## Hadoop SequenceFiles and Pig
Reading and writing Hadoop SequenceFiles with Pig is supported via classes
[SequenceFileLoader](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/load/SequenceFileLoader.java)
and
[SequenceFileStorage](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/store/SequenceFileStorage.java). These
classes make use of a
[WritableConverter](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/util/WritableConverter.java)
interface, allowing pluggable conversion of key and value instances to and from
Pig data types.
Here's a short example: Suppose you have `SequenceFile` data
sitting beneath path `input`. We can load that data with the following Pig
script:
```
REGISTER '/path/to/elephant-bird.jar';
%declare SEQFILE_LOADER 'com.twitter.elephantbird.pig.load.SequenceFileLoader';
%declare TEXT_CONVERTER 'com.twitter.elephantbird.pig.util.TextConverter';
%declare LONG_CONVERTER 'com.twitter.elephantbird.pig.util.LongWritableConverter';
pairs = LOAD 'input' USING $SEQFILE_LOADER (
'-c $TEXT_CONVERTER', '-c $LONG_CONVERTER'
) AS (key: chararray, value: long);
```
To store `{key: chararray, value: long}` data as `SequenceFile`, the following may be used:
```
%declare SEQFILE_STORAGE 'com.twitter.elephantbird.pig.store.SequenceFileStorage';
STORE pairs INTO 'output' USING $SEQFILE_STORAGE (
'-c $TEXT_CONVERTER', '-c $LONG_CONVERTER'
);
```
For details, please see Javadocs in the following classes:
* [SequenceFileLoader](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/load/SequenceFileLoader.java)
* [SequenceFileStorage](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/store/SequenceFileStorage.java)
* [WritableConverter](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/util/WritableConverter.java)
* [GenericWritableConverter](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/util/GenericWritableConverter.java)
* [AbstractWritableConverter](https://github.com/kevinweil/elephant-bird/blob/master/pig/src/main/java/com/twitter/elephantbird/pig/util/AbstractWritableConverter.java)
## How To Contribute
Bug fixes, features, and documentation improvements are welcome! Please fork the project and send us a pull request on github.
Each new release since 2.1.3 has a *tag*. The latest version on master is what we are actively running on Twitter's hadoop clusters daily, over hundreds of terabytes of data.
## Contributors
Major contributors are listed below. Lots of others have helped too, thanks to all of them!
See git logs for credits.
* Kevin Weil ([@kevinweil](https://twitter.com/kevinweil))
* Dmitriy Ryaboy ([@squarecog](https://twitter.com/squarecog))
* Raghu Angadi ([@raghuangadi](https://twitter.com/raghuangadi))
* Andy Schlaikjer ([@sagemintblue](https://twitter.com/sagemintblue))
* Travis Crawford ([@tc](https://twitter.com/tc))
* Johan Oskarsson ([@skr](https://twitter.com/skr))