org.apache.pig.builtin.mock

Class Storage

java.lang.Object

org.apache.pig.LoadFunc

org.apache.pig.builtin.mock.Storage

All Implemented Interfaces:

LoadMetadata, StoreFuncInterface, StoreMetadata

public class Storage
extends LoadFunc
implements StoreFuncInterface, LoadMetadata, StoreMetadata

A convenient mock Storage for unit tests

  PigServer pigServer = new PigServer(ExecType.LOCAL);
  Data data = resetData(pigServer);
      data.set("foo",
      tuple("a"),
      tuple("b"),
      tuple("c")
      );

  pigServer.registerQuery("A = LOAD 'foo' USING mock.Storage();");
  pigServer.registerQuery("STORE A INTO 'bar' USING mock.Storage();");

  List out = data.get("bar");

  assertEquals(tuple("a"), out.get(0));
  assertEquals(tuple("b"), out.get(1));
  assertEquals(tuple("c"), out.get(2));
 

With Schema:

  PigServer pigServer = new PigServer(ExecType.LOCAL);
  Data data = resetData(pigServer);

  data.set("foo", "blah:chararray",
      tuple("a"),
      tuple("b"),
      tuple("c")
      );

  pigServer.registerQuery("A = LOAD 'foo' USING mock.Storage();");
  pigServer.registerQuery("B = FOREACH A GENERATE blah as a, blah as b;");
  pigServer.registerQuery("STORE B INTO 'bar' USING mock.Storage();");

  assertEquals(schema("a:chararray,b:chararray"), data.getSchema("bar"));
  
  List out = data.get("bar");
  assertEquals(tuple("a", "a"), out.get(0));
  assertEquals(tuple("b", "b"), out.get(1));
  assertEquals(tuple("c", "c"), out.get(2));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Storage.Data An isolated data store to avoid side effects

Constructor Summary

Constructors

Constructor and Description
Storage()

Method Summary

Methods

Modifier and Type	Method and Description
static DataBag	bag(Tuple... tuples)
void	checkSchema(ResourceSchema s) Set the schema for data to be stored.
void	cleanupOnFailure(java.lang.String location, org.apache.hadoop.mapreduce.Job job) This method will be called by Pig if the job which contains this store fails.
void	cleanupOnSuccess(java.lang.String location, org.apache.hadoop.mapreduce.Job job) This method will be called by Pig if the job which contains this store is successful, and some cleanup of intermediate resources is required.
org.apache.hadoop.mapreduce.InputFormat<?,?>	getInputFormat() This will be called during planning on the front end.
LoadCaster	getLoadCaster() This will be called on the front end during planning and not on the back end during execution.
Tuple	getNext() Retrieves the next tuple to be processed.
org.apache.hadoop.mapreduce.OutputFormat<?,?>	getOutputFormat() Return the OutputFormat associated with StoreFuncInterface.
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.
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	prepareToWrite(org.apache.hadoop.mapreduce.RecordWriter writer) Initialize StoreFuncInterface to write data.
void	putNext(Tuple t) Write a tuple to the data store.
java.lang.String	relativeToAbsolutePath(java.lang.String location, org.apache.hadoop.fs.Path curDir) This method is called by the Pig runtime in the front end to convert the input location to an absolute path if the location is relative.
java.lang.String	relToAbsPathForStoreLocation(java.lang.String location, org.apache.hadoop.fs.Path curDir) This method is called by the Pig runtime in the front end to convert the output location to an absolute path if the location is relative.
static Storage.Data	resetData(PigContext context) reset the store and get the Data object to access it
static Storage.Data	resetData(PigServer pigServer) reset the store and get the Data object to access it
static Schema	schema(java.lang.String schema)
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	setStoreFuncUDFContextSignature(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 StoreFuncInterface which it can use to store information in the UDFContext which it needs to store between various method invocations in the front end and back end.
void	setStoreLocation(java.lang.String location, org.apache.hadoop.mapreduce.Job job) Communicate to the storer the location where the data needs to be stored.
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.
void	storeSchema(ResourceSchema schema, java.lang.String location, org.apache.hadoop.mapreduce.Job job) Store schema of the data being written
void	storeStatistics(ResourceStatistics stats, java.lang.String location, org.apache.hadoop.mapreduce.Job job) Store statistics about the data being written.
static Tuple	tuple(java.lang.Object... objects)

Methods inherited from class org.apache.pig.LoadFunc

getAbsolutePath, getCacheFiles, getPathStrings, getShipFiles, join, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

Storage

public Storage()

Method Detail

tuple

public static Tuple tuple(java.lang.Object... objects)

Parameters:

objects -

Returns:

a tuple containing the provided objects

bag

public static DataBag bag(Tuple... tuples)

Parameters:

tuples -

Returns:

a bag containing the provided objects

schema

public static Schema schema(java.lang.String schema)
                     throws ParserException

Parameters:

schema -

Returns:

the schema represented by the string

Throws:

ParserException - if the schema is invalid

resetData

public static Storage.Data resetData(PigServer pigServer)

reset the store and get the Data object to access it

Parameters:

pigServer -

Returns:

Data

resetData

public static Storage.Data resetData(PigContext context)

reset the store and get the Data object to access it

Parameters:

context -

Returns:

data as Data

relativeToAbsolutePath

public java.lang.String relativeToAbsolutePath(java.lang.String location,
                                      org.apache.hadoop.fs.Path curDir)
                                        throws java.io.IOException

Description copied from class: LoadFunc

This method is called by the Pig runtime in the front end to convert the input location to an absolute path if the location is relative. The loadFunc implementation is free to choose how it converts a relative location to an absolute location since this may depend on what the location string represent (hdfs path or some other data source)

Overrides:

relativeToAbsolutePath in class LoadFunc

Parameters:

location - location as provided in the "load" statement of the script

curDir - the current working direction based on any "cd" statements in the script before the "load" statement. If there are no "cd" statements in the script, this would be the home directory -

/user/ 

Returns:

the absolute location based on the arguments passed

Throws:

java.io.IOException - if the conversion is not possible

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 the front end during planning and not on 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 JobContext.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 JobContext.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 JobContext.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.

relToAbsPathForStoreLocation

public java.lang.String relToAbsPathForStoreLocation(java.lang.String location,
                                            org.apache.hadoop.fs.Path curDir)
                                              throws java.io.IOException

Description copied from interface: StoreFuncInterface

This method is called by the Pig runtime in the front end to convert the output location to an absolute path if the location is relative. The StoreFuncInterface implementation is free to choose how it converts a relative location to an absolute location since this may depend on what the location string represent (hdfs path or some other data source). The static method LoadFunc.getAbsolutePath(java.lang.String, org.apache.hadoop.fs.Path) provides a default implementation for hdfs and hadoop local file system and it can be used to implement this method.

Specified by:

relToAbsPathForStoreLocation in interface StoreFuncInterface

Parameters:

location - location as provided in the "store" statement of the script

curDir - the current working direction based on any "cd" statements in the script before the "store" statement. If there are no "cd" statements in the script, this would be the home directory -

/user/ 

Returns:

the absolute location based on the arguments passed

Throws:

java.io.IOException - if the conversion is not possible

getOutputFormat

public org.apache.hadoop.mapreduce.OutputFormat<?,?> getOutputFormat()
                                                              throws java.io.IOException

Description copied from interface: StoreFuncInterface

Return the OutputFormat associated with StoreFuncInterface. This will be called on the front end during planning and on the backend during execution.

Specified by:

getOutputFormat in interface StoreFuncInterface

Returns:

the OutputFormat associated with StoreFuncInterface

Throws:

java.io.IOException - if an exception occurs while constructing the OutputFormat

setStoreLocation

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

Description copied from interface: StoreFuncInterface

Communicate to the storer the location where the data needs to be stored. The location string passed to the StoreFuncInterface here is the return value of StoreFuncInterface.relToAbsPathForStoreLocation(String, Path) 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. StoreFuncInterface.checkSchema(ResourceSchema) will be called before any call to StoreFuncInterface.setStoreLocation(String, Job).

Specified by:

setStoreLocation in interface StoreFuncInterface

Parameters:

location - Location returned by StoreFuncInterface.relToAbsPathForStoreLocation(String, Path)

job - The Job object

Throws:

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

checkSchema

public void checkSchema(ResourceSchema s)
                 throws java.io.IOException

Description copied from interface: StoreFuncInterface

Set the schema for data to be stored. This will be called on the front end during planning if the store is associated with a schema. A Store function should implement this function to check that a given schema is acceptable to it. For example, it can check that the correct partition keys are included; a storage function to be written directly to an OutputFormat can make sure the schema will translate in a well defined way.

Specified by:

checkSchema in interface StoreFuncInterface

Parameters:

s - to be checked

Throws:

java.io.IOException - if this schema is not acceptable. It should include a detailed error message indicating what is wrong with the schema.

prepareToWrite

public void prepareToWrite(org.apache.hadoop.mapreduce.RecordWriter writer)
                    throws java.io.IOException

Description copied from interface: StoreFuncInterface

Initialize StoreFuncInterface to write data. This will be called during execution before the call to putNext.

Specified by:

prepareToWrite in interface StoreFuncInterface

Parameters:

writer - RecordWriter to use.

Throws:

java.io.IOException - if an exception occurs during initialization

putNext

public void putNext(Tuple t)
             throws java.io.IOException

Description copied from interface: StoreFuncInterface

Write a tuple to the data store.

Specified by:

putNext in interface StoreFuncInterface

Parameters:

t - the tuple to store.

Throws:

java.io.IOException - if an exception occurs during the write

setStoreFuncUDFContextSignature

public void setStoreFuncUDFContextSignature(java.lang.String signature)

Description copied from interface: StoreFuncInterface

This method will be called by Pig both in the front end and back end to pass a unique signature to the StoreFuncInterface which it can use to store information in the UDFContext which it needs to store between various method invocations in the front end and back end. This is necessary because in a Pig Latin script with multiple stores, the different instances of store functions need to be able to find their (and only their) data in the UDFContext object.

Specified by:

setStoreFuncUDFContextSignature in interface StoreFuncInterface

Parameters:

signature - a unique signature to identify this StoreFuncInterface

cleanupOnFailure

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

Description copied from interface: StoreFuncInterface

This method will be called by Pig if the job which contains this store fails. Implementations can clean up output locations in this method to ensure that no incorrect/incomplete results are left in the output location

Specified by:

cleanupOnFailure in interface StoreFuncInterface

Parameters:

location - Location returned by StoreFuncInterface.relToAbsPathForStoreLocation(String, Path)

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

Throws:

java.io.IOException

cleanupOnSuccess

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

Description copied from interface: StoreFuncInterface

This method will be called by Pig if the job which contains this store is successful, and some cleanup of intermediate resources is required. Implementations can clean up output locations in this method to ensure that no incorrect/incomplete results are left in the output location

Specified by:

cleanupOnSuccess in interface StoreFuncInterface

Parameters:

location - Location returned by StoreFuncInterface.relToAbsPathForStoreLocation(String, Path)

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

Throws:

java.io.IOException

storeStatistics

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

Description copied from interface: StoreMetadata

Store statistics about the data being written.

Specified by:

storeStatistics in interface StoreMetadata

Parameters:

stats - statistics to be recorded

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 JobContext.getConfiguration() and not to set/query any runtime job information.

Throws:

java.io.IOException

storeSchema

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

Description copied from interface: StoreMetadata

Store schema of the data being written

Specified by:

storeSchema in interface StoreMetadata

Parameters:

schema - Schema to be recorded

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 JobContext.getConfiguration() and not to set/query any runtime job information.

Throws:

java.io.IOException