Package org.apache.pig.builtin

This package contains builtin Pig UDFs.

See:
          Description

Class Summary
ABS ABS implements a binding to the Java function Math.abs(double) for computing the absolute value of the argument.
ACOS ACOS implements a binding to the Java function Math.acos(double) for computing the arc cosine of value of the argument.
ARITY Deprecated. Use SIZE instead.
ASIN ASIN implements a binding to the Java function Math.asin(double) for computing the arc sine of value of the argument.
ATAN ATAN implements a binding to the Java function Math.atan(double) for computing the arc tangent of value of the argument.
AVG Generates the average of a set of values.
AVG.Final  
AVG.Initial  
AVG.Intermediate  
BagSize This method should never be used directly, use SIZE.
Base base class for math udfs
BinStorage Load and store data in a binary format.
Bloom Use a Bloom filter build previously by BuildBloom.
BuildBloom Build a bloom filter for use later in Bloom.
BuildBloom.Final  
BuildBloom.Initial  
BuildBloom.Intermediate  
BuildBloomBase<T> A Base class for BuildBloom and its Algebraic implementations.
CBRT CBRT implements a binding to the Java function Math.cbrt(double) for computing the cube root of the argument.
CEIL CEIL implements a binding to the Java function Math.ceil(double).
CONCAT Generates the concatenation of the first two arguments.
ConstantSize This method should never be used directly, use SIZE.
COR Computes the correlation between sets of data.
COR.Final  
COR.Initial  
COR.Intermed  
COS COS implements a binding to the Java function Math.cos(double).
COSH COSH implements a binding to the Java function Math.cosh(double).
COUNT Generates the count of the number of values in a bag.
COUNT_STAR Generates the count of the values of the first field of a tuple.
COUNT_STAR.Final  
COUNT_STAR.Initial  
COUNT_STAR.Intermediate  
COUNT.Final  
COUNT.Initial  
COUNT.Intermediate  
COV Computes the covariance between sets of data.
COV.Final  
COV.Initial  
COV.Intermed  
CubeDimensions Produces a DataBag with all combinations of the argument tuple members as in a data cube.
DIFF DIFF takes two bags as arguments and compares them.
Distinct Find the distinct set of tuples in a bag.
Distinct.Final  
Distinct.Initial  
Distinct.Intermediate  
DoubleAbs  
DoubleAvg This method should never be used directly, use AVG.
DoubleAvg.Final  
DoubleAvg.Initial  
DoubleAvg.Intermediate  
DoubleBase base class for math udfs that return Double value
DoubleMax This method should never be used directly, use MAX.
DoubleMax.Final  
DoubleMax.Initial  
DoubleMax.Intermediate  
DoubleMin This method should never be used directly, use MIN.
DoubleMin.Final  
DoubleMin.Initial  
DoubleMin.Intermediate  
DoubleRound Given a single data atom it Returns the closest long to the argument.
DoubleSum This method should never be used directly, use SUM.
DoubleSum.Final  
DoubleSum.Initial  
DoubleSum.Intermediate  
EXP Given a single data atom it returns the Euler's number e raised to the power of input
FloatAbs  
FloatAvg This method should never be used directly, use AVG.
FloatAvg.Final  
FloatAvg.Initial  
FloatAvg.Intermediate  
FloatMax This method should never be used directly, use MAX.
FloatMax.Final  
FloatMax.Initial  
FloatMax.Intermediate  
FloatMin This method should never be used directly, use MIN.
FloatMin.Final  
FloatMin.Initial  
FloatMin.Intermediate  
FloatRound ROUND implements a binding to the Java function Math.round(float).
FloatSum This method should never be used directly, use SUM.
FloatSum.Final  
FloatSum.Initial  
FloatSum.Intermediate  
FLOOR FLOOR implements a binding to the Java function Math.floor(double).
GenericInvoker<T> The generic Invoker class does all the common grunt work of setting up an invoker.
INDEXOF INDEXOF implements eval function to search for a string Example: A = load 'mydata' as (name); B = foreach A generate INDEXOF(name, ",");
IntAbs ABS implements a binding to the Java function Math.abs(int) for computing the absolute value of the argument.
IntAvg This method should never be used directly, use AVG.
IntAvg.Final  
IntAvg.Initial  
IntAvg.Intermediate  
IntMax This method should never be used directly, use MAX.
IntMax.Final  
IntMax.Initial  
IntMax.Intermediate  
IntMin This method should never be used directly, use MIN.
IntMin.Final  
IntMin.Initial  
IntMin.Intermediate  
IntSum This method should never be used directly, use SUM.
IntSum.Final  
IntSum.Initial  
IntSum.Intermediate  
InvokeForDouble  
InvokeForFloat  
InvokeForInt  
InvokeForLong  
InvokeForString  
Invoker<T>  
IsEmpty Determine whether a bag or map is empty.
JsonLoader A loader for data stored using JsonStorage.
JsonMetadata Reads and Writes metadata using JSON in metafiles next to the data.
JsonStorage A JSON Pig store function.
LAST_INDEX_OF string.INSTR implements eval function to search for the last occurrence of a string Returns null on error Example: A = load 'mydata' as (name); B = foreach A generate LASTINDEXOF(name, ",");
LCFIRST lower-case the first character of a string
LOG LOG implements a binding to the Java function Math.log(double).
LOG10 LOG10 implements a binding to the Java function Math.log10(double).
LongAbs  
LongAvg This method should never be used directly, use AVG.
LongAvg.Final  
LongAvg.Initial  
LongAvg.Intermediate  
LongMax This method should never be used directly, use MAX.
LongMax.Final  
LongMax.Initial  
LongMax.Intermediate  
LongMin This method should never be used directly, use MIN.
LongMin.Final  
LongMin.Initial  
LongMin.Intermediate  
LongSum This method should never be used directly, use SUM.
LongSum.Final  
LongSum.Initial  
LongSum.Intermediate  
LOWER LOWER implements eval function to convert a string to lower case Example: A = load 'mydata' as (name); B = foreach A generate LOWER(name);
MapSize This method should never be used directly, use SIZE.
MAX Generates the maximum of a set of values.
MAX.Final  
MAX.Initial  
MAX.Intermediate  
MIN Generates the minimum of a set of values.
MIN.Final  
MIN.Initial  
MIN.Intermediate  
PigStorage A load function that parses a line of input into fields using a character delimiter.
PigStreaming The default implementation of PigToStream and StreamToPig interfaces.
RANDOM Return a random double value.
REGEX_EXTRACT Syntax: String RegexExtract(String expression, String regex, int match_index). Input: expression-source string. regex-regular expression. match_index-index of the group to extract. Output: extracted group, if fail, return null.
REGEX_EXTRACT_ALL Syntax: String RegexExtractAll(String expression, String regex). Input: expression-source string. regex-regular expression. Output: A tuple of matched strings.
REPLACE REPLACE implements eval function to replace part of a string.
ROUND ROUND implements a binding to the Java function Math.round(double).
SIN SIN implements a binding to the Java function Math.sin(double).
SINH SINH implements a binding to the Java function Math.sinh(double).
SIZE Generates the size of the argument passed to it.
SQRT SQRT implements a binding to the Java function Math.sqrt(double).
StringConcat This method should never be used directly, use CONCAT.
StringMax This method should never be used directly, use MAX.
StringMax.Final  
StringMax.Initial  
StringMax.Intermediate  
StringMin This method should never be used directly, use MIN.
StringMin.Final  
StringMin.Initial  
StringMin.Intermediate  
StringSize This method should never be used directly, use SIZE.
STRSPLIT Wrapper around Java's String.split
input tuple: first column is assumed to have a string to split;
the optional second column is assumed to have the delimiter or regex to split on;
if not provided, it's assumed to be '\s' (space)
the optional third column may provide a limit to the number of results.
If limit is not provided, 0 is assumed, as per Java's split().
SUBSTRING SUBSTRING implements eval function to get a part of a string.
SUM Generates the sum of a set of values.
SUM.Final  
SUM.Initial  
SUM.Intermediate  
TAN TAN implements a binding to the Java function Math.tan(double).
TANH TANH implements a binding to the Java function Math.tanh(double).
TextLoader This load function simply creates a tuple for each line of text that has a single chararray field that contains the line of text.
TOBAG This class takes a list of items and puts them into a bag T = foreach U generate TOBAG($0, $1, $2); It's like saying this: T = foreach U generate {($0), ($1), ($2)} All arguments that are not of tuple type are inserted into a tuple before being added to the bag.
TOKENIZE Given a chararray as an argument, this method will split the chararray and return a bag with a tuple for each chararray that results from the split.
TOMAP This class makes a map out of the parameters passed to it T = foreach U generate TOMAP($0, $1, $2, $3); It generates a map $0->1, $2->$3
TOP Top UDF accepts a bag of tuples and returns top-n tuples depending upon the tuple field value of type long.
TOP.Final  
TOP.Initial  
TOP.Intermed  
TOTUPLE This class makes a tuple out of the parameter T = foreach U generate TOTUPLE($0, $1, $2); It generates a tuple containing $0, $1, and $2
TRIM Returns a string, with leading and trailing whitespace omitted.
TupleSize This method should never be used directly, use SIZE.
UCFIRST upper-case the first character of a string
UPPER UPPER implements eval function to convert a string to upper case Example: A = load 'mydata' as (name); B = foreach A generate UPPER(name);
Utf8StorageConverter This abstract class provides standard conversions between utf8 encoded data and pig data types.
 

Annotation Types Summary
MonitoredUDF Describes how the execution of a UDF should be monitored, and what to do if it times out.
Nondeterministic A non-deterministic UDF is one that can produce different results when invoked on the same input.
 

Package org.apache.pig.builtin Description

This package contains builtin Pig UDFs. This includes EvalFuncs, LoadFuncs and StoreFuncs.



Copyright © 2007-2012 The Apache Software Foundation