org.apache.hive.hcatalog.mapreduce

Class FosterStorageHandler

java.lang.Object

org.apache.hadoop.hive.ql.metadata.DefaultStorageHandler

org.apache.hive.hcatalog.mapreduce.FosterStorageHandler

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, HiveStorageHandler

public class FosterStorageHandler
extends DefaultStorageHandler

This class is used to encapsulate the InputFormat, OutputFormat and SerDe artifacts of tables which don't define a SerDe. This StorageHandler assumes the supplied storage artifacts are for a file-based storage system.

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.hadoop.conf.Configuration	conf
protected static String	TEMP_DIR_NAME The directory under which data is initially written for a non partitioned table

Constructor Summary

Constructors

Constructor and Description
FosterStorageHandler(Class<? extends org.apache.hadoop.mapred.InputFormat> ifClass, Class<? extends org.apache.hadoop.mapred.OutputFormat> ofClass, Class<? extends AbstractSerDe> serDeClass)
FosterStorageHandler(String ifName, String ofName, String serdeName)

Method Summary

Modifier and Type	Method and Description
void	configureInputJobProperties(TableDesc tableDesc, Map<String,String> jobProperties) This method is called to allow the StorageHandlers the chance to populate the JobContext.getConfiguration() with properties that maybe be needed by the handler's bundled artifacts (ie InputFormat, SerDe, etc).
void	configureJobConf(TableDesc tableDesc, org.apache.hadoop.mapred.JobConf jobConf) Called just before submitting MapReduce job.
void	configureOutputJobProperties(TableDesc tableDesc, Map<String,String> jobProperties) This method is called to allow the StorageHandlers the chance to populate the JobContext.getConfiguration() with properties that maybe be needed by the handler's bundled artifacts (ie InputFormat, SerDe, etc).
void	configureTableJobProperties(TableDesc tableDesc, Map<String,String> jobProperties) Deprecated use configureInputJobProperties/configureOutputJobProperties methods instead.
HiveAuthorizationProvider	getAuthorizationProvider() Returns the implementation specific authorization provider
org.apache.hadoop.conf.Configuration	getConf()
Class<? extends org.apache.hadoop.mapred.InputFormat>	getInputFormatClass()
HiveMetaHook	getMetaHook()
Class<? extends org.apache.hadoop.mapred.OutputFormat>	getOutputFormatClass()
Class<? extends AbstractSerDe>	getSerDeClass()
void	setConf(org.apache.hadoop.conf.Configuration conf)

Methods inherited from class org.apache.hadoop.hive.ql.metadata.DefaultStorageHandler

configureInputJobCredentials, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hive.ql.metadata.HiveStorageHandler

getLockType, getStorageHandlerInfo

Field Detail

conf

public org.apache.hadoop.conf.Configuration conf

TEMP_DIR_NAME

protected static final String TEMP_DIR_NAME

The directory under which data is initially written for a non partitioned table

See Also:

Constant Field Values

Constructor Detail

FosterStorageHandler

public FosterStorageHandler(String ifName,
                            String ofName,
                            String serdeName)
                     throws ClassNotFoundException

Throws:

ClassNotFoundException

FosterStorageHandler

public FosterStorageHandler(Class<? extends org.apache.hadoop.mapred.InputFormat> ifClass,
                            Class<? extends org.apache.hadoop.mapred.OutputFormat> ofClass,
                            Class<? extends AbstractSerDe> serDeClass)

Method Detail

getInputFormatClass

public Class<? extends org.apache.hadoop.mapred.InputFormat> getInputFormatClass()

Specified by:

getInputFormatClass in interface HiveStorageHandler

Overrides:

getInputFormatClass in class DefaultStorageHandler

Returns:

Class providing an implementation of InputFormat

getOutputFormatClass

public Class<? extends org.apache.hadoop.mapred.OutputFormat> getOutputFormatClass()

Specified by:

getOutputFormatClass in interface HiveStorageHandler

Overrides:

getOutputFormatClass in class DefaultStorageHandler

Returns:

Class providing an implementation of OutputFormat

getSerDeClass

public Class<? extends AbstractSerDe> getSerDeClass()

