pig-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Pig Wiki] Update of "PiggyBank" by OlgaN
Date Fri, 20 Jun 2008 16:51:19 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Pig Wiki" for change notification.

The following page has been changed by OlgaN:
http://wiki.apache.org/pig/PiggyBank

New page:
= Piggy Bank - User Contributed Functions =

This is a place for Pig users to share their functions. The functions are contributed "as-is".
If you find a bug or if you feel a function is missing, take the time to fix it or write it
yourself and contribute the changes.

== Using Functions ==

To see how to use your own functions in a pig script, please, see PigLatin[#Applying_functions].
Note that only JAVA functions are supported at this time.

The functions are currently distributed in source form. Users are required to checkout the
code and build the package themselves.  No binary distributions or nightly builds are available
at this time.

To build a jar file that contains all available user defined functions (UDFs), please follow
the steps:

 1. Checkout UDF code: `svn co http://svn.apache.org/repos/asf/incubator/pig/trunk/contrib/piggybank`
 2. Build the jar file: from `trunk/contrib/piggybank/java` directory run `ant`. This will
generate `piggybank.jar` in the same directory.


To obtain `javadoc` description of the functions run `ant javadoc` from `trunk/contrib/piggybank/java`
directory. The documentation is generate in `trunk/contrib/piggybank/java/build/javadoc` directory.
 
To use the functions, you need to figure out the package to which it belongs. The top level
packages correspond to the function type and currently are:

org.apache.pig.piggybank.comparison - for custom comparator used by ORDER operator
org.apache.pig.piggybank.evaluation - for eval functions like aggregates and column transformations
org.apache.pig.piggybank.filtering - for functions used in FILTER operator
org.apache.pig.piggybank.grouping - for grouping functions
org.apache.pig.piggybank.storage - for load/store functions

The exact package of the function can be seen in the javadocs or by navigating the source
tree.

== Contributing Functions ==

For details on how to create UDFs, please, see http://wiki.apache.org/pig/PigFunctions. Note
that only JAVA functions are supported at this time.

Mime
View raw message