org.apache.pig.builtin

Class JsonLoader

java.lang.Object

org.apache.pig.LoadFunc

org.apache.pig.builtin.JsonLoader

All Implemented Interfaces:

LoadMetadata

public class JsonLoader
extends LoadFunc
implements LoadMetadata

A loader for data stored using JsonStorage. This is not a generic JSON loader. It depends on the schema being stored with the data when conceivably you could write a loader that determines the schema from the JSON.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.mapreduce.RecordReader	reader
protected ResourceSchema	schema

Constructor Summary

Constructors

Constructor and Description
JsonLoader()
JsonLoader(java.lang.String schemaString)

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.mapreduce.InputFormat	getInputFormat() This will be called during planning on the front end.
LoadCaster	getLoadCaster() This will be called on both the front end and the back end during execution.
Tuple	getNext() Retrieves the next tuple to be processed.
java.lang.String[]	getPartitionKeys(java.lang.String location, org.apache.hadoop.mapreduce.Job job) Find what columns are partition keys for this input.
ResourceSchema	getSchema(java.lang.String location, org.apache.hadoop.mapreduce.Job job) Get a schema for the data to be loaded.
java.util.List<java.lang.String>	getShipFiles() Allow a LoadFunc to specify a list of files located locally and would like to ship to backend (through distributed cache).
ResourceStatistics	getStatistics(java.lang.String location, org.apache.hadoop.mapreduce.Job job) Get statistics about the data to be loaded.
void	prepareToRead(org.apache.hadoop.mapreduce.RecordReader reader, PigSplit split) Initializes LoadFunc for reading data.
void	setLocation(java.lang.String location, org.apache.hadoop.mapreduce.Job job) Communicate to the loader the location of the object(s) being loaded.
void	setPartitionFilter(Expression partitionFilter) Set the filter for partitioning.
void	setUDFContextSignature(java.lang.String signature) This method will be called by Pig both in the front end and back end to pass a unique signature to the LoadFunc.

Methods inherited from class org.apache.pig.LoadFunc

getAbsolutePath, getCacheFiles, getPathStrings, join, relativeToAbsolutePath, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reader

protected org.apache.hadoop.mapreduce.RecordReader reader

schema

protected ResourceSchema schema

Constructor Detail

JsonLoader

public JsonLoader()

JsonLoader

public JsonLoader(java.lang.String schemaString)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setLocation

public void setLocation(java.lang.String location,
                        org.apache.hadoop.mapreduce.Job job)
                 throws java.io.IOException

Description copied from class: LoadFunc

Communicate to the loader the location of the object(s) being loaded. The location string passed to the LoadFunc here is the return value of LoadFunc.relativeToAbsolutePath(String, Path). Implementations should use this method to communicate the location (and any other information) to its underlying InputFormat through the Job object. This method will be called in the frontend and backend multiple times. Implementations should bear in mind that this method is called multiple times and should ensure there are no inconsistent side effects due to the multiple calls.

Specified by:

setLocation in class LoadFunc

Parameters:

location - Location as returned by LoadFunc.relativeToAbsolutePath(String, Path)

job - the Job object store or retrieve earlier stored information from the UDFContext

Throws:

java.io.IOException - if the location is not valid.

getInputFormat

public org.apache.hadoop.mapreduce.InputFormat getInputFormat()
                                                       throws java.io.IOException

Description copied from class: LoadFunc

This will be called during planning on the front end. This is the instance of InputFormat (rather than the class name) because the load function may need to instantiate the InputFormat in order to control how it is constructed.

Specified by:

getInputFormat in class LoadFunc

Returns:

the InputFormat associated with this loader.

Throws:

java.io.IOException - if there is an exception during InputFormat construction

getLoadCaster

public LoadCaster getLoadCaster()
                         throws java.io.IOException

Description copied from class: LoadFunc

This will be called on both the front end and the back end during execution.

Overrides:

getLoadCaster in class LoadFunc

Returns:

the LoadCaster associated with this loader. Returning null indicates that casts from byte array are not supported for this loader. construction

Throws:

java.io.IOException - if there is an exception during LoadCaster

prepareToRead

public void prepareToRead(org.apache.hadoop.mapreduce.RecordReader reader,
                          PigSplit split)
                   throws java.io.IOException

Description copied from class: LoadFunc

Initializes LoadFunc for reading data. This will be called during execution before any calls to getNext. The RecordReader needs to be passed here because it has been instantiated for a particular InputSplit.

Specified by:

prepareToRead in class LoadFunc

Parameters:

reader - RecordReader to be used by this instance of the LoadFunc

split - The input PigSplit to process

Throws:

java.io.IOException - if there is an exception during initialization

