IMetaStoreClient (Hive 1.2.2 API)

All Known Implementing Classes:

HiveMetaStoreClient, SessionHiveMetaStoreClient
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface IMetaStoreClient
```
Wrapper around hive metastore thrift api

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IMetaStoreClient.IncompatibleMetastoreException`
`static interface`	`IMetaStoreClient.NotificationFilter` A filter provided by the client that determines if a given notification event should be returned.

Method Summary

Methods
Modifier and Type	Method and Description
`Partition`	`add_partition(Partition partition)` Add a partition to the table.
`int`	`add_partitions_pspec(PartitionSpecProxy partitionSpec)`
`int`	`add_partitions(List<Partition> partitions)` Add partitions to the table.
`List<Partition>`	`add_partitions(List<Partition> partitions, boolean ifNotExists, boolean needResults)` Add partitions to the table.
`void`	`addDynamicPartitions(long txnId, String dbName, String tableName, List<String> partNames)` Send a list of partitions to the metastore to indicate which partitions were loaded dynamically.
`void`	`alter_index(String dbName, String tblName, String indexName, Index index)`
`void`	`alter_partition(String dbName, String tblName, Partition newPart)` updates a partition to new partition
`void`	`alter_partitions(String dbName, String tblName, List<Partition> newParts)` updates a list of partitions
`void`	`alter_table(String defaultDatabaseName, String tblName, Table table)`
`void`	`alter_table(String defaultDatabaseName, String tblName, Table table, boolean cascade)`
`void`	`alterDatabase(String name, Database db)`
`void`	`alterFunction(String dbName, String funcName, Function newFunction)`
`Partition`	`appendPartition(String tableName, String dbName, List<String> partVals)`
`Partition`	`appendPartition(String tableName, String dbName, String name)`
`void`	`cancelDelegationToken(String tokenStrForm)`
`LockResponse`	`checkLock(long lockid)` Check the status of a set of locks requested via a `lock(org.apache.hadoop.hive.metastore.api.LockRequest)` call.
`void`	`close()` close connection to meta store
`void`	`commitTxn(long txnid)` Commit a transaction.
`void`	`compact(String dbname, String tableName, String partitionName, CompactionType type)` Send a request to compact a table or partition.
`boolean`	`create_role(Role role)`
`void`	`createDatabase(Database db)`
`void`	`createFunction(Function func)`
`void`	`createIndex(Index index, Table indexTable)` create an index
`void`	`createTable(Table tbl)`
`boolean`	`deletePartitionColumnStatistics(String dbName, String tableName, String partName, String colName)` Delete partition level column statistics given dbName, tableName, partName and colName
`boolean`	`deleteTableColumnStatistics(String dbName, String tableName, String colName)` Delete table level column statistics given dbName, tableName and colName
`boolean`	`drop_role(String role_name)`
`void`	`dropDatabase(String name)`
`void`	`dropDatabase(String name, boolean deleteData, boolean ignoreUnknownDb)`
`void`	`dropDatabase(String name, boolean deleteData, boolean ignoreUnknownDb, boolean cascade)`
`void`	`dropFunction(String dbName, String funcName)`
`boolean`	`dropIndex(String db_name, String tbl_name, String name, boolean deleteData)`
`boolean`	`dropPartition(String db_name, String tbl_name, List<String> part_vals, boolean deleteData)`
`boolean`	`dropPartition(String db_name, String tbl_name, List<String> part_vals, PartitionDropOptions options)` Method to dropPartitions() with the option to purge the partition data directly, rather than to move data to trash.
`boolean`	`dropPartition(String db_name, String tbl_name, String name, boolean deleteData)`
`List<Partition>`	`dropPartitions(String dbName, String tblName, List<ObjectPair<Integer,byte[]>> partExprs, boolean deleteData, boolean ignoreProtection, boolean ifExists)`
`List<Partition>`	`dropPartitions(String dbName, String tblName, List<ObjectPair<Integer,byte[]>> partExprs, boolean deleteData, boolean ignoreProtection, boolean ifExists, boolean needResults)`
`List<Partition>`	`dropPartitions(String dbName, String tblName, List<ObjectPair<Integer,byte[]>> partExprs, PartitionDropOptions options)` Generalization of dropPartitions(),
`void`	`dropTable(String tableName, boolean deleteData)` Deprecated. As of release 0.6.0 replaced by `dropTable(String, String, boolean, boolean)`. This method will be removed in release 0.7.0.
`void`	`dropTable(String dbname, String tableName)`
`void`	`dropTable(String dbname, String tableName, boolean deleteData, boolean ignoreUnknownTab)` Drop the table.
`void`	`dropTable(String dbname, String tableName, boolean deleteData, boolean ignoreUnknownTab, boolean ifPurge)`
`Partition`	`exchange_partition(Map<String,String> partitionSpecs, String sourceDb, String sourceTable, String destdb, String destTableName)`
`FireEventResponse`	`fireListenerEvent(FireEventRequest request)` Request that the metastore fire an event.
`GetPrincipalsInRoleResponse`	`get_principals_in_role(GetPrincipalsInRoleRequest getPrincRoleReq)` get all role-grants for users/roles that have been granted the given role Note that in the returned list of RolePrincipalGrants, the roleName is redundant as it would match the role_name argument of this function
`PrincipalPrivilegeSet`	`get_privilege_set(HiveObjectRef hiveObject, String user_name, List<String> group_names)` Return the privileges that the user, group have directly and indirectly through roles on the given hiveObject
`GetRoleGrantsForPrincipalResponse`	`get_role_grants_for_principal(GetRoleGrantsForPrincipalRequest getRolePrincReq)` get all role-grants for roles that have been granted to given principal Note that in the returned list of RolePrincipalGrants, the principal information redundant as it would match the principal information in request
`AggrStats`	`getAggrColStatsFor(String dbName, String tblName, List<String> colNames, List<String> partName)`
`List<String>`	`getAllDatabases()` Get the names of all databases in the MetaStore.
`List<String>`	`getAllTables(String dbName)` Get the names of all tables in the specified database.
`String`	`getConfigValue(String name, String defaultValue)`
`CurrentNotificationEventId`	`getCurrentNotificationEventId()` Get the last used notification event id.
`Database`	`getDatabase(String databaseName)` Get a Database Object
`List<String>`	`getDatabases(String databasePattern)` Get the names of all databases in the MetaStore that match the given pattern.
`String`	`getDelegationToken(String owner, String renewerKerberosPrincipalName)` This is expected to be a no-op when in local mode, which means that the implementation will return null.
`List<FieldSchema>`	`getFields(String db, String tableName)`
`Function`	`getFunction(String dbName, String funcName)`
`List<String>`	`getFunctions(String dbName, String pattern)`
`Index`	`getIndex(String dbName, String tblName, String indexName)`
`String`	`getMetaConf(String key)` get current meta variable
`NotificationEventResponse`	`getNextNotification(long lastEventId, int maxEvents, IMetaStoreClient.NotificationFilter filter)` Get the next set of notifications from the database.
`Partition`	`getPartition(String tblName, String dbName, List<String> partVals)`
`Partition`	`getPartition(String dbName, String tblName, String name)`
`Map<String,List<ColumnStatisticsObj>>`	`getPartitionColumnStatistics(String dbName, String tableName, List<String> partNames, List<String> colNames)` Get partitions column statistics given dbName, tableName, multiple partitions and colName-s
`List<Partition>`	`getPartitionsByNames(String db_name, String tbl_name, List<String> part_names)` Get partitions by a list of partition names.
`Partition`	`getPartitionWithAuthInfo(String dbName, String tableName, List<String> pvals, String userName, List<String> groupNames)`
`List<FieldSchema>`	`getSchema(String db, String tableName)`
`Table`	`getTable(String tableName)` Deprecated. As of release 0.6.0 replaced by `getTable(String, String)`. This method will be removed in release 0.7.0.
`Table`	`getTable(String dbName, String tableName)` Get a table object.
`List<ColumnStatisticsObj>`	`getTableColumnStatistics(String dbName, String tableName, List<String> colNames)` Get table column statistics given dbName, tableName and multiple colName-s
`List<Table>`	`getTableObjectsByName(String dbName, List<String> tableNames)`
`List<String>`	`getTables(String dbName, String tablePattern)` Get the names of all tables in the specified database that satisfy the supplied table name pattern.
`String`	`getTokenStrForm()`
`ValidTxnList`	`getValidTxns()` Get a structure that details valid transactions.
`ValidTxnList`	`getValidTxns(long currentTxn)` Get a structure that details valid transactions.
`boolean`	`grant_privileges(PrivilegeBag privileges)`
`boolean`	`grant_role(String role_name, String user_name, PrincipalType principalType, String grantor, PrincipalType grantorType, boolean grantOption)`
`void`	`heartbeat(long txnid, long lockid)` Send a heartbeat to indicate that the client holding these locks (if any) and that opened this transaction (if one exists) is still alive.
`HeartbeatTxnRangeResponse`	`heartbeatTxnRange(long min, long max)` Send heartbeats for a range of transactions.
`boolean`	`isCompatibleWith(HiveConf conf)` Returns whether current client is compatible with conf argument or not
`boolean`	`isPartitionMarkedForEvent(String db_name, String tbl_name, Map<String,String> partKVs, PartitionEventType eventType)`
`List<HiveObjectPrivilege>`	`list_privileges(String principal_name, PrincipalType principal_type, HiveObjectRef hiveObject)` Return the privileges that this principal has directly over the object (not through roles).
`List<Role>`	`list_roles(String principalName, PrincipalType principalType)`
`List<Index>`	`listIndexes(String db_name, String tbl_name, short max)` list indexes of the give base table
`List<String>`	`listIndexNames(String db_name, String tbl_name, short max)` list all the index names of the give base table.
`List<String>`	`listPartitionNames(String db_name, String tbl_name, List<String> part_vals, short max_parts)`
`List<String>`	`listPartitionNames(String db_name, String tbl_name, short max_parts)`
`List<Partition>`	`listPartitions(String db_name, String tbl_name, List<String> part_vals, short max_parts)`
`List<Partition>`	`listPartitions(String db_name, String tbl_name, short max_parts)`
`boolean`	`listPartitionsByExpr(String db_name, String tbl_name, byte[] expr, String default_partition_name, short max_parts, List<Partition> result)` Get list of partitions matching specified serialized expression
`List<Partition>`	`listPartitionsByFilter(String db_name, String tbl_name, String filter, short max_parts)` Get list of partitions matching specified filter
`PartitionSpecProxy`	`listPartitionSpecs(String dbName, String tableName, int maxParts)`
`PartitionSpecProxy`	`listPartitionSpecsByFilter(String db_name, String tbl_name, String filter, int max_parts)`
`List<Partition>`	`listPartitionsWithAuthInfo(String dbName, String tableName, List<String> partialPvals, short s, String userName, List<String> groupNames)`
`List<Partition>`	`listPartitionsWithAuthInfo(String dbName, String tableName, short s, String userName, List<String> groupNames)`
`List<String>`	`listRoleNames()` list all role names
`List<String>`	`listTableNamesByFilter(String dbName, String filter, short maxTables)` Get a list of table names that match a filter.
`LockResponse`	`lock(LockRequest request)` Request a set of locks.
`void`	`markPartitionForEvent(String db_name, String tbl_name, Map<String,String> partKVs, PartitionEventType eventType)`
`long`	`openTxn(String user)` Initiate a transaction.
`OpenTxnsResponse`	`openTxns(String user, int numTxns)` Initiate a batch of transactions.
`Map<String,String>`	`partitionNameToSpec(String name)`
`List<String>`	`partitionNameToVals(String name)`
`void`	`reconnect()` Tries to reconnect this MetaStoreClient to the MetaStore.
`void`	`renamePartition(String dbname, String name, List<String> part_vals, Partition newPart)` rename a partition to a new partition
`long`	`renewDelegationToken(String tokenStrForm)`
`boolean`	`revoke_privileges(PrivilegeBag privileges, boolean grantOption)`
`boolean`	`revoke_role(String role_name, String user_name, PrincipalType principalType, boolean grantOption)`
`void`	`rollbackTxn(long txnid)` Rollback a transaction.
`void`	`setHiveAddedJars(String addedJars)` Set added jars path info to MetaStoreClient.
`void`	`setMetaConf(String key, String value)` set meta variable which is open to end users
`boolean`	`setPartitionColumnStatistics(SetPartitionsStatsRequest request)`
`ShowCompactResponse`	`showCompactions()` Get a list of all current compactions.
`ShowLocksResponse`	`showLocks()` Show all currently held and waiting locks.
`GetOpenTxnsInfoResponse`	`showTxns()` Show the list of currently open transactions.
`boolean`	`tableExists(String tableName)` Deprecated. As of release 0.6.0 replaced by `tableExists(String, String)`. This method will be removed in release 0.7.0.
`boolean`	`tableExists(String databaseName, String tableName)`
`void`	`unlock(long lockid)` Unlock a set of locks.
`boolean`	`updatePartitionColumnStatistics(ColumnStatistics statsObj)` Write partition level column statistics to persistent store
`boolean`	`updateTableColumnStatistics(ColumnStatistics statsObj)` Write table level column statistics to persistent store
`void`	`validatePartitionNameCharacters(List<String> partVals)`

Method Detail

isCompatibleWith
```
boolean isCompatibleWith(HiveConf conf)
```
Returns whether current client is compatible with conf argument or not

Returns:

setHiveAddedJars
```
void setHiveAddedJars(String addedJars)
```
Set added jars path info to MetaStoreClient.

Parameters:
addedJars - the hive.added.jars.path. It is qualified paths separated by commas.

reconnect
```
void reconnect()
               throws MetaException
```
Tries to reconnect this MetaStoreClient to the MetaStore.

Throws:

MetaException

close
```
void close()
```
close connection to meta store

setMetaConf

void setMetaConf(String key,
               String value)
                 throws MetaException,
                        org.apache.thrift.TException

set meta variable which is open to end users

Throws:: MetaException; org.apache.thrift.TException

getMetaConf

String getMetaConf(String key)
                   throws MetaException,
                          org.apache.thrift.TException

get current meta variable

Throws:: MetaException; org.apache.thrift.TException

getDatabases
```
List<String> getDatabases(String databasePattern)
                          throws MetaException,
                                 org.apache.thrift.TException
```
Get the names of all databases in the MetaStore that match the given pattern.

Parameters:
databasePattern -

Returns:
List of database names.

Throws:

MetaException

org.apache.thrift.TException

getAllDatabases

List<String> getAllDatabases()
                             throws MetaException,
                                    org.apache.thrift.TException

Get the names of all databases in the MetaStore.

Returns:: List of database names.
Throws:: MetaException; org.apache.thrift.TException

getTables

List<String> getTables(String dbName,
                     String tablePattern)
                       throws MetaException,
                              org.apache.thrift.TException,
                              UnknownDBException

Get the names of all tables in the specified database that satisfy the supplied table name pattern.

Parameters:: dbName -; tablePattern -
Returns:: List of table names.
Throws:: MetaException; org.apache.thrift.TException; UnknownDBException

getAllTables

List<String> getAllTables(String dbName)
                          throws MetaException,
                                 org.apache.thrift.TException,
                                 UnknownDBException

Get the names of all tables in the specified database.

Parameters:: dbName -
Returns:: List of table names.
Throws:: MetaException; org.apache.thrift.TException; UnknownDBException

