org.apache.hive.hcatalog.streaming

Class HiveEndPoint

java.lang.Object

org.apache.hive.hcatalog.streaming.HiveEndPoint

public class HiveEndPoint
extends Object

Information about the hive end point (i.e. table or partition) to write to. A light weight object that does NOT internally hold on to resources such as network connections. It can be stored in Hashed containers such as sets and hash tables.

Field Summary

Fields

Modifier and Type	Field and Description
String	database
String	metaStoreUri
ArrayList<String>	partitionVals
String	table

Constructor Summary

Constructors

Constructor and Description
HiveEndPoint(String metaStoreUri, String database, String table, List<String> partitionVals)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
StreamingConnection	newConnection(boolean createPartIfNotExists) Acquire a new connection to MetaStore for streaming
StreamingConnection	newConnection(boolean createPartIfNotExists, HiveConf conf) Acquire a new connection to MetaStore for streaming
StreamingConnection	newConnection(boolean createPartIfNotExists, HiveConf conf, org.apache.hadoop.security.UserGroupInformation authenticatedUser) Acquire a new connection to MetaStore for streaming.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metaStoreUri

public final String metaStoreUri

database

public final String database

table

public final String table

partitionVals

public final ArrayList<String> partitionVals

Constructor Detail

HiveEndPoint

public HiveEndPoint(String metaStoreUri,
            String database,
            String table,
            List<String> partitionVals)

Parameters:

metaStoreUri - URI of the metastore to connect to eg: thrift://localhost:9083

database - Name of the Hive database

table - Name of table to stream to

partitionVals - Indicates the specific partition to stream to. Can be null or empty List if streaming to a table without partitions. The order of values in this list must correspond exactly to the order of partition columns specified during the table creation. E.g. For a table partitioned by (continent string, country string), partitionVals could be the list ("Asia", "India").

Method Detail

newConnection

public StreamingConnection newConnection(boolean createPartIfNotExists)
                                  throws ConnectionError,
                                         InvalidPartition,
                                         InvalidTable,
                                         PartitionCreationFailed,
                                         ImpersonationFailed,
                                         InterruptedException

Acquire a new connection to MetaStore for streaming

Parameters:

createPartIfNotExists - If true, the partition specified in the endpoint will be auto created if it does not exist

Returns:

Throws:

ConnectionError - if problem connecting

InvalidPartition - if specified partition is not valid (createPartIfNotExists = false)

ImpersonationFailed - if not able to impersonate 'proxyUser'

IOException - if there was an I/O error when acquiring connection

PartitionCreationFailed - if failed to create partition

InterruptedException

InvalidTable

newConnection

public StreamingConnection newConnection(boolean createPartIfNotExists,
                                HiveConf conf)
                                  throws ConnectionError,
                                         InvalidPartition,
                                         InvalidTable,
                                         PartitionCreationFailed,
                                         ImpersonationFailed,
                                         InterruptedException

Acquire a new connection to MetaStore for streaming

Parameters:

createPartIfNotExists - If true, the partition specified in the endpoint will be auto created if it does not exist

conf - HiveConf object, set it to null if not using advanced hive settings.

Returns:

Throws:

ConnectionError - if problem connecting

InvalidPartition - if specified partition is not valid (createPartIfNotExists = false)

ImpersonationFailed - if not able to impersonate 'proxyUser'

IOException - if there was an I/O error when acquiring connection

PartitionCreationFailed - if failed to create partition

InterruptedException

InvalidTable

newConnection

public StreamingConnection newConnection(boolean createPartIfNotExists,
                                HiveConf conf,
                                org.apache.hadoop.security.UserGroupInformation authenticatedUser)
                                  throws ConnectionError,
                                         InvalidPartition,
                                         InvalidTable,
                                         PartitionCreationFailed,
                                         ImpersonationFailed,
                                         InterruptedException

Acquire a new connection to MetaStore for streaming. To connect using Kerberos, 'authenticatedUser' argument should have been used to do a kerberos login. Additionally the 'hive.metastore.kerberos.principal' setting should be set correctly either in hive-site.xml or in the 'conf' argument (if not null). If using hive-site.xml, it should be in classpath.

Parameters:

createPartIfNotExists - If true, the partition specified in the endpoint will be auto created if it does not exist

conf - HiveConf object to be used for the connection. Can be null.

authenticatedUser - UserGroupInformation object obtained from successful authentication. Uses non-secure mode if this argument is null.

Returns:

Throws:

ConnectionError - if there is a connection problem

InvalidPartition - if specified partition is not valid (createPartIfNotExists = false)

ImpersonationFailed - if not able to impersonate 'username'

IOException - if there was an I/O error when acquiring connection

PartitionCreationFailed - if failed to create partition

InterruptedException

InvalidTable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object