org.apache.hadoop.hive.metastore.tools

Class HMSClient

java.lang.Object

org.apache.hadoop.hive.metastore.tools.HMSClient

All Implemented Interfaces:

AutoCloseable

public final class HMSClient
extends Object
implements AutoCloseable

Wrapper for Thrift HMS interface.

Constructor Summary

Constructors

Constructor and Description
HMSClient(@Nullable URI uri) Connect to HMS and return a client instance.
HMSClient(@Nullable URI uri, @Nullable String confDir) Connect to HMS and return a client instance.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.hive.metastore.api.Partition	addPartition(@NotNull org.apache.hadoop.hive.metastore.api.Partition partition)
void	addPartitions(List<org.apache.hadoop.hive.metastore.api.Partition> partitions)
void	alterPartition(@NotNull String dbName, @NotNull String tableName, @NotNull org.apache.hadoop.hive.metastore.api.Partition partition)
void	alterPartitions(@NotNull String dbName, @NotNull String tableName, @NotNull List<org.apache.hadoop.hive.metastore.api.Partition> partitions)
boolean	alterTable(@NotNull String dbName, @NotNull String tableName, @NotNull org.apache.hadoop.hive.metastore.api.Table newTable)
void	appendPartition(@NotNull String dbName, @NotNull String tableName, @NotNull List<String> partitionValues)
HMSClient	Clone() Return a new connected client using the same configuration as the original client.
void	close()
boolean	createDatabase(org.apache.hadoop.hive.metastore.api.Database db)
boolean	createDatabase(@NotNull String name) Create database with the given name if it doesn't exist
boolean	createDatabase(@NotNull String name, @Nullable String description, @Nullable String location, @Nullable Map<String,String> params) Create database if it doesn't exist
org.apache.hadoop.hive.metastore.api.Partition	createPartition(@NotNull org.apache.hadoop.hive.metastore.api.Table table, @NotNull List<String> values)
boolean	createTable(org.apache.hadoop.hive.metastore.api.Table table)
boolean	dbExists(@NotNull String dbName) Return True if given Hive database excists
boolean	dropDatabase(@NotNull String dbName)
boolean	dropPartition(@NotNull String dbName, @NotNull String tableName, @NotNull List<String> arguments)
org.apache.hadoop.hive.metastore.api.DropPartitionsResult	dropPartitions(@NotNull String dbName, @NotNull String tableName, @Nullable List<String> partNames)
boolean	dropTable(@NotNull String dbName, @NotNull String tableName)
Set<String>	getAllDatabases(@Nullable String filter) Return all databases with name matching the filter.
Set<String>	getAllTables(@NotNull String dbName, @Nullable String filter) Get all table names for a database matching the filter.
Long	getCurrentNotificationId()
org.apache.hadoop.hive.metastore.api.Database	getDatabase(@NotNull String dbName) Get full Database information.
List<String>	getPartitionNames(@NotNull String dbName, @NotNull String tableName)
List<org.apache.hadoop.hive.metastore.api.Partition>	getPartitions(@NotNull String dbName, @NotNull String tableName)
List<org.apache.hadoop.hive.metastore.api.Partition>	getPartitionsByNames(@NotNull String dbName, @NotNull String tableName, @Nullable List<String> names)
URI	getServerURI()
org.apache.hadoop.hive.metastore.api.Table	getTable(@NotNull String dbName, @NotNull String tableName)
List<org.apache.hadoop.hive.metastore.api.Partition>	listPartitions(@NotNull String dbName, @NotNull String tableName)
boolean	tableExists(@NotNull String dbName, @NotNull String tableName) Return True if specified table exists
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HMSClient

public HMSClient(@Nullable
                 @Nullable URI uri)
          throws org.apache.thrift.TException,
                 IOException,
                 InterruptedException,
                 LoginException,
                 URISyntaxException

Connect to HMS and return a client instance.

Parameters:

uri - Hive Metastore URI.

Throws:

org.apache.thrift.TException

IOException

InterruptedException

LoginException

URISyntaxException

HMSClient

public HMSClient(@Nullable
                 @Nullable URI uri,
                 @Nullable
                 @Nullable String confDir)
          throws org.apache.thrift.TException,
                 IOException,
                 InterruptedException,
                 LoginException,
                 URISyntaxException

Connect to HMS and return a client instance.

Parameters:

uri - Hive Metastore URI.

confDir - Directory with Hive configuration files - normally /etc/hive/conf

Throws:

org.apache.thrift.TException

IOException

InterruptedException

LoginException

URISyntaxException

Method Detail

getServerURI

public URI getServerURI()

toString

public String toString()

Overrides:

toString in class Object

Clone

public HMSClient Clone()
                throws InterruptedException,
                       URISyntaxException,
                       org.apache.thrift.TException,
                       LoginException,
                       IOException

Return a new connected client using the same configuration as the original client.

Returns:

New connected client instance

Throws:

InterruptedException

URISyntaxException

org.apache.thrift.TException

LoginException

IOException

dbExists

public boolean dbExists(@NotNull
                        @NotNull String dbName)
                 throws org.apache.thrift.TException

Return True if given Hive database excists

Parameters:

dbName - database name

Returns:

True iff dbName exists

Throws:

org.apache.thrift.TException - if there is Thrift error

tableExists

public boolean tableExists(@NotNull
                           @NotNull String dbName,
                           @NotNull
                           @NotNull String tableName)
                    throws org.apache.thrift.TException

Return True if specified table exists

Parameters:

dbName - Database name

tableName - Table name

Returns:

True iff table exists

Throws:

org.apache.thrift.TException - if there is Thrift error

getDatabase