listTableNamesByFilter
```
List<String> listTableNamesByFilter(String dbName,
                                  String filter,
                                  short maxTables)
                                    throws MetaException,
                                           org.apache.thrift.TException,
                                           InvalidOperationException,
                                           UnknownDBException
```
Get a list of table names that match a filter. The filter operators are LIKE, <, <=, >, >=, =, <> In the filter statement, values interpreted as strings must be enclosed in quotes, while values interpreted as integers should not be. Strings and integers are the only supported value types. The currently supported key names in the filter are: Constants.HIVE_FILTER_FIELD_OWNER, which filters on the tables' owner's name and supports all filter operators Constants.HIVE_FILTER_FIELD_LAST_ACCESS, which filters on the last access times and supports all filter operators except LIKE Constants.HIVE_FILTER_FIELD_PARAMS, which filters on the tables' parameter keys and values and only supports the filter operators = and <>. Append the parameter key name to HIVE_FILTER_FIELD_PARAMS in the filter statement. For example, to filter on parameter keys called "retention", the key name in the filter statement should be Constants.HIVE_FILTER_FIELD_PARAMS + "retention" Also, = and <> only work for keys that exist in the tables. E.g., filtering on tables where key1 <> value will only return tables that have a value for the parameter key1. Some example filter statements include: filter = Constants.HIVE_FILTER_FIELD_OWNER + " like \".*test.*\" and " + Constants.HIVE_FILTER_FIELD_LAST_ACCESS + " = 0"; filter = Constants.HIVE_FILTER_FIELD_OWNER + " = \"test_user\" and (" + Constants.HIVE_FILTER_FIELD_PARAMS + "retention = \"30\" or " + Constants.HIVE_FILTER_FIELD_PARAMS + "retention = \"90\")"

Parameters:
dbName - The name of the database from which you will retrieve the table names
filter - The filter string
maxTables - The maximum number of tables returned

Returns:
A list of table names that match the desired filter

Throws:

MetaException

org.apache.thrift.TException

InvalidOperationException

UnknownDBException

dropTable
```
void dropTable(String dbname,
             String tableName,
             boolean deleteData,
             boolean ignoreUnknownTab)
               throws MetaException,
                      org.apache.thrift.TException,
                      NoSuchObjectException
```
Drop the table.

Parameters:
dbname - The database for this table
tableName - The table to drop
deleteData - Should we delete the underlying data
ignoreUnknownTab - don't throw if the requested table doesn't exist

Throws:

MetaException - Could not drop table properly.

NoSuchObjectException - The table wasn't found.

org.apache.thrift.TException - A thrift communication error occurred

dropTable

void dropTable(String dbname,
             String tableName,
             boolean deleteData,
             boolean ignoreUnknownTab,
             boolean ifPurge)
               throws MetaException,
                      org.apache.thrift.TException,
                      NoSuchObjectException

Parameters:: ifPurge - completely purge the table (skipping trash) while removing data from warehouse
Throws:: MetaException; org.apache.thrift.TException; NoSuchObjectException
See Also:: dropTable(String, String, boolean, boolean)

dropTable
```
@Deprecated
void dropTable(String tableName,
                        boolean deleteData)
               throws MetaException,
                      UnknownTableException,
                      org.apache.thrift.TException,
                      NoSuchObjectException
```
Deprecated. As of release 0.6.0 replaced by dropTable(String, String, boolean, boolean). This method will be removed in release 0.7.0.

Drop the table in the DEFAULT database.

Parameters:
tableName - The table to drop
deleteData - Should we delete the underlying data

Throws:

MetaException - Could not drop table properly.

UnknownTableException - The table wasn't found.

org.apache.thrift.TException - A thrift communication error occurred

NoSuchObjectException - The table wasn't found.

dropTable

void dropTable(String dbname,
             String tableName)
               throws MetaException,
                      org.apache.thrift.TException,
                      NoSuchObjectException

Throws:: MetaException; org.apache.thrift.TException; NoSuchObjectException
See Also:: dropTable(String, String, boolean, boolean)

tableExists

boolean tableExists(String databaseName,
                  String tableName)
                    throws MetaException,
                           org.apache.thrift.TException,
                           UnknownDBException

Throws:: MetaException; org.apache.thrift.TException; UnknownDBException

tableExists
```
@Deprecated
boolean tableExists(String tableName)
                    throws MetaException,
                           org.apache.thrift.TException,
                           UnknownDBException
```
Deprecated. As of release 0.6.0 replaced by tableExists(String, String). This method will be removed in release 0.7.0.

Check to see if the specified table exists in the DEFAULT database.

Parameters:
tableName -

Returns:
TRUE if DEFAULT.tableName exists, FALSE otherwise.

Throws:

MetaException

org.apache.thrift.TException

UnknownDBException

getTable
```
@Deprecated
Table getTable(String tableName)
               throws MetaException,
                      org.apache.thrift.TException,
                      NoSuchObjectException
```
Deprecated. As of release 0.6.0 replaced by getTable(String, String). This method will be removed in release 0.7.0.

Get a table object from the DEFAULT database.

Parameters:
tableName - Name of the table to fetch.

Returns:
An object representing the table.

Throws:

MetaException - Could not fetch the table

org.apache.thrift.TException - A thrift communication error occurred

NoSuchObjectException - In case the table wasn't found.

getDatabase
```
Database getDatabase(String databaseName)
                     throws NoSuchObjectException,
                            MetaException,
                            org.apache.thrift.TException
```
Get a Database Object

Parameters:
databaseName - name of the database to fetch

Returns:
the database

Throws:

NoSuchObjectException - The database does not exist

MetaException - Could not fetch the database

org.apache.thrift.TException - A thrift communication error occurred

getTable
```
Table getTable(String dbName,
             String tableName)
               throws MetaException,
                      org.apache.thrift.TException,
                      NoSuchObjectException
```
Get a table object.

Parameters:
dbName - The database the table is located in.
tableName - Name of the table to fetch.

Returns:
An object representing the table.

Throws:

MetaException - Could not fetch the table

org.apache.thrift.TException - A thrift communication error occurred

NoSuchObjectException - In case the table wasn't found.

getTableObjectsByName
```
List<Table> getTableObjectsByName(String dbName,
                                List<String> tableNames)
                                  throws MetaException,
                                         InvalidOperationException,
                                         UnknownDBException,
                                         org.apache.thrift.TException
```
Parameters:
dbName - The database the tables are located in.
tableNames - The names of the tables to fetch

Returns:
A list of objects representing the tables. Only the tables that can be retrieved from the database are returned. For example, if none of the requested tables could be retrieved, an empty list is returned. There is no guarantee of ordering of the returned tables.

Throws:

InvalidOperationException - The input to this operation is invalid (e.g., the list of tables names is null)

UnknownDBException - The requested database could not be fetched.

org.apache.thrift.TException - A thrift communication error occurred

MetaException - Any other errors

appendPartition

Partition appendPartition(String tableName,
                        String dbName,
                        List<String> partVals)
                          throws InvalidObjectException,
                                 AlreadyExistsException,
                                 MetaException,
                                 org.apache.thrift.TException

Parameters:: tableName -; dbName -; partVals -
Returns:: the partition object
Throws:: InvalidObjectException; AlreadyExistsException; MetaException; org.apache.thrift.TException
See Also:: ThriftHiveMetastore.Iface.append_partition(java.lang.String, java.lang.String, java.util.List)

appendPartition

Partition appendPartition(String tableName,
                        String dbName,
                        String name)
                          throws InvalidObjectException,
                                 AlreadyExistsException,
                                 MetaException,
                                 org.apache.thrift.TException

Throws:: InvalidObjectException; AlreadyExistsException; MetaException; org.apache.thrift.TException

add_partition

Partition add_partition(Partition partition)
                        throws InvalidObjectException,
                               AlreadyExistsException,
                               MetaException,
                               org.apache.thrift.TException

Add a partition to the table.

Parameters:: partition - The partition to add
Returns:: The partition added
Throws:: InvalidObjectException - Could not find table to add to; AlreadyExistsException - Partition already exists; MetaException - Could not add partition; org.apache.thrift.TException - Thrift exception

add_partitions

int add_partitions(List<Partition> partitions)
                   throws InvalidObjectException,
                          AlreadyExistsException,
                          MetaException,
                          org.apache.thrift.TException

Add partitions to the table.

Parameters:: partitions - The partitions to add
Throws:: InvalidObjectException - Could not find table to add to; AlreadyExistsException - Partition already exists; MetaException - Could not add partition; org.apache.thrift.TException - Thrift exception

add_partitions_pspec

int add_partitions_pspec(PartitionSpecProxy partitionSpec)
                         throws InvalidObjectException,
                                AlreadyExistsException,
                                MetaException,
                                org.apache.thrift.TException