Specified by:

getSerDeClass in interface HiveStorageHandler

Overrides:

getSerDeClass in class DefaultStorageHandler

Returns:

Class providing an implementation of AbstractSerDe

getMetaHook

public HiveMetaHook getMetaHook()

Specified by:

getMetaHook in interface HiveStorageHandler

Overrides:

getMetaHook in class DefaultStorageHandler

Returns:

metadata hook implementation, or null if this storage handler does not need any metadata notifications

configureJobConf

public void configureJobConf(TableDesc tableDesc,
                             org.apache.hadoop.mapred.JobConf jobConf)

Description copied from interface: HiveStorageHandler

Called just before submitting MapReduce job.

Specified by:

configureJobConf in interface HiveStorageHandler

Overrides:

configureJobConf in class DefaultStorageHandler

Parameters:

tableDesc - descriptor for the table being accessed

jobConf - jobConf for MapReduce job

configureInputJobProperties

public void configureInputJobProperties(TableDesc tableDesc,
                                        Map<String,String> jobProperties)

Description copied from interface: HiveStorageHandler

This method is called to allow the StorageHandlers the chance to populate the JobContext.getConfiguration() with properties that maybe be needed by the handler's bundled artifacts (ie InputFormat, SerDe, etc). Key value pairs passed into jobProperties are guaranteed to be set in the job's configuration object. User's can retrieve "context" information from tableDesc. User's should avoid mutating tableDesc and only make changes in jobProperties. This method is expected to be idempotent such that a job called with the same tableDesc values should return the same key-value pairs in jobProperties. Any external state set by this method should remain the same if this method is called again. It is up to the user to determine how best guarantee this invariant. This method in particular is to create a configuration for input.

Specified by:

configureInputJobProperties in interface HiveStorageHandler

Overrides:

configureInputJobProperties in class DefaultStorageHandler

Parameters:

tableDesc - descriptor for the table being accessed

jobProperties - receives properties copied or transformed from the table properties

configureOutputJobProperties

public void configureOutputJobProperties(TableDesc tableDesc,
                                         Map<String,String> jobProperties)

Description copied from interface: HiveStorageHandler

This method is called to allow the StorageHandlers the chance to populate the JobContext.getConfiguration() with properties that maybe be needed by the handler's bundled artifacts (ie InputFormat, SerDe, etc). Key value pairs passed into jobProperties are guaranteed to be set in the job's configuration object. User's can retrieve "context" information from tableDesc. User's should avoid mutating tableDesc and only make changes in jobProperties. This method is expected to be idempotent such that a job called with the same tableDesc values should return the same key-value pairs in jobProperties. Any external state set by this method should remain the same if this method is called again. It is up to the user to determine how best guarantee this invariant. This method in particular is to create a configuration for output.

Specified by:

configureOutputJobProperties in interface HiveStorageHandler

Overrides:

configureOutputJobProperties in class DefaultStorageHandler

Parameters:

tableDesc - descriptor for the table being accessed

jobProperties - receives properties copied or transformed from the table properties

configureTableJobProperties

public void configureTableJobProperties(TableDesc tableDesc,
                                        Map<String,String> jobProperties)

Description copied from interface: HiveStorageHandler

Deprecated use configureInputJobProperties/configureOutputJobProperties methods instead. Configures properties for a job based on the definition of the source or target table it accesses.

Specified by:

configureTableJobProperties in interface HiveStorageHandler

Overrides:

configureTableJobProperties in class DefaultStorageHandler

Parameters:

tableDesc - descriptor for the table being accessed

jobProperties - receives properties copied or transformed from the table properties

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

Overrides:

getConf in class DefaultStorageHandler

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

Overrides:

setConf in class DefaultStorageHandler

getAuthorizationProvider

public HiveAuthorizationProvider getAuthorizationProvider()
                                                   throws HiveException

Description copied from interface: HiveStorageHandler

Returns the implementation specific authorization provider

Specified by:

getAuthorizationProvider in interface HiveStorageHandler

Overrides:

getAuthorizationProvider in class DefaultStorageHandler

Returns:

authorization provider

Throws:

HiveException