public org.apache.hadoop.hive.metastore.api.Database getDatabase(@NotNull
                                                                 @NotNull String dbName)
                                                          throws org.apache.thrift.TException

Get full Database information.

Parameters:

dbName - Database name.

Returns:

Throws:

org.apache.thrift.TException - if there is Thrift error

getAllDatabases

public Set<String> getAllDatabases(@Nullable
                                   @Nullable String filter)
                            throws org.apache.thrift.TException

Return all databases with name matching the filter.

Parameters:

filter - Regexp. Can be null or empty in which case everything matches

Returns:

list of database names matching the filter

Throws:

org.apache.thrift.TException - when the call fails

getAllTables

public Set<String> getAllTables(@NotNull
                                @NotNull String dbName,
                                @Nullable
                                @Nullable String filter)
                         throws org.apache.thrift.TException

Get all table names for a database matching the filter. If filter is null or emoty, return all table names. This call does not use native HMS table name matching, it uses client-side regexp matching instead.

Parameters:

dbName - Database name

filter - regexp matching table name

Returns:

Set of matching table names or set of all table names

Throws:

org.apache.thrift.TException - if there is Thrift error

createDatabase

public boolean createDatabase(@NotNull
                              @NotNull String name)
                       throws org.apache.thrift.TException

Create database with the given name if it doesn't exist

Parameters:

name - database name

Returns:

True if successfull, false otherwise

Throws:

org.apache.thrift.TException - if the call fails

createDatabase

public boolean createDatabase(@NotNull
                              @NotNull String name,
                              @Nullable
                              @Nullable String description,
                              @Nullable
                              @Nullable String location,
                              @Nullable
                              @Nullable Map<String,String> params)
                       throws org.apache.thrift.TException

Create database if it doesn't exist

Parameters:

name - Database name

description - Database description

location - Database location

params - Database params

Returns:

True if successfull, false otherwise

Throws:

org.apache.thrift.TException - if call fails

createDatabase

public boolean createDatabase(org.apache.hadoop.hive.metastore.api.Database db)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

dropDatabase

public boolean dropDatabase(@NotNull
                            @NotNull String dbName)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

createTable

public boolean createTable(org.apache.hadoop.hive.metastore.api.Table table)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

dropTable

public boolean dropTable(@NotNull
                         @NotNull String dbName,
                         @NotNull
                         @NotNull String tableName)
                  throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

getTable

public org.apache.hadoop.hive.metastore.api.Table getTable(@NotNull
                                                           @NotNull String dbName,
                                                           @NotNull
                                                           @NotNull String tableName)
                                                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

createPartition

public org.apache.hadoop.hive.metastore.api.Partition createPartition(@NotNull
                                                                      @NotNull org.apache.hadoop.hive.metastore.api.Table table,
                                                                      @NotNull
                                                                      @NotNull List<String> values)
                                                               throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

addPartition

public org.apache.hadoop.hive.metastore.api.Partition addPartition(@NotNull
                                                                   @NotNull org.apache.hadoop.hive.metastore.api.Partition partition)
                                                            throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

addPartitions

public void addPartitions(List<org.apache.hadoop.hive.metastore.api.Partition> partitions)
                   throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

listPartitions

public List<org.apache.hadoop.hive.metastore.api.Partition> listPartitions(@NotNull
                                                                           @NotNull String dbName,
                                                                           @NotNull
                                                                           @NotNull String tableName)
                                                                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

getCurrentNotificationId

public Long getCurrentNotificationId()
                              throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

getPartitionNames

public List<String> getPartitionNames(@NotNull
                                      @NotNull String dbName,
                                      @NotNull
                                      @NotNull String tableName)
                               throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

dropPartition

public boolean dropPartition(@NotNull
                             @NotNull String dbName,
                             @NotNull
                             @NotNull String tableName,
                             @NotNull
                             @NotNull List<String> arguments)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

getPartitions

public List<org.apache.hadoop.hive.metastore.api.Partition> getPartitions(@NotNull
                                                                          @NotNull String dbName,
                                                                          @NotNull
                                                                          @NotNull String tableName)
                                                                   throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

dropPartitions

public org.apache.hadoop.hive.metastore.api.DropPartitionsResult dropPartitions(@NotNull
                                                                                @NotNull String dbName,
                                                                                @NotNull
                                                                                @NotNull String tableName,
                                                                                @Nullable
                                                                                @Nullable List<String> partNames)
                                                                         throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

getPartitionsByNames

public List<org.apache.hadoop.hive.metastore.api.Partition> getPartitionsByNames(@NotNull
                                                                                 @NotNull String dbName,
                                                                                 @NotNull
                                                                                 @NotNull String tableName,
                                                                                 @Nullable
                                                                                 @Nullable List<String> names)
                                                                          throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

alterTable

public boolean alterTable(@NotNull
                          @NotNull String dbName,
                          @NotNull
                          @NotNull String tableName,
                          @NotNull
                          @NotNull org.apache.hadoop.hive.metastore.api.Table newTable)
                   throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

alterPartition

public void alterPartition(@NotNull
                           @NotNull String dbName,
                           @NotNull
                           @NotNull String tableName,
                           @NotNull
                           @NotNull org.apache.hadoop.hive.metastore.api.Partition partition)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

alterPartitions

public void alterPartitions(@NotNull
                            @NotNull String dbName,
                            @NotNull
                            @NotNull String tableName,
                            @NotNull
                            @NotNull List<org.apache.hadoop.hive.metastore.api.Partition> partitions)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

appendPartition

public void appendPartition(@NotNull
                            @NotNull String dbName,
                            @NotNull
                            @NotNull String tableName,
                            @NotNull
                            @NotNull List<String> partitionValues)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception