org.apache.pig.impl
Class PigContext

java.lang.Object
  extended by org.apache.pig.impl.PigContext
All Implemented Interfaces:
Serializable, FunctionInstantiator

public class PigContext
extends Object
implements Serializable, FunctionInstantiator

See Also:
Serialized Form

Field Summary
 boolean debug
           
 List<URL> extraJars
           
static String JOB_NAME
           
static String JOB_NAME_PREFIX
           
 Vector<String> skipJars
           
 
Constructor Summary
PigContext()
           
PigContext(PigServer.ExecType execType, Properties properties)
           
 
Method Summary
 void addJar(String path)
           
 void addJar(URL resource)
           
 void addPathToSkip(String path)
          Add a path to be skipped while automatically shipping binaries for streaming.
 void connect()
           
 void copy(String src, String dst, boolean localDst)
           
 ClassLoader createCl(String jarFile)
          Creates a Classloader based on the passed jarFile and any extra jar files.
 ExecutableManager createExecutableManager()
          Create a new ExecutableManager depending on the ExecType.
 Class getClassForAlias(String alias)
           
static String getClassNameFromSpec(String funcSpec)
           
 StreamingCommand getCommandForAlias(String alias)
          Get the StreamingCommand for the given alias.
 Properties getConf()
          Deprecated. use getProperties() instead
 DataStorage getDfs()
           
 PigServer.ExecType getExecType()
          Returns the type of execution currently in effect.
 ExecutionEngine getExecutionEngine()
           
 org.apache.hadoop.mapred.JobConf getJobConf()
          Get the JobConf of the current Map-Reduce job.
 String getJobOutputFile()
          Get the output file for the current Pig Script.
 DataStorage getLfs()
           
 List<String> getPathsToSkip()
          Get paths which are to skipped while automatically shipping binaries for streaming.
 Properties getProperties()
          Provides configuration information.
 Object instantiateFuncFromAlias(String alias)
           
static Object instantiateFuncFromSpec(String funcSpec)
           
 void registerFunction(String function, String functionSpec)
          Defines an alias for the given function spec.
 void registerStreamCmd(String alias, StreamingCommand command)
          Defines an alias for the given streaming command.
 void rename(String oldName, String newName)
           
static Class resolveClassName(String name)
           
 void setExecType(PigServer.ExecType execType)
           
 void setJobConf(org.apache.hadoop.mapred.JobConf jobConf)
          Set the JobConf of the current Map-Reduce job.
 void setJobOutputFile(String jobOutputFile)
          Set the output file for the current Pig Script.
 void setJobtrackerLocation(String newLocation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JOB_NAME

public static final String JOB_NAME
See Also:
Constant Field Values

JOB_NAME_PREFIX

public static final String JOB_NAME_PREFIX
See Also:
Constant Field Values

extraJars

public transient List<URL> extraJars

skipJars

public transient Vector<String> skipJars

debug

public boolean debug
Constructor Detail

PigContext

public PigContext()

PigContext

public PigContext(PigServer.ExecType execType,
                  Properties properties)
Method Detail

connect

public void connect()
             throws ExecException
Throws:
ExecException

setJobtrackerLocation

public void setJobtrackerLocation(String newLocation)

addJar

public void addJar(String path)
            throws MalformedURLException
Throws:
MalformedURLException

addJar

public void addJar(URL resource)
            throws MalformedURLException
Throws:
MalformedURLException

rename

public void rename(String oldName,
                   String newName)
            throws IOException
Throws:
IOException

copy

public void copy(String src,
                 String dst,
                 boolean localDst)
          throws IOException
Throws:
IOException

getExecutionEngine

public ExecutionEngine getExecutionEngine()

getDfs

public DataStorage getDfs()

getLfs

public DataStorage getLfs()

getProperties

public Properties getProperties()
Provides configuration information.

Returns:
- information about the configuration used to connect to execution engine

getConf

public Properties getConf()
Deprecated. use getProperties() instead


registerFunction

public void registerFunction(String function,
                             String functionSpec)
Defines an alias for the given function spec. This is useful for functions that require arguments to the constructor.

Parameters:
aliases - - the new function alias to define.
functionSpec - - the name of the function and any arguments. It should have the form: classname('arg1', 'arg2', ...)

registerStreamCmd

public void registerStreamCmd(String alias,
                              StreamingCommand command)
Defines an alias for the given streaming command. This is useful for complicated streaming command specs.

Parameters:
alias - - the new command alias to define.
command - - the command

getExecType

public PigServer.ExecType getExecType()
Returns the type of execution currently in effect.

Returns:

createCl

public ClassLoader createCl(String jarFile)
                     throws MalformedURLException
Creates a Classloader based on the passed jarFile and any extra jar files.

Parameters:
jarFile - the jar file to be part of the newly created Classloader. This jar file plus any jars in the extraJars list will constitute the classpath.
Returns:
the new Classloader.
Throws:
MalformedURLException

getClassNameFromSpec

public static String getClassNameFromSpec(String funcSpec)

resolveClassName

public static Class resolveClassName(String name)
                              throws IOException
Throws:
IOException

instantiateFuncFromSpec

public static Object instantiateFuncFromSpec(String funcSpec)

getClassForAlias

public Class getClassForAlias(String alias)
                       throws IOException
Throws:
IOException

instantiateFuncFromAlias

public Object instantiateFuncFromAlias(String alias)
                                throws IOException
Specified by:
instantiateFuncFromAlias in interface FunctionInstantiator
Throws:
IOException

getCommandForAlias

public StreamingCommand getCommandForAlias(String alias)
Get the StreamingCommand for the given alias.

Parameters:
alias - the alias for the StreamingCommand
Returns:
StreamingCommand for the alias

setExecType

public void setExecType(PigServer.ExecType execType)

createExecutableManager

public ExecutableManager createExecutableManager()
                                          throws ExecException
Create a new ExecutableManager depending on the ExecType.

Returns:
a new ExecutableManager depending on the ExecType
Throws:
ExecException

getJobOutputFile

public String getJobOutputFile()
Get the output file for the current Pig Script.

Returns:
the output file for the current Pig Script

setJobOutputFile

public void setJobOutputFile(String jobOutputFile)
Set the output file for the current Pig Script.

Parameters:
jobOutputFile - the output file for the current Pig Script

getJobConf

public org.apache.hadoop.mapred.JobConf getJobConf()
Get the JobConf of the current Map-Reduce job.

Returns:
the JobConf of the current Map-Reduce job

setJobConf

public void setJobConf(org.apache.hadoop.mapred.JobConf jobConf)
Set the JobConf of the current Map-Reduce job.

Parameters:
jobConf - the JobConf of the current Map-Reduce job

addPathToSkip

public void addPathToSkip(String path)
Add a path to be skipped while automatically shipping binaries for streaming.

Parameters:
path - path to be skipped

getPathsToSkip

public List<String> getPathsToSkip()
Get paths which are to skipped while automatically shipping binaries for streaming.

Returns:
paths which are to skipped while automatically shipping binaries for streaming


Copyright © ${year} The Apache Software Foundation