Throws:: InvalidObjectException; AlreadyExistsException; MetaException; org.apache.thrift.TException

add_partitions

List<Partition> add_partitions(List<Partition> partitions,
                             boolean ifNotExists,
                             boolean needResults)
                               throws InvalidObjectException,
                                      AlreadyExistsException,
                                      MetaException,
                                      org.apache.thrift.TException

Add partitions to the table.

Parameters:: partitions - The partitions to add; ifNotExists - only add partitions if they don't exist; needResults - Whether the results are needed
Returns:: the partitions that were added, or null if !needResults
Throws:: InvalidObjectException; AlreadyExistsException; MetaException; org.apache.thrift.TException

getPartition

Partition getPartition(String tblName,
                     String dbName,
                     List<String> partVals)
                       throws NoSuchObjectException,
                              MetaException,
                              org.apache.thrift.TException

Parameters:: tblName -; dbName -; partVals -
Returns:: the partition object
Throws:: MetaException; org.apache.thrift.TException; NoSuchObjectException
See Also:: ThriftHiveMetastore.Iface.get_partition(java.lang.String, java.lang.String, java.util.List)

exchange_partition

Partition exchange_partition(Map<String,String> partitionSpecs,
                           String sourceDb,
                           String sourceTable,
                           String destdb,
                           String destTableName)
                             throws MetaException,
                                    NoSuchObjectException,
                                    InvalidObjectException,
                                    org.apache.thrift.TException

Parameters:: partitionSpecs -; sourceDb -; sourceTable -; destdb -; destTableName -
Returns:: partition object
Throws:: MetaException; NoSuchObjectException; InvalidObjectException; org.apache.thrift.TException

getPartition

Partition getPartition(String dbName,
                     String tblName,
                     String name)
                       throws MetaException,
                              UnknownTableException,
                              NoSuchObjectException,
                              org.apache.thrift.TException

Parameters:: dbName -; tblName -; name - - partition name i.e. 'ds=2010-02-03/ts=2010-02-03 18%3A16%3A01'
Returns:: the partition object
Throws:: MetaException; org.apache.thrift.TException; UnknownTableException; NoSuchObjectException
See Also:: ThriftHiveMetastore.Iface.get_partition(java.lang.String, java.lang.String, java.util.List)

getPartitionWithAuthInfo

Partition getPartitionWithAuthInfo(String dbName,
                                 String tableName,
                                 List<String> pvals,
                                 String userName,
                                 List<String> groupNames)
                                   throws MetaException,
                                          UnknownTableException,
                                          NoSuchObjectException,
                                          org.apache.thrift.TException

Parameters:: dbName -; tableName -; pvals -; userName -; groupNames -
Returns:: the partition
Throws:: MetaException; UnknownTableException; NoSuchObjectException; org.apache.thrift.TException

listPartitions

List<Partition> listPartitions(String db_name,
                             String tbl_name,
                             short max_parts)
                               throws NoSuchObjectException,
                                      MetaException,
                                      org.apache.thrift.TException

Parameters:: tbl_name -; db_name -; max_parts -
Returns:: the list of partitions
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

listPartitionSpecs

PartitionSpecProxy listPartitionSpecs(String dbName,
                                    String tableName,
                                    int maxParts)
                                      throws org.apache.thrift.TException

Throws:: org.apache.thrift.TException

listPartitions

List<Partition> listPartitions(String db_name,
                             String tbl_name,
                             List<String> part_vals,
                             short max_parts)
                               throws NoSuchObjectException,
                                      MetaException,
                                      org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

listPartitionNames

List<String> listPartitionNames(String db_name,
                              String tbl_name,
                              short max_parts)
                                throws MetaException,
                                       org.apache.thrift.TException

Throws:: MetaException; org.apache.thrift.TException

listPartitionNames

List<String> listPartitionNames(String db_name,
                              String tbl_name,
                              List<String> part_vals,
                              short max_parts)
                                throws MetaException,
                                       org.apache.thrift.TException,
                                       NoSuchObjectException

Throws:: MetaException; org.apache.thrift.TException; NoSuchObjectException

listPartitionsByFilter

List<Partition> listPartitionsByFilter(String db_name,
                                     String tbl_name,
                                     String filter,
                                     short max_parts)
                                       throws MetaException,
                                              NoSuchObjectException,
                                              org.apache.thrift.TException

Get list of partitions matching specified filter

Parameters:: db_name - the database name; tbl_name - the table name; filter - the filter string, for example "part1 = \"p1_abc\" and part2 <= "\p2_test\"". Filtering can be done only on string partition keys.; max_parts - the maximum number of partitions to return, all partitions are returned if -1 is passed
Returns:: list of partitions
Throws:: MetaException; NoSuchObjectException; org.apache.thrift.TException

listPartitionSpecsByFilter

PartitionSpecProxy listPartitionSpecsByFilter(String db_name,
                                            String tbl_name,
                                            String filter,
                                            int max_parts)
                                              throws MetaException,
                                                     NoSuchObjectException,
                                                     org.apache.thrift.TException

Throws:: MetaException; NoSuchObjectException; org.apache.thrift.TException

listPartitionsByExpr
```
boolean listPartitionsByExpr(String db_name,
                           String tbl_name,
                           byte[] expr,
                           String default_partition_name,
                           short max_parts,
                           List<Partition> result)
                             throws org.apache.thrift.TException
```
Get list of partitions matching specified serialized expression

Parameters:
db_name - the database name
tbl_name - the table name
expr - expression, serialized from ExprNodeDesc
max_parts - the maximum number of partitions to return, all partitions are returned if -1 is passed
default_partition_name - Default partition name from configuration. If blank, the metastore server-side configuration is used.
result - the resulting list of partitions

Returns:
whether the resulting list contains partitions which may or may not match the expr

Throws:

org.apache.thrift.TException

listPartitionsWithAuthInfo

List<Partition> listPartitionsWithAuthInfo(String dbName,
                                         String tableName,
                                         short s,
                                         String userName,
                                         List<String> groupNames)
                                           throws MetaException,
                                                  org.apache.thrift.TException,
                                                  NoSuchObjectException

Parameters:: dbName -; tableName -; s -; userName -; groupNames -
Returns:: the list of partitions
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

getPartitionsByNames

List<Partition> getPartitionsByNames(String db_name,
                                   String tbl_name,
                                   List<String> part_names)
                                     throws NoSuchObjectException,
                                            MetaException,
                                            org.apache.thrift.TException

Get partitions by a list of partition names.

Parameters:: db_name - database name; tbl_name - table name; part_names - list of partition names
Returns:: list of Partition objects
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

listPartitionsWithAuthInfo

List<Partition> listPartitionsWithAuthInfo(String dbName,
                                         String tableName,
                                         List<String> partialPvals,
                                         short s,
                                         String userName,
                                         List<String> groupNames)
                                           throws MetaException,
                                                  org.apache.thrift.TException,
                                                  NoSuchObjectException

Parameters:: dbName -; tableName -; partialPvals -; s -; userName -; groupNames -
Returns:: the list of paritions
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

markPartitionForEvent

void markPartitionForEvent(String db_name,
                         String tbl_name,
                         Map<String,String> partKVs,
                         PartitionEventType eventType)
                           throws MetaException,
                                  NoSuchObjectException,
                                  org.apache.thrift.TException,
                                  UnknownTableException,
                                  UnknownDBException,
                                  UnknownPartitionException,
                                  InvalidPartitionException

Parameters:: db_name -; tbl_name -; partKVs -; eventType -
Throws:: MetaException; NoSuchObjectException; org.apache.thrift.TException; UnknownTableException; UnknownDBException; UnknownPartitionException; InvalidPartitionException

isPartitionMarkedForEvent

boolean isPartitionMarkedForEvent(String db_name,
                                String tbl_name,
                                Map<String,String> partKVs,
                                PartitionEventType eventType)
                                  throws MetaException,
                                         NoSuchObjectException,
                                         org.apache.thrift.TException,
                                         UnknownTableException,
                                         UnknownDBException,
                                         UnknownPartitionException,
                                         InvalidPartitionException

Parameters:: db_name -; tbl_name -; partKVs -; eventType -
Throws:: MetaException; NoSuchObjectException; org.apache.thrift.TException; UnknownTableException; UnknownDBException; UnknownPartitionException; InvalidPartitionException

validatePartitionNameCharacters

void validatePartitionNameCharacters(List<String> partVals)
                                     throws org.apache.thrift.TException,
                                            MetaException

Parameters:: partVals -
Throws:: org.apache.thrift.TException; MetaException

createTable

void createTable(Table tbl)
                 throws AlreadyExistsException,
                        InvalidObjectException,
                        MetaException,
                        NoSuchObjectException,
                        org.apache.thrift.TException

Parameters:: tbl -
Throws:: AlreadyExistsException; InvalidObjectException; MetaException; NoSuchObjectException; org.apache.thrift.TException
See Also:: ThriftHiveMetastore.Iface.create_table(org.apache.hadoop.hive.metastore.api.Table)

alter_table

void alter_table(String defaultDatabaseName,
               String tblName,
               Table table)
                 throws InvalidOperationException,
                        MetaException,
                        org.apache.thrift.TException

Throws:: InvalidOperationException; MetaException; org.apache.thrift.TException

alter_table

void alter_table(String defaultDatabaseName,
               String tblName,
               Table table,
               boolean cascade)
                 throws InvalidOperationException,
                        MetaException,
                        org.apache.thrift.TException

Throws:: InvalidOperationException; MetaException; org.apache.thrift.TException

createDatabase

void createDatabase(Database db)
                    throws InvalidObjectException,
                           AlreadyExistsException,
                           MetaException,
                           org.apache.thrift.TException

Throws:: InvalidObjectException; AlreadyExistsException; MetaException; org.apache.thrift.TException

dropDatabase

void dropDatabase(String name)
                  throws NoSuchObjectException,
                         InvalidOperationException,
                         MetaException,
                         org.apache.thrift.TException

Throws:: NoSuchObjectException; InvalidOperationException; MetaException; org.apache.thrift.TException

dropDatabase

void dropDatabase(String name,
                boolean deleteData,
                boolean ignoreUnknownDb)
                  throws NoSuchObjectException,
                         InvalidOperationException,
                         MetaException,
                         org.apache.thrift.TException

Throws:: NoSuchObjectException; InvalidOperationException; MetaException; org.apache.thrift.TException

dropDatabase

void dropDatabase(String name,
                boolean deleteData,
                boolean ignoreUnknownDb,
                boolean cascade)
                  throws NoSuchObjectException,
                         InvalidOperationException,
                         MetaException,
                         org.apache.thrift.TException

Throws:: NoSuchObjectException; InvalidOperationException; MetaException; org.apache.thrift.TException

alterDatabase

void alterDatabase(String name,
                 Database db)
                   throws NoSuchObjectException,
                          MetaException,
                          org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

dropPartition

boolean dropPartition(String db_name,
                    String tbl_name,
                    List<String> part_vals,
                    boolean deleteData)
                      throws NoSuchObjectException,
                             MetaException,
                             org.apache.thrift.TException

Parameters:: db_name -; tbl_name -; part_vals -; deleteData - delete the underlying data or just delete the table in metadata
Returns:: true or false
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException
See Also:: ThriftHiveMetastore.Iface.drop_partition(java.lang.String, java.lang.String, java.util.List, boolean)

dropPartition
```
boolean dropPartition(String db_name,
                    String tbl_name,
                    List<String> part_vals,
                    PartitionDropOptions options)
                      throws org.apache.thrift.TException
```
Method to dropPartitions() with the option to purge the partition data directly, rather than to move data to trash.

Parameters:
db_name - Name of the database.
tbl_name - Name of the table.
part_vals - Specification of the partitions being dropped.
options - PartitionDropOptions for the operation.

Returns:
True (if partitions are dropped), else false.

Throws:

org.apache.thrift.TException

dropPartitions

List<Partition> dropPartitions(String dbName,
                             String tblName,
                             List<ObjectPair<Integer,byte[]>> partExprs,
                             boolean deleteData,
                             boolean ignoreProtection,
                             boolean ifExists)
                               throws NoSuchObjectException,
                                      MetaException,
                                      org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

dropPartitions

List<Partition> dropPartitions(String dbName,
                             String tblName,
                             List<ObjectPair<Integer,byte[]>> partExprs,
                             boolean deleteData,
                             boolean ignoreProtection,
                             boolean ifExists,
                             boolean needResults)
                               throws NoSuchObjectException,
                                      MetaException,
                                      org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

dropPartitions

List<Partition> dropPartitions(String dbName,
                             String tblName,
                             List<ObjectPair<Integer,byte[]>> partExprs,
                             PartitionDropOptions options)
                               throws org.apache.thrift.TException

Generalization of dropPartitions(),

Parameters:: dbName - Name of the database; tblName - Name of the table; partExprs - Partition-specification; options - Boolean options for dropping partitions
Returns:: List of Partitions dropped
Throws:: org.apache.thrift.TException - On failure

dropPartition

boolean dropPartition(String db_name,
                    String tbl_name,
                    String name,
                    boolean deleteData)
                      throws NoSuchObjectException,
                             MetaException,
                             org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

alter_partition
```
void alter_partition(String dbName,
                   String tblName,
                   Partition newPart)
                     throws InvalidOperationException,
                            MetaException,
                            org.apache.thrift.TException
```
updates a partition to new partition

Parameters:
dbName - database of the old partition
tblName - table name of the old partition
newPart - new partition

Throws:

InvalidOperationException - if the old partition does not exist

MetaException - if error in updating metadata

org.apache.thrift.TException - if error in communicating with metastore server

alter_partitions

void alter_partitions(String dbName,
                    String tblName,
                    List<Partition> newParts)
                      throws InvalidOperationException,
                             MetaException,
                             org.apache.thrift.TException

updates a list of partitions

Parameters:: dbName - database of the old partition; tblName - table name of the old partition; newParts - list of partitions
Throws:: InvalidOperationException - if the old partition does not exist; MetaException - if error in updating metadata; org.apache.thrift.TException - if error in communicating with metastore server

renamePartition

void renamePartition(String dbname,
                   String name,
                   List<String> part_vals,
                   Partition newPart)
                     throws InvalidOperationException,
                            MetaException,
                            org.apache.thrift.TException

rename a partition to a new partition

Parameters:: dbname - database of the old partition; name - table name of the old partition; part_vals - values of the old partition; newPart - new partition
Throws:: InvalidOperationException - if srcFs and destFs are different; MetaException - if error in updating metadata; org.apache.thrift.TException - if error in communicating with metastore server

getFields

List<FieldSchema> getFields(String db,
                          String tableName)
                            throws MetaException,
                                   org.apache.thrift.TException,
                                   UnknownTableException,
                                   UnknownDBException

Parameters:: db -; tableName -
Throws:: UnknownTableException; UnknownDBException; MetaException; org.apache.thrift.TException
See Also:: ThriftHiveMetastore.Iface.get_fields(java.lang.String, java.lang.String)

getSchema

List<FieldSchema> getSchema(String db,
                          String tableName)
                            throws MetaException,
                                   org.apache.thrift.TException,
                                   UnknownTableException,
                                   UnknownDBException

Parameters:: db -; tableName -
Throws:: UnknownTableException; UnknownDBException; MetaException; org.apache.thrift.TException
See Also:: ThriftHiveMetastore.Iface.get_schema(java.lang.String, java.lang.String)

getConfigValue
```
String getConfigValue(String name,
                    String defaultValue)
                      throws org.apache.thrift.TException,
                             ConfigValSecurityException
```
Parameters:
name - name of the configuration property to get the value of
defaultValue - the value to return if property with the given name doesn't exist

Returns:
value of the specified configuration property

Throws:

org.apache.thrift.TException

ConfigValSecurityException

partitionNameToVals
```
List<String> partitionNameToVals(String name)
                                 throws MetaException,
                                        org.apache.thrift.TException
```
Parameters:
name - the partition name e.g. ("ds=2010-03-03/hr=12")