getNext

public Tuple getNext()
              throws java.io.IOException

Description copied from class: LoadFunc

Retrieves the next tuple to be processed. Implementations should NOT reuse tuple objects (or inner member objects) they return across calls and should return a different tuple object in each call.

Specified by:

getNext in class LoadFunc

Returns:

the next tuple to be processed or null if there are no more tuples to be processed.

Throws:

java.io.IOException - if there is an exception while retrieving the next tuple

setUDFContextSignature

public void setUDFContextSignature(java.lang.String signature)

Description copied from class: LoadFunc

This method will be called by Pig both in the front end and back end to pass a unique signature to the LoadFunc. The signature can be used to store into the UDFContext any information which the LoadFunc needs to store between various method invocations in the front end and back end. A use case is to store LoadPushDown.RequiredFieldList passed to it in LoadPushDown.pushProjection(RequiredFieldList) for use in the back end before returning tuples in LoadFunc.getNext(). This method will be call before other methods in LoadFunc

Overrides:

setUDFContextSignature in class LoadFunc

Parameters:

signature - a unique signature to identify this LoadFunc

getSchema

public ResourceSchema getSchema(java.lang.String location,
                                org.apache.hadoop.mapreduce.Job job)
                         throws java.io.IOException

Description copied from interface: LoadMetadata

Get a schema for the data to be loaded.

Specified by:

getSchema in interface LoadMetadata

Parameters:

location - Location as returned by LoadFunc.relativeToAbsolutePath(String, org.apache.hadoop.fs.Path)

job - The Job object - this should be used only to obtain cluster properties through JobContextImpl.getConfiguration() and not to set/query any runtime job information.

Returns:

schema for the data to be loaded. This schema should represent all tuples of the returned data. If the schema is unknown or it is not possible to return a schema that represents all returned data, then null should be returned. The schema should not be affected by pushProjection, ie. getSchema should always return the original schema even after pushProjection

Throws:

java.io.IOException - if an exception occurs while determining the schema

getStatistics

public ResourceStatistics getStatistics(java.lang.String location,
                                        org.apache.hadoop.mapreduce.Job job)
                                 throws java.io.IOException

Description copied from interface: LoadMetadata

Get statistics about the data to be loaded. If no statistics are available, then null should be returned. If the implementing class also extends LoadFunc, then LoadFunc.setLocation(String, org.apache.hadoop.mapreduce.Job) is guaranteed to be called before this method.

Specified by:

getStatistics in interface LoadMetadata

Parameters:

location - Location as returned by LoadFunc.relativeToAbsolutePath(String, org.apache.hadoop.fs.Path)

job - The Job object - this should be used only to obtain cluster properties through JobContextImpl.getConfiguration() and not to set/query any runtime job information.

Returns:

statistics about the data to be loaded. If no statistics are available, then null should be returned.

Throws:

java.io.IOException - if an exception occurs while retrieving statistics

getPartitionKeys

public java.lang.String[] getPartitionKeys(java.lang.String location,
                                           org.apache.hadoop.mapreduce.Job job)
                                    throws java.io.IOException

Description copied from interface: LoadMetadata

Find what columns are partition keys for this input.

Specified by:

getPartitionKeys in interface LoadMetadata

Parameters:

location - Location as returned by LoadFunc.relativeToAbsolutePath(String, org.apache.hadoop.fs.Path)

job - The Job object - this should be used only to obtain cluster properties through JobContextImpl.getConfiguration() and not to set/query any runtime job information.

Returns:

array of field names of the partition keys. Implementations should return null to indicate that there are no partition keys

Throws:

java.io.IOException - if an exception occurs while retrieving partition keys

setPartitionFilter

public void setPartitionFilter(Expression partitionFilter)
                        throws java.io.IOException

Description copied from interface: LoadMetadata

Set the filter for partitioning. It is assumed that this filter will only contain references to fields given as partition keys in getPartitionKeys. So if the implementation returns null in LoadMetadata.getPartitionKeys(String, Job), then this method is not called by Pig runtime. This method is also not called by the Pig runtime if there are no partition filter conditions.

Specified by:

setPartitionFilter in interface LoadMetadata

Parameters:

partitionFilter - that describes filter for partitioning

Throws:

java.io.IOException - if the filter is not compatible with the storage mechanism or contains non-partition fields.

getShipFiles

public java.util.List<java.lang.String> getShipFiles()

Description copied from class: LoadFunc

Allow a LoadFunc to specify a list of files located locally and would like to ship to backend (through distributed cache). Check for FuncUtils for utility function to facilitate it The default implementation returns null.

Overrides:

getShipFiles in class LoadFunc

Returns:

A list of files