Returns:
a list containing the partition col values, in the same order as the name

Throws:

MetaException

org.apache.thrift.TException

partitionNameToSpec
```
Map<String,String> partitionNameToSpec(String name)
                                       throws MetaException,
                                              org.apache.thrift.TException
```
Parameters:
name - the partition name e.g. ("ds=2010-03-03/hr=12")

Returns:
a map from the partition col to the value, as listed in the name

Throws:

MetaException

org.apache.thrift.TException

createIndex

void createIndex(Index index,
               Table indexTable)
                 throws InvalidObjectException,
                        MetaException,
                        NoSuchObjectException,
                        org.apache.thrift.TException,
                        AlreadyExistsException

create an index

Parameters:: index - the index object
Throws:: InvalidObjectException; MetaException; NoSuchObjectException; org.apache.thrift.TException; AlreadyExistsException

alter_index

void alter_index(String dbName,
               String tblName,
               String indexName,
               Index index)
                 throws InvalidOperationException,
                        MetaException,
                        org.apache.thrift.TException

Throws:: InvalidOperationException; MetaException; org.apache.thrift.TException

getIndex

Index getIndex(String dbName,
             String tblName,
             String indexName)
               throws MetaException,
                      UnknownTableException,
                      NoSuchObjectException,
                      org.apache.thrift.TException

Parameters:: dbName -; tblName -; indexName -
Returns:: the index
Throws:: MetaException; UnknownTableException; NoSuchObjectException; org.apache.thrift.TException

listIndexes

List<Index> listIndexes(String db_name,
                      String tbl_name,
                      short max)
                        throws NoSuchObjectException,
                               MetaException,
                               org.apache.thrift.TException

list indexes of the give base table

Parameters:: db_name -; tbl_name -; max -
Returns:: the list of indexes
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

listIndexNames

List<String> listIndexNames(String db_name,
                          String tbl_name,
                          short max)
                            throws MetaException,
                                   org.apache.thrift.TException

list all the index names of the give base table.

Parameters:: db_name -; tbl_name -; max -
Returns:: the list of names
Throws:: MetaException; org.apache.thrift.TException

dropIndex

boolean dropIndex(String db_name,
                String tbl_name,
                String name,
                boolean deleteData)
                  throws NoSuchObjectException,
                         MetaException,
                         org.apache.thrift.TException

Parameters:: db_name -; tbl_name -; name - index name; deleteData -
Returns:: true on success
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

updateTableColumnStatistics

boolean updateTableColumnStatistics(ColumnStatistics statsObj)
                                    throws NoSuchObjectException,
                                           InvalidObjectException,
                                           MetaException,
                                           org.apache.thrift.TException,
                                           InvalidInputException

Write table level column statistics to persistent store

Parameters:: statsObj -
Returns:: boolean indicating the status of the operation
Throws:: NoSuchObjectException; InvalidObjectException; MetaException; org.apache.thrift.TException; InvalidInputException

updatePartitionColumnStatistics

boolean updatePartitionColumnStatistics(ColumnStatistics statsObj)
                                        throws NoSuchObjectException,
                                               InvalidObjectException,
                                               MetaException,
                                               org.apache.thrift.TException,
                                               InvalidInputException

Write partition level column statistics to persistent store

Parameters:: statsObj -
Returns:: boolean indicating the status of the operation
Throws:: NoSuchObjectException; InvalidObjectException; MetaException; org.apache.thrift.TException; InvalidInputException

getTableColumnStatistics

List<ColumnStatisticsObj> getTableColumnStatistics(String dbName,
                                                 String tableName,
                                                 List<String> colNames)
                                                   throws NoSuchObjectException,
                                                          MetaException,
                                                          org.apache.thrift.TException

Get table column statistics given dbName, tableName and multiple colName-s

Returns:: ColumnStatistics struct for a given db, table and columns
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

getPartitionColumnStatistics

Map<String,List<ColumnStatisticsObj>> getPartitionColumnStatistics(String dbName,
                                                                 String tableName,
                                                                 List<String> partNames,
                                                                 List<String> colNames)
                                                                   throws NoSuchObjectException,
                                                                          MetaException,
                                                                          org.apache.thrift.TException

Get partitions column statistics given dbName, tableName, multiple partitions and colName-s

Returns:: ColumnStatistics struct for a given db, table and columns
Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

deletePartitionColumnStatistics

boolean deletePartitionColumnStatistics(String dbName,
                                      String tableName,
                                      String partName,
                                      String colName)
                                        throws NoSuchObjectException,
                                               MetaException,
                                               InvalidObjectException,
                                               org.apache.thrift.TException,
                                               InvalidInputException

Delete partition level column statistics given dbName, tableName, partName and colName

Parameters:: dbName -; tableName -; partName -; colName -
Returns:: boolean indicating outcome of the operation
Throws:: NoSuchObjectException; InvalidObjectException; MetaException; org.apache.thrift.TException; InvalidInputException

deleteTableColumnStatistics

boolean deleteTableColumnStatistics(String dbName,
                                  String tableName,
                                  String colName)
                                    throws NoSuchObjectException,
                                           MetaException,
                                           InvalidObjectException,
                                           org.apache.thrift.TException,
                                           InvalidInputException

Delete table level column statistics given dbName, tableName and colName

Parameters:: dbName -; tableName -; colName -
Returns:: boolean indicating the outcome of the operation
Throws:: NoSuchObjectException; MetaException; InvalidObjectException; org.apache.thrift.TException; InvalidInputException

create_role

boolean create_role(Role role)
                    throws MetaException,
                           org.apache.thrift.TException

Parameters:: role - role object
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

drop_role

boolean drop_role(String role_name)
                  throws MetaException,
                         org.apache.thrift.TException

Parameters:: role_name - role name
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

listRoleNames

List<String> listRoleNames()
                           throws MetaException,
                                  org.apache.thrift.TException

list all role names

Returns:: list of names
Throws:: org.apache.thrift.TException; MetaException

grant_role

boolean grant_role(String role_name,
                 String user_name,
                 PrincipalType principalType,
                 String grantor,
                 PrincipalType grantorType,
                 boolean grantOption)
                   throws MetaException,
                          org.apache.thrift.TException

Parameters:: role_name -; user_name -; principalType -; grantor -; grantorType -; grantOption -
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

revoke_role

boolean revoke_role(String role_name,
                  String user_name,
                  PrincipalType principalType,
                  boolean grantOption)
                    throws MetaException,
                           org.apache.thrift.TException

Parameters:: role_name - role name; user_name - user name; principalType -
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

list_roles

List<Role> list_roles(String principalName,
                    PrincipalType principalType)
                      throws MetaException,
                             org.apache.thrift.TException

Parameters:: principalName -; principalType -
Returns:: list of roles
Throws:: MetaException; org.apache.thrift.TException

get_privilege_set

PrincipalPrivilegeSet get_privilege_set(HiveObjectRef hiveObject,
                                      String user_name,
                                      List<String> group_names)
                                        throws MetaException,
                                               org.apache.thrift.TException

Return the privileges that the user, group have directly and indirectly through roles on the given hiveObject

Parameters:: hiveObject -; user_name -; group_names -
Returns:: the privilege set
Throws:: MetaException; org.apache.thrift.TException

list_privileges

List<HiveObjectPrivilege> list_privileges(String principal_name,
                                        PrincipalType principal_type,
                                        HiveObjectRef hiveObject)
                                          throws MetaException,
                                                 org.apache.thrift.TException

Return the privileges that this principal has directly over the object (not through roles).

Parameters:: principal_name -; principal_type -; hiveObject -
Returns:: list of privileges
Throws:: MetaException; org.apache.thrift.TException

grant_privileges

boolean grant_privileges(PrivilegeBag privileges)
                         throws MetaException,
                                org.apache.thrift.TException

Parameters:: privileges -
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

revoke_privileges

boolean revoke_privileges(PrivilegeBag privileges,
                        boolean grantOption)
                          throws MetaException,
                                 org.apache.thrift.TException

Parameters:: privileges -
Returns:: true on success
Throws:: MetaException; org.apache.thrift.TException

getDelegationToken
```
String getDelegationToken(String owner,
                        String renewerKerberosPrincipalName)
                          throws MetaException,
                                 org.apache.thrift.TException
```
This is expected to be a no-op when in local mode, which means that the implementation will return null.

Parameters:
owner - the intended owner for the token
renewerKerberosPrincipalName -

Returns:
the string of the token

Throws:

MetaException

org.apache.thrift.TException

renewDelegationToken

long renewDelegationToken(String tokenStrForm)
                          throws MetaException,
                                 org.apache.thrift.TException

Parameters:: tokenStrForm -
Returns:: the new expiration time
Throws:: MetaException; org.apache.thrift.TException

cancelDelegationToken

void cancelDelegationToken(String tokenStrForm)
                           throws MetaException,
                                  org.apache.thrift.TException

Parameters:: tokenStrForm -
Throws:: MetaException; org.apache.thrift.TException

getTokenStrForm

String getTokenStrForm()
                       throws IOException

Throws:: IOException

createFunction

void createFunction(Function func)
                    throws InvalidObjectException,
                           MetaException,
                           org.apache.thrift.TException

Throws:: InvalidObjectException; MetaException; org.apache.thrift.TException

alterFunction

void alterFunction(String dbName,
                 String funcName,
                 Function newFunction)
                   throws InvalidObjectException,
                          MetaException,
                          org.apache.thrift.TException

Throws:: InvalidObjectException; MetaException; org.apache.thrift.TException

dropFunction

void dropFunction(String dbName,
                String funcName)
                  throws MetaException,
                         NoSuchObjectException,
                         InvalidObjectException,
                         InvalidInputException,
                         org.apache.thrift.TException

Throws:: MetaException; NoSuchObjectException; InvalidObjectException; InvalidInputException; org.apache.thrift.TException

getFunction

Function getFunction(String dbName,
                   String funcName)
                     throws MetaException,
                            org.apache.thrift.TException

Throws:: MetaException; org.apache.thrift.TException

getFunctions

List<String> getFunctions(String dbName,
                        String pattern)
                          throws MetaException,
                                 org.apache.thrift.TException

Throws:: MetaException; org.apache.thrift.TException

getValidTxns
```
ValidTxnList getValidTxns()
                          throws org.apache.thrift.TException
```
Get a structure that details valid transactions.

Returns:
list of valid transactions

Throws:

org.apache.thrift.TException

getValidTxns
```
ValidTxnList getValidTxns(long currentTxn)
                          throws org.apache.thrift.TException
```
Get a structure that details valid transactions.

Parameters:
currentTxn - The current transaction of the caller. This will be removed from the exceptions list so that the caller sees records from his own transaction.

Returns:
list of valid transactions

Throws:

org.apache.thrift.TException

openTxn
```
long openTxn(String user)
             throws org.apache.thrift.TException
```
Initiate a transaction.

Parameters:
user - User who is opening this transaction. This is the Hive user, not necessarily the OS user. It is assumed that this user has already been authenticated and authorized at this point.

Returns:
transaction identifier

Throws:

org.apache.thrift.TException

openTxns
```
OpenTxnsResponse openTxns(String user,
                        int numTxns)
                          throws org.apache.thrift.TException
```
Initiate a batch of transactions. It is not guaranteed that the requested number of transactions will be instantiated. The system has a maximum number instantiated per request, controlled by hive.txn.max .batch.open in hive-site.xml. If the user requests more than this value, only the configured max will be returned.
Increasing the number of transactions requested in the batch will allow applications that stream data into Hive to place more commits in a single file, thus reducing load on the namenode and making reads of the data more efficient. However, opening more transactions in a batch will also result in readers needing to keep a larger list of open transactions to ignore, potentially slowing their reads. Users will need to test in their system to understand the optimal number of transactions to request in a batch.

Parameters:
user - User who is opening this transaction. This is the Hive user, not necessarily the OS user. It is assumed that this user has already been authenticated and authorized at this point.
numTxns - number of requested transactions to open

Returns:
list of opened txn ids. As noted above, this may be less than requested, so the user should check how many were returned rather than optimistically assuming that the result matches the request.

Throws:

org.apache.thrift.TException

rollbackTxn
```
void rollbackTxn(long txnid)
                 throws NoSuchTxnException,
                        org.apache.thrift.TException
```
Rollback a transaction. This will also unlock any locks associated with this transaction.

Parameters:
txnid - id of transaction to be rolled back.

Throws:

NoSuchTxnException - if the requested transaction does not exist. Note that this can result from the transaction having timed out and been deleted.

org.apache.thrift.TException

commitTxn
```
void commitTxn(long txnid)
               throws NoSuchTxnException,
                      TxnAbortedException,
                      org.apache.thrift.TException
```
Commit a transaction. This will also unlock any locks associated with this transaction.

Parameters:
txnid - id of transaction to be committed.

Throws:

NoSuchTxnException - if the requested transaction does not exist. This can result fro the transaction having timed out and been deleted by the compactor.

TxnAbortedException - if the requested transaction has been aborted. This can result from the transaction timing out.

org.apache.thrift.TException

showTxns
```
GetOpenTxnsInfoResponse showTxns()
                                 throws org.apache.thrift.TException
```
Show the list of currently open transactions. This is for use by "show transactions" in the grammar, not for applications that want to find a list of current transactions to work with. Those wishing the latter should call getValidTxns().

Returns:
List of currently opened transactions, included aborted ones.

Throws:

org.apache.thrift.TException

lock
```
LockResponse lock(LockRequest request)
                  throws NoSuchTxnException,
                         TxnAbortedException,
                         org.apache.thrift.TException
```
Request a set of locks. All locks needed for a particular query, DML, or DDL operation should be batched together and requested in one lock call. This avoids deadlocks. It also avoids blocking other users who only require some of the locks required by this user.
If the operation requires a transaction (INSERT, UPDATE, or DELETE) that transaction id must be provided as part this lock request. All locks associated with a transaction will be released when that transaction is committed or rolled back.
*
Once a lock is acquired, heartbeat(long, long) must be called on a regular basis to avoid the lock being timed out by the system.

Parameters:
request - The lock request. LockRequestBuilder can be used construct this request.

Returns:
a lock response, which will provide two things, the id of the lock (to be used in all further calls regarding this lock) as well as a state of the lock. If the state is ACQUIRED then the user can proceed. If it is WAITING the user should wait and call checkLock(long) before proceeding. All components of the lock will have the same state.

Throws:

NoSuchTxnException - if the requested transaction does not exist. This can result fro the transaction having timed out and been deleted by the compactor.

TxnAbortedException - if the requested transaction has been aborted. This can result from the transaction timing out.

org.apache.thrift.TException

checkLock
```
LockResponse checkLock(long lockid)
                       throws NoSuchTxnException,
                              TxnAbortedException,
                              NoSuchLockException,
                              org.apache.thrift.TException
```
Check the status of a set of locks requested via a lock(org.apache.hadoop.hive.metastore.api.LockRequest) call. Once a lock is acquired, heartbeat(long, long) must be called on a regular basis to avoid the lock being timed out by the system.

Parameters:
lockid - lock id returned by lock().

Returns:
a lock response, which will provide two things, the id of the lock (to be used in all further calls regarding this lock) as well as a state of the lock. If the state is ACQUIRED then the user can proceed. If it is WAITING the user should wait and call this method again before proceeding. All components of the lock will have the same state.

Throws:

NoSuchTxnException - if the requested transaction does not exist. This can result fro the transaction having timed out and been deleted by the compactor.

TxnAbortedException - if the requested transaction has been aborted. This can result from the transaction timing out.

NoSuchLockException - if the requested lockid does not exist. This can result from the lock timing out and being unlocked by the system.

org.apache.thrift.TException

unlock
```
void unlock(long lockid)
            throws NoSuchLockException,
                   TxnOpenException,
                   org.apache.thrift.TException
```
Unlock a set of locks. This can only be called when the locks are not assocaited with a transaction.

Parameters:
lockid - lock id returned by lock(org.apache.hadoop.hive.metastore.api.LockRequest)

Throws:

NoSuchLockException - if the requested lockid does not exist. This can result from the lock timing out and being unlocked by the system.

TxnOpenException - if the locks are are associated with a transaction.

org.apache.thrift.TException

showLocks
```
ShowLocksResponse showLocks()
                            throws org.apache.thrift.TException
```
Show all currently held and waiting locks.

Returns:
List of currently held and waiting locks.

Throws:

org.apache.thrift.TException

heartbeat
```
void heartbeat(long txnid,
             long lockid)
               throws NoSuchLockException,
                      NoSuchTxnException,
                      TxnAbortedException,
                      org.apache.thrift.TException
```
Send a heartbeat to indicate that the client holding these locks (if any) and that opened this transaction (if one exists) is still alive. The default timeout for transactions and locks is 300 seconds, though it is configurable. To determine how often to heartbeat you will need to ask your system administrator how the metastore thrift service has been configured.

Parameters:
txnid - the id of the open transaction. If no transaction is open (it is a DDL or query) then this can be set to 0.
lockid - the id of the locks obtained. If no locks have been obtained then this can be set to 0.

Throws:

NoSuchTxnException - if the requested transaction does not exist. This can result fro the transaction having timed out and been deleted by the compactor.

TxnAbortedException - if the requested transaction has been aborted. This can result from the transaction timing out.

NoSuchLockException - if the requested lockid does not exist. This can result from the lock timing out and being unlocked by the system.

org.apache.thrift.TException

heartbeatTxnRange
```
HeartbeatTxnRangeResponse heartbeatTxnRange(long min,
                                          long max)
                                            throws org.apache.thrift.TException
```
Send heartbeats for a range of transactions. This is for the streaming ingest client that will have many transactions open at once. Everyone else should use heartbeat(long, long).

Parameters:
min - minimum transaction id to heartbeat, inclusive
max - maximum transaction id to heartbeat, inclusive

Returns:
a pair of lists that tell which transactions in the list did not exist (they may have already been closed) and which were aborted.

Throws:

org.apache.thrift.TException

compact
```
void compact(String dbname,
           String tableName,
           String partitionName,
           CompactionType type)
             throws org.apache.thrift.TException
```
Send a request to compact a table or partition. This will not block until the compaction is complete. It will instead put a request on the queue for that table or partition to be compacted. No checking is done on the dbname, tableName, or partitionName to make sure they refer to valid objects. It is assumed this has already been done by the caller.

Parameters:
dbname - Name of the database the table is in. If null, this will be assumed to be 'default'.
tableName - Name of the table to be compacted. This cannot be null. If partitionName is null, this must be a non-partitioned table.
partitionName - Name of the partition to be compacted
type - Whether this is a major or minor compaction.

Throws:

org.apache.thrift.TException

showCompactions
```
ShowCompactResponse showCompactions()
                                    throws org.apache.thrift.TException
```
Get a list of all current compactions.

Returns:
List of all current compactions. This includes compactions waiting to happen, in progress, and finished but waiting to clean the existing files.

Throws:

org.apache.thrift.TException

addDynamicPartitions

void addDynamicPartitions(long txnId,
                        String dbName,
                        String tableName,
                        List<String> partNames)
                          throws org.apache.thrift.TException

Send a list of partitions to the metastore to indicate which partitions were loaded dynamically.

Parameters:: txnId - id of the transaction; dbName - database name; tableName - table name; partNames - partition name, as constructed by Warehouse.makePartName
Throws:: org.apache.thrift.TException

getNextNotification
```
@InterfaceAudience.LimitedPrivate(value="HCatalog")
NotificationEventResponse getNextNotification(long lastEventId,
                                                                                  int maxEvents,
                                                                                  IMetaStoreClient.NotificationFilter filter)
                                              throws org.apache.thrift.TException
```
Get the next set of notifications from the database.

Parameters:
lastEventId - The last event id that was consumed by this reader. The returned notifications will start at the next eventId available after this eventId.
maxEvents - Maximum number of events to return. If < 1, then all available events will be returned.
filter - User provided filter to remove unwanted events. If null, all events will be returned.

Returns:
list of notifications, sorted by eventId. It is guaranteed that the events are in the order that the operations were done on the database.

Throws:

org.apache.thrift.TException

getCurrentNotificationEventId

@InterfaceAudience.LimitedPrivate(value="HCatalog")
CurrentNotificationEventId getCurrentNotificationEventId()
                                                         throws org.apache.thrift.TException

Get the last used notification event id.

Returns:: last used id
Throws:: org.apache.thrift.TException

fireListenerEvent
```
@InterfaceAudience.LimitedPrivate(value="Apache Hive, HCatalog")
FireEventResponse fireListenerEvent(FireEventRequest request)
                                    throws org.apache.thrift.TException
```
Request that the metastore fire an event. Currently this is only supported for DML operations, since the metastore knows when DDL operations happen.

Parameters:
request -

Returns:
response, type depends on type of request

Throws:

org.apache.thrift.TException

get_principals_in_role
```
GetPrincipalsInRoleResponse get_principals_in_role(GetPrincipalsInRoleRequest getPrincRoleReq)
                                                   throws MetaException,
                                                          org.apache.thrift.TException
```
get all role-grants for users/roles that have been granted the given role Note that in the returned list of RolePrincipalGrants, the roleName is redundant as it would match the role_name argument of this function

Parameters:
getPrincRoleReq -

Returns:

Throws:

MetaException

org.apache.thrift.TException

get_role_grants_for_principal
```
GetRoleGrantsForPrincipalResponse get_role_grants_for_principal(GetRoleGrantsForPrincipalRequest getRolePrincReq)
                                                                throws MetaException,
                                                                       org.apache.thrift.TException
```
get all role-grants for roles that have been granted to given principal Note that in the returned list of RolePrincipalGrants, the principal information redundant as it would match the principal information in request

Parameters:
getRolePrincReq -

Returns:

Throws:

MetaException

org.apache.thrift.TException

getAggrColStatsFor

AggrStats getAggrColStatsFor(String dbName,
                           String tblName,
                           List<String> colNames,
                           List<String> partName)
                             throws NoSuchObjectException,
                                    MetaException,
                                    org.apache.thrift.TException

Throws:: NoSuchObjectException; MetaException; org.apache.thrift.TException

setPartitionColumnStatistics

boolean setPartitionColumnStatistics(SetPartitionsStatsRequest request)
                                     throws NoSuchObjectException,
                                            InvalidObjectException,
                                            MetaException,
                                            org.apache.thrift.TException,
                                            InvalidInputException

Throws:: NoSuchObjectException; InvalidObjectException; MetaException; org.apache.thrift.TException; InvalidInputException

Interface IMetaStoreClient

Nested Class Summary

Method Summary

Method Detail

isCompatibleWith

setHiveAddedJars

reconnect

close

setMetaConf

getMetaConf

getDatabases

getAllDatabases

getTables

getAllTables

listTableNamesByFilter

dropTable

dropTable

dropTable

dropTable

tableExists

tableExists

getTable

getDatabase

getTable

getTableObjectsByName

appendPartition

appendPartition

add_partition

add_partitions

add_partitions_pspec

add_partitions

getPartition

exchange_partition

getPartition

getPartitionWithAuthInfo

listPartitions

listPartitionSpecs

listPartitions

listPartitionNames

listPartitionNames

listPartitionsByFilter

listPartitionSpecsByFilter

listPartitionsByExpr

listPartitionsWithAuthInfo

getPartitionsByNames

listPartitionsWithAuthInfo

markPartitionForEvent

isPartitionMarkedForEvent

validatePartitionNameCharacters

createTable

alter_table

alter_table

createDatabase

dropDatabase

dropDatabase

dropDatabase

alterDatabase

dropPartition

dropPartition

dropPartitions

dropPartitions

dropPartitions

dropPartition

alter_partition

alter_partitions

renamePartition

getFields

getSchema

getConfigValue

partitionNameToVals

partitionNameToSpec

createIndex

alter_index

getIndex

listIndexes

listIndexNames

dropIndex

updateTableColumnStatistics

updatePartitionColumnStatistics

getTableColumnStatistics