Hive (Hive 2.3.9 API)

java.lang.Object
- org.apache.hadoop.hive.ql.metadata.Hive

```
public class Hive
extends Object
```
This class has functions that implement meta data/DDL operations using calls to the metastore. It has a metastore client instance it uses to communicate with the metastore. It is a thread local variable, and the instances is accessed using static get methods in this class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Hive.SchemaException

Nested Classes
Modifier and Type	Class and Description
`static class`	`Hive.SchemaException`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortTransactions(List<Long> txnids)`
`void`	`addForeignKey(List<SQLForeignKey> foreignKeyCols)`
`void`	`addPrimaryKey(List<SQLPrimaryKey> primaryKeyCols)`
`void`	`alterDatabase(String dbName, Database db)`
`void`	`alterFunction(String dbName, String funcName, Function newFunction)`
`void`	`alterIndex(String baseTableName, String indexName, Index newIdx)`
`void`	`alterIndex(String dbName, String baseTblName, String idxName, Index newIdx)` Updates the existing index metadata with the new metadata.
`void`	`alterPartition(String tblName, Partition newPart, EnvironmentContext environmentContext)` Updates the existing partition metadata with the new metadata.
`void`	`alterPartition(String dbName, String tblName, Partition newPart, EnvironmentContext environmentContext)` Updates the existing partition metadata with the new metadata.
`void`	`alterPartitions(String tblName, List<Partition> newParts, EnvironmentContext environmentContext)` Updates the existing table metadata with the new metadata.
`void`	`alterTable(String tblName, Table newTbl, boolean cascade, EnvironmentContext environmentContext)`
`void`	`alterTable(String tblName, Table newTbl, EnvironmentContext environmentContext)` Updates the existing table metadata with the new metadata.
`void`	`cacheFileMetadata(String dbName, String tableName, String partName, boolean allParts)`
`void`	`cancelDelegationToken(String tokenStrForm)`
`static void`	`clearDestForSubDirSrc(HiveConf conf, org.apache.hadoop.fs.Path dest, org.apache.hadoop.fs.Path src, boolean isSrcLocal)`
`void`	`clearFileMetadata(List<Long> fileIds)`
`void`	`clearMetaCallTiming()`
`static void`	`closeCurrent()`
`void`	`compact(String dbname, String tableName, String partName, String compactType, Map<String,String> tblproperties)` Deprecated. use `compact2(String, String, String, String, Map)`
`CompactionResponse`	`compact2(String dbname, String tableName, String partName, String compactType, Map<String,String> tblproperties)` Enqueue a compaction request.
`protected static void`	`copyFiles(HiveConf conf, org.apache.hadoop.fs.Path srcf, org.apache.hadoop.fs.Path destf, org.apache.hadoop.fs.FileSystem fs, boolean isSrcLocal, boolean isAcid, List<org.apache.hadoop.fs.Path> newFiles)` Copy files.
`void`	`createDatabase(Database db)` Create a Database.
`void`	`createDatabase(Database db, boolean ifNotExist)` Create a database
`void`	`createFunction(Function func)`
`void`	`createIndex(String tableName, String indexName, String indexHandlerClass, List<String> indexedCols, String indexTblName, boolean deferredRebuild, String inputFormat, String outputFormat, String serde, String storageHandler, String location, Map<String,String> idxProps, Map<String,String> tblProps, Map<String,String> serdeProps, String collItemDelim, String fieldDelim, String fieldEscape, String lineDelim, String mapKeyDelim, String indexComment)`
`Partition`	`createPartition(Table tbl, Map<String,String> partSpec)` Creates a partition.
`List<Partition>`	`createPartitions(AddPartitionDesc addPartitionDesc)`
`void`	`createRole(String roleName, String ownerName)`
`void`	`createTable(String tableName, List<String> columns, List<String> partCols, Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat, Class<?> fileOutputFormat)` Creates a table metadata and the directory for the table data
`void`	`createTable(String tableName, List<String> columns, List<String> partCols, Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat, Class<?> fileOutputFormat, int bucketCount, List<String> bucketCols)` Creates a table metadata and the directory for the table data
`void`	`createTable(String tableName, List<String> columns, List<String> partCols, Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat, Class<?> fileOutputFormat, int bucketCount, List<String> bucketCols, Map<String,String> parameters)` Create a table metadata and the directory for the table data
`void`	`createTable(Table tbl)` Creates the table with the give objects
`void`	`createTable(Table tbl, boolean ifNotExists)`
`void`	`createTable(Table tbl, boolean ifNotExists, List<SQLPrimaryKey> primaryKeys, List<SQLForeignKey> foreignKeys)` Creates the table with the given objects.
`boolean`	`databaseExists(String dbName)` Query metadata to see if a database with the given name already exists.
`boolean`	`deletePartitionColumnStatistics(String dbName, String tableName, String partName, String colName)`
`boolean`	`deleteTableColumnStatistics(String dbName, String tableName, String colName)`
`void`	`dropConstraint(String dbName, String tableName, String constraintName)`
`void`	`dropDatabase(String name)` Drop a database.
`void`	`dropDatabase(String name, boolean deleteData, boolean ignoreUnknownDb)` Drop a database
`void`	`dropDatabase(String name, boolean deleteData, boolean ignoreUnknownDb, boolean cascade)` Drop a database
`void`	`dropFunction(String dbName, String funcName)`
`boolean`	`dropIndex(String baseTableName, String index_name, boolean throwException, boolean deleteData)`
`boolean`	`dropIndex(String db_name, String tbl_name, String index_name, boolean throwException, boolean deleteData)`
`boolean`	`dropPartition(String tblName, List<String> part_vals, boolean deleteData)`
`boolean`	`dropPartition(String db_name, String tbl_name, List<String> part_vals, boolean deleteData)`
`boolean`	`dropPartition(String dbName, String tableName, List<String> partVals, PartitionDropOptions options)`
`List<Partition>`	`dropPartitions(String tblName, List<DropTableDesc.PartSpec> partSpecs, boolean deleteData, boolean ifExists)`
`List<Partition>`	`dropPartitions(String tblName, List<DropTableDesc.PartSpec> partSpecs, PartitionDropOptions dropOptions)`
`List<Partition>`	`dropPartitions(String dbName, String tblName, List<DropTableDesc.PartSpec> partSpecs, boolean deleteData, boolean ifExists)`
`List<Partition>`	`dropPartitions(String dbName, String tblName, List<DropTableDesc.PartSpec> partSpecs, PartitionDropOptions dropOptions)`
`void`	`dropRole(String roleName)`
`void`	`dropTable(String tableName)` Drops table along with the data in it.
`void`	`dropTable(String tableName, boolean ifPurge)` Drops table along with the data in it.
`void`	`dropTable(String dbName, String tableName)` Drops table along with the data in it.
`void`	`dropTable(String dbName, String tableName, boolean deleteData, boolean ignoreUnknownTab)` Drops the table.
`void`	`dropTable(String dbName, String tableName, boolean deleteData, boolean ignoreUnknownTab, boolean ifPurge)` Drops the table.
`com.google.common.collect.ImmutableMap<String,Long>`	`dumpAndClearMetaCallTiming(String phase)`
`List<Partition>`	`exchangeTablePartitions(Map<String,String> partitionSpecs, String sourceDb, String sourceTable, String destDb, String destinationTableName)`
`PrincipalPrivilegeSet`	`get_privilege_set(HiveObjectType objectType, String db_name, String table_name, List<String> part_values, String column_name, String user_name, List<String> group_names)`
`static Hive`	`get()`
`static Hive`	`get(boolean doRegisterAllFns)`
`static Hive`	`get(org.apache.hadoop.conf.Configuration c, Class<?> clazz)`
`static Hive`	`get(HiveConf c)` Gets hive object for the current thread.
`static Hive`	`get(HiveConf c, boolean needsRefresh)` get a connection to metastore.
`AggrStats`	`getAggrColStatsFor(String dbName, String tblName, List<String> colNames, List<String> partName)`
`List<String>`	`getAllDatabases()` Get all existing database names.
`List<Function>`	`getAllFunctions()`
`Set<Partition>`	`getAllPartitionsOf(Table tbl)` Get all the partitions; unlike `getPartitions(Table)`, does not include auth.
`List<String>`	`getAllRoleNames()` Get all existing role names.
`List<Table>`	`getAllTableObjects(String dbName)` Get all tables for the specified database.
`List<String>`	`getAllTables()` Get all table names for the current database.
`List<String>`	`getAllTables(String dbName)` Get all table names for the specified database.
`HiveConf`	`getConf()`
`Database`	`getDatabase(String dbName)` Get the database by name.
`Database`	`getDatabaseCurrent()` Get the Database object for current database
`List<String>`	`getDatabasesByPattern(String databasePattern)` Get all existing databases that match the given pattern.
`String`	`getDelegationToken(String owner, String renewer)`
`static List<FieldSchema>`	`getFieldsFromDeserializer(String name, Deserializer serde)`
`static List<FieldSchema>`	`getFieldsFromDeserializerForMsStorage(Table tbl, Deserializer deserializer)`
`Iterable<Map.Entry<Long,ByteBuffer>>`	`getFileMetadata(List<Long> fileIds)`
`Iterable<Map.Entry<Long,MetadataPpdResult>>`	`getFileMetadataByExpr(List<Long> fileIds, ByteBuffer sarg, boolean doGetFooters)`
`ForeignKeyInfo`	`getForeignKeys(String dbName, String tblName)` Get all foreign keys associated with the table.
`Function`	`getFunction(String dbName, String funcName)`
`List<String>`	`getFunctions(String dbName, String pattern)`
`Index`	`getIndex(String baseTableName, String indexName)`
`Index`	`getIndex(String dbName, String baseTableName, String indexName)`
`List<Index>`	`getIndexes(String dbName, String tblName, short max)`
`String`	`getMetaConf(String propName)`
`IMetaStoreClient`	`getMSC()`
`IMetaStoreClient`	`getMSC(boolean allowEmbedded, boolean forceCreate)`
`int`	`getNumPartitionsByFilter(Table tbl, String filter)` Get a number of Partitions by filter.
`Partition`	`getPartition(Table tbl, Map<String,String> partSpec, boolean forceCreate)`
`Partition`	`getPartition(Table tbl, Map<String,String> partSpec, boolean forceCreate, String partPath, boolean inheritTableSpecs)` Returns partition metadata
`Partition`	`getPartition(Table tbl, Map<String,String> partSpec, boolean forceCreate, String partPath, boolean inheritTableSpecs, List<org.apache.hadoop.fs.Path> newFiles)` Returns partition metadata
`Map<String,List<ColumnStatisticsObj>>`	`getPartitionColumnStatistics(String dbName, String tableName, List<String> partNames, List<String> colNames)`
`List<String>`	`getPartitionNames(String tblName, short max)`
`List<String>`	`getPartitionNames(String dbName, String tblName, Map<String,String> partSpec, short max)`
`List<String>`	`getPartitionNames(String dbName, String tblName, short max)`
`List<Partition>`	`getPartitions(Table tbl)` get all the partitions that the table has
`List<Partition>`	`getPartitions(Table tbl, Map<String,String> partialPartSpec)` get all the partitions of the table that matches the given partial specification.
`List<Partition>`	`getPartitions(Table tbl, Map<String,String> partialPartSpec, short limit)` get all the partitions of the table that matches the given partial specification.
`boolean`	`getPartitionsByExpr(Table tbl, ExprNodeGenericFuncDesc expr, HiveConf conf, List<Partition> result)` Get a list of Partitions by expr.
`List<Partition>`	`getPartitionsByFilter(Table tbl, String filter)` Get a list of Partitions by filter.
`List<Partition>`	`getPartitionsByNames(Table tbl, List<String> partNames)` Get all partitions of the table that matches the list of given partition names.
`List<Partition>`	`getPartitionsByNames(Table tbl, Map<String,String> partialPartSpec)` get all the partitions of the table that matches the given partial specification.
`PrimaryKeyInfo`	`getPrimaryKeys(String dbName, String tblName)` Get all primary key columns associated with the table.
`List<org.apache.calcite.plan.RelOptMaterialization>`	`getRewritingMaterializedViews()` Get the materialized views that have been enabled for rewriting from the metastore.
`List<RolePrincipalGrant>`	`getRoleGrantInfoForPrincipal(String principalName, PrincipalType principalType)`
`SynchronizedMetaStoreClient`	`getSychronizedMSC()`
`Table`	`getTable(String tableName)` Returns metadata for the table named tableName
`Table`	`getTable(String tableName, boolean throwException)` Returns metadata for the table named tableName
`Table`	`getTable(String dbName, String tableName)` Returns metadata of the table
`Table`	`getTable(String dbName, String tableName, boolean throwException)` Returns metadata of the table
`List<ColumnStatisticsObj>`	`getTableColumnStatistics(String dbName, String tableName, List<String> colNames)`
`List<String>`	`getTablesByPattern(String tablePattern)` Returns all existing tables from default database which match the given pattern.
`List<String>`	`getTablesByPattern(String dbName, String tablePattern)` Returns all existing tables from the specified database which match the given pattern.
`List<String>`	`getTablesByType(String dbName, String pattern, TableType type)` Returns all existing tables of a type (VIRTUAL_VIEW\|EXTERNAL_TABLE\|MANAGED_TABLE) from the specified database which match the given pattern.
`List<String>`	`getTablesForDb(String database, String tablePattern)` Returns all existing tables from the given database which match the given pattern.
`static Hive`	`getWithFastCheck(HiveConf c)` Same as `get(HiveConf)`, except that it checks only the object identity of existing MS client, assuming the relevant settings would be unchanged within the same conf object.
`static Hive`	`getWithFastCheck(HiveConf c, boolean doRegisterAllFns)` Same as `get(HiveConf)`, except that it checks only the object identity of existing MS client, assuming the relevant settings would be unchanged within the same conf object.
`static Hive`	`getWithoutRegisterFns(HiveConf c)` Same as `get(HiveConf)`, except that it does not register all functions.
`boolean`	`grantPrivileges(PrivilegeBag privileges)`
`boolean`	`grantRole(String roleName, String userName, PrincipalType principalType, String grantor, PrincipalType grantorType, boolean grantOption)`
`static boolean`	`isHadoop1()`
`List<Role>`	`listRoles(String userName, PrincipalType principalType)`
`Map<Map<String,String>,Partition>`	`loadDynamicPartitions(org.apache.hadoop.fs.Path loadPath, String tableName, Map<String,String> partSpec, boolean replace, int numDP, boolean listBucketingEnabled, boolean isAcid, long txnId, boolean hasFollowingStatsTask, AcidUtils.Operation operation)` Given a source directory name of the load path, load all dynamically generated partitions into the specified table and return a list of strings that represent the dynamic partition paths.
`void`	`loadPartition(org.apache.hadoop.fs.Path loadPath, String tableName, Map<String,String> partSpec, boolean replace, boolean inheritTableSpecs, boolean isSkewedStoreAsSubdir, boolean isSrcLocal, boolean isAcid, boolean hasFollowingStatsTask)`
`Partition`	`loadPartition(org.apache.hadoop.fs.Path loadPath, Table tbl, Map<String,String> partSpec, boolean replace, boolean inheritTableSpecs, boolean isSkewedStoreAsSubdir, boolean isSrcLocal, boolean isAcid, boolean hasFollowingStatsTask)` Load a directory into a Hive Table Partition - Alters existing content of the partition with the contents of loadPath.
`void`	`loadTable(org.apache.hadoop.fs.Path loadPath, String tableName, boolean replace, boolean isSrcLocal, boolean isSkewedStoreAsSubdir, boolean isAcid, boolean hasFollowingStatsTask)` Load a directory into a Hive Table.
`static boolean`	`moveFile(HiveConf conf, org.apache.hadoop.fs.Path srcf, org.apache.hadoop.fs.Path destf, boolean replace, boolean isSrcLocal)`
`protected static boolean`	`needToCopy(org.apache.hadoop.fs.Path srcf, org.apache.hadoop.fs.Path destf, org.apache.hadoop.fs.FileSystem srcFs, org.apache.hadoop.fs.FileSystem destFs)` If moving across different FileSystems or differnent encryption zone, need to do a File copy instead of rename.
`Table`	`newTable(String tableName)`
`void`	`putFileMetadata(List<Long> fileIds, List<ByteBuffer> metadata)`
`void`	`reloadFunctions()`
`void`	`renamePartition(Table tbl, Map<String,String> oldPartSpec, Partition newPart)` Rename a old partition to new partition
`protected void`	`replaceFiles(org.apache.hadoop.fs.Path tablePath, org.apache.hadoop.fs.Path srcf, org.apache.hadoop.fs.Path destf, org.apache.hadoop.fs.Path oldPath, HiveConf conf, boolean isSrcLocal, boolean purge)` Replaces files in the partition with new data set specified by srcf.
`boolean`	`revokePrivileges(PrivilegeBag privileges, boolean grantOption)`
`boolean`	`revokeRole(String roleName, String userName, PrincipalType principalType, boolean grantOption)`
`static void`	`set(Hive hive)`
`void`	`setMetaConf(String propName, String propValue)`
`boolean`	`setPartitionColumnStatistics(SetPartitionsStatsRequest request)`
`ShowCompactResponse`	`showCompactions()`
`List<HiveObjectPrivilege>`	`showPrivilegeGrant(HiveObjectType objectType, String principalName, PrincipalType principalType, String dbName, String tableName, List<String> partValues, String columnName)`
`GetOpenTxnsInfoResponse`	`showTransactions()`
`static boolean`	`trashFiles(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.FileStatus[] statuses, org.apache.hadoop.conf.Configuration conf, boolean purge)` Trashes or deletes all files under a directory.
`void`	`validatePartitionNameCharacters(List<String> partVals)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

reloadFunctions

public void reloadFunctions()
                     throws HiveException

Throws:: HiveException

get

public static Hive get(org.apache.hadoop.conf.Configuration c,
                       Class<?> clazz)
                throws HiveException

Throws:: HiveException

get
```
public static Hive get(HiveConf c)
                throws HiveException
```
Gets hive object for the current thread. If one is not initialized then a new one is created If the new configuration is different in metadata conf vars, or the owner will be different then a new one is created.

Parameters:

c - new Hive Configuration

Returns:

Hive object for current thread

Throws:

HiveException

getWithFastCheck
```
public static Hive getWithFastCheck(HiveConf c)
                             throws HiveException
```
Same as get(HiveConf), except that it checks only the object identity of existing MS client, assuming the relevant settings would be unchanged within the same conf object.

Throws:

HiveException

getWithFastCheck
```
public static Hive getWithFastCheck(HiveConf c,
                                    boolean doRegisterAllFns)
                             throws HiveException
```
Same as get(HiveConf), except that it checks only the object identity of existing MS client, assuming the relevant settings would be unchanged within the same conf object.

Throws:

HiveException

getWithoutRegisterFns

public static Hive getWithoutRegisterFns(HiveConf c)
                                  throws HiveException

Same as get(HiveConf), except that it does not register all functions.

Throws:: HiveException

get

public static Hive get()
                throws HiveException

Throws:: HiveException

get

public static Hive get(boolean doRegisterAllFns)
                throws HiveException

Throws:: HiveException

get
```
public static Hive get(HiveConf c,
                       boolean needsRefresh)
                throws HiveException
```
get a connection to metastore. see get(HiveConf) function for comments

Parameters:

c - new conf

needsRefresh - if true then creates a new one

Returns:

The connection to the metastore

Throws:

HiveException

set
```
public static void set(Hive hive)
```

closeCurrent
```
public static void closeCurrent()
```

createDatabase

public void createDatabase(Database db,
                           boolean ifNotExist)
                    throws AlreadyExistsException,
                           HiveException

Create a database

Parameters:: db -; ifNotExist - if true, will ignore AlreadyExistsException exception
Throws:: AlreadyExistsException; HiveException

createDatabase

public void createDatabase(Database db)
                    throws AlreadyExistsException,
                           HiveException

Create a Database. Raise an error if a database with the same name already exists.

Parameters:: db -
Throws:: AlreadyExistsException; HiveException

dropDatabase

public void dropDatabase(String name)
                  throws HiveException,
                         NoSuchObjectException

Drop a database.

Parameters:: name -
Throws:: NoSuchObjectException; HiveException
See Also:: HiveMetaStoreClient.dropDatabase(java.lang.String)

dropDatabase

public void dropDatabase(String name,
                         boolean deleteData,
                         boolean ignoreUnknownDb)
                  throws HiveException,
                         NoSuchObjectException

Drop a database

Parameters:: name -; deleteData -; ignoreUnknownDb - if true, will ignore NoSuchObjectException
Throws:: HiveException; NoSuchObjectException

dropDatabase

public void dropDatabase(String name,
                         boolean deleteData,
                         boolean ignoreUnknownDb,
                         boolean cascade)
                  throws HiveException,
                         NoSuchObjectException

Drop a database

Parameters:: name -; deleteData -; ignoreUnknownDb - if true, will ignore NoSuchObjectException; cascade - if true, delete all tables on the DB if exists. Otherwise, the query will fail if table still exists.
Throws:: HiveException; NoSuchObjectException

createTable
```
public void createTable(String tableName,
                        List<String> columns,
                        List<String> partCols,
                        Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat,
                        Class<?> fileOutputFormat)
                 throws HiveException
```
Creates a table metadata and the directory for the table data

Parameters:

tableName - name of the table

columns - list of fields of the table

partCols - partition keys of the table

fileInputFormat - Class of the input format of the table data file

fileOutputFormat - Class of the output format of the table data file

Throws:

HiveException - thrown if the args are invalid or if the metadata or the data directory couldn't be created

createTable

public void createTable(String tableName,
                        List<String> columns,
                        List<String> partCols,
                        Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat,
                        Class<?> fileOutputFormat,
                        int bucketCount,
                        List<String> bucketCols)
                 throws HiveException

Creates a table metadata and the directory for the table data

Parameters:: tableName - name of the table; columns - list of fields of the table; partCols - partition keys of the table; fileInputFormat - Class of the input format of the table data file; fileOutputFormat - Class of the output format of the table data file; bucketCount - number of buckets that each partition (or the table itself) should be divided into
Throws:: HiveException - thrown if the args are invalid or if the metadata or the data directory couldn't be created

createTable

public void createTable(String tableName,
                        List<String> columns,
                        List<String> partCols,
                        Class<? extends org.apache.hadoop.mapred.InputFormat> fileInputFormat,
                        Class<?> fileOutputFormat,
                        int bucketCount,
                        List<String> bucketCols,
                        Map<String,String> parameters)
                 throws HiveException

Create a table metadata and the directory for the table data

Parameters:: tableName - table name; columns - list of fields of the table; partCols - partition keys of the table; fileInputFormat - Class of the input format of the table data file; fileOutputFormat - Class of the output format of the table data file; bucketCount - number of buckets that each partition (or the table itself) should be divided into; bucketCols - Bucket columns; parameters - Parameters for the table
Throws:: HiveException

alterTable

public void alterTable(String tblName,
                       Table newTbl,
                       EnvironmentContext environmentContext)
                throws InvalidOperationException,
                       HiveException

Updates the existing table metadata with the new metadata.

Parameters:: tblName - name of the existing table; newTbl - new name of the table. could be the old name
Throws:: InvalidOperationException - if the changes in metadata is not acceptable; org.apache.thrift.TException; HiveException

alterTable

public void alterTable(String tblName,
                       Table newTbl,
                       boolean cascade,
                       EnvironmentContext environmentContext)
                throws InvalidOperationException,
                       HiveException

Throws:: InvalidOperationException; HiveException

alterIndex

public void alterIndex(String baseTableName,
                       String indexName,
                       Index newIdx)
                throws InvalidOperationException,
                       HiveException

Throws:: InvalidOperationException; HiveException

alterIndex

public void alterIndex(String dbName,
                       String baseTblName,
                       String idxName,
                       Index newIdx)
                throws InvalidOperationException,
                       HiveException

Updates the existing index metadata with the new metadata.

Parameters:: idxName - name of the existing index; newIdx - new name of the index. could be the old name
Throws:: InvalidOperationException - if the changes in metadata is not acceptable; org.apache.thrift.TException; HiveException

alterPartition

public void alterPartition(String tblName,
                           Partition newPart,
                           EnvironmentContext environmentContext)
                    throws InvalidOperationException,
                           HiveException

Updates the existing partition metadata with the new metadata.

Parameters:: tblName - name of the existing table; newPart - new partition
Throws:: InvalidOperationException - if the changes in metadata is not acceptable; org.apache.thrift.TException; HiveException

alterPartition

public void alterPartition(String dbName,
                           String tblName,
                           Partition newPart,
                           EnvironmentContext environmentContext)
                    throws InvalidOperationException,
                           HiveException

Updates the existing partition metadata with the new metadata.

Parameters:: dbName - name of the exiting table's database; tblName - name of the existing table; newPart - new partition
Throws:: InvalidOperationException - if the changes in metadata is not acceptable; org.apache.thrift.TException; HiveException

alterPartitions

public void alterPartitions(String tblName,
                            List<Partition> newParts,
                            EnvironmentContext environmentContext)
                     throws InvalidOperationException,
                            HiveException

Updates the existing table metadata with the new metadata.

Parameters:: tblName - name of the existing table; newParts - new partitions
Throws:: InvalidOperationException - if the changes in metadata is not acceptable; org.apache.thrift.TException; HiveException

renamePartition
```
public void renamePartition(Table tbl,
                            Map<String,String> oldPartSpec,
                            Partition newPart)
                     throws HiveException
```
Rename a old partition to new partition

Parameters:

tbl - existing table

oldPartSpec - spec of old partition

newPart - new partition

Throws:

InvalidOperationException - if the changes in metadata is not acceptable

org.apache.thrift.TException

HiveException

alterDatabase

public void alterDatabase(String dbName,
                          Database db)
                   throws HiveException

Throws:: HiveException

createTable
```
public void createTable(Table tbl)
                 throws HiveException
```
Creates the table with the give objects

Parameters:

tbl - a table object

Throws:

HiveException

createTable
```
public void createTable(Table tbl,
                        boolean ifNotExists,
                        List<SQLPrimaryKey> primaryKeys,
                        List<SQLForeignKey> foreignKeys)
                 throws HiveException
```
Creates the table with the given objects. It takes additional arguments for primary keys and foreign keys associated with the table.

Parameters:

tbl - a table object

ifNotExists - if true, ignore AlreadyExistsException

primaryKeys - primary key columns associated with the table

foreignKeys - foreign key columns associated with the table

Throws:

HiveException

createTable

public void createTable(Table tbl,
                        boolean ifNotExists)
                 throws HiveException

Throws:: HiveException

getFieldsFromDeserializerForMsStorage

public static List<FieldSchema> getFieldsFromDeserializerForMsStorage(Table tbl,
                                                                      Deserializer deserializer)
                                                               throws SerDeException,
                                                                      MetaException

Throws:: SerDeException; MetaException

createIndex

public void createIndex(String tableName,
                        String indexName,
                        String indexHandlerClass,
                        List<String> indexedCols,
                        String indexTblName,
                        boolean deferredRebuild,
                        String inputFormat,
                        String outputFormat,
                        String serde,
                        String storageHandler,
                        String location,
                        Map<String,String> idxProps,
                        Map<String,String> tblProps,
                        Map<String,String> serdeProps,
                        String collItemDelim,
                        String fieldDelim,
                        String fieldEscape,
                        String lineDelim,
                        String mapKeyDelim,
                        String indexComment)
                 throws HiveException

Parameters:: tableName - table name; indexName - index name; indexHandlerClass - index handler class; indexedCols - index columns; indexTblName - index table's name; deferredRebuild - referred build index table's data; inputFormat - input format; outputFormat - output format; serde -; storageHandler - index table's storage handler; location - location; idxProps - idx; serdeProps - serde properties; collItemDelim -; fieldDelim -; fieldEscape -; lineDelim -; mapKeyDelim -
Throws:: HiveException

getIndex

public Index getIndex(String baseTableName,
                      String indexName)
               throws HiveException

Throws:: HiveException

getIndex

public Index getIndex(String dbName,
                      String baseTableName,
                      String indexName)
               throws HiveException

Throws:: HiveException

dropIndex

public boolean dropIndex(String baseTableName,
                         String index_name,
                         boolean throwException,
                         boolean deleteData)
                  throws HiveException

Throws:: HiveException

dropIndex

public boolean dropIndex(String db_name,
                         String tbl_name,
                         String index_name,
                         boolean throwException,
                         boolean deleteData)
                  throws HiveException

Throws:: HiveException

dropTable
```
public void dropTable(String tableName,
                      boolean ifPurge)
               throws HiveException
```
Drops table along with the data in it. If the table doesn't exist then it is a no-op. If ifPurge option is specified it is passed to the hdfs command that removes table data from warehouse to make it skip trash.

Parameters:

tableName - table to drop

ifPurge - completely purge the table (skipping trash) while removing data from warehouse

Throws:

HiveException - thrown if the drop fails

dropTable
```
public void dropTable(String tableName)
               throws HiveException
```
Drops table along with the data in it. If the table doesn't exist then it is a no-op

Parameters:

tableName - table to drop

Throws:

HiveException - thrown if the drop fails

dropTable
```
public void dropTable(String dbName,
                      String tableName)
               throws HiveException
```
Drops table along with the data in it. If the table doesn't exist then it is a no-op

Parameters:

dbName - database where the table lives

tableName - table to drop

Throws:

HiveException - thrown if the drop fails

dropTable

public void dropTable(String dbName,
                      String tableName,
                      boolean deleteData,
                      boolean ignoreUnknownTab)
               throws HiveException

Drops the table.

Parameters:: dbName -; tableName -; deleteData - deletes the underlying data along with metadata; ignoreUnknownTab - an exception is thrown if this is false and the table doesn't exist
Throws:: HiveException

dropTable
```
public void dropTable(String dbName,
                      String tableName,
                      boolean deleteData,
                      boolean ignoreUnknownTab,
                      boolean ifPurge)
               throws HiveException
```
Drops the table.

Parameters:

dbName -

tableName -

deleteData - deletes the underlying data along with metadata

ignoreUnknownTab - an exception is thrown if this is false and the table doesn't exist

ifPurge - completely purge the table skipping trash while removing data from warehouse

Throws:

HiveException

getConf
```
public HiveConf getConf()
```

getTable
```
public Table getTable(String tableName)
               throws HiveException
```
Returns metadata for the table named tableName

Parameters:

tableName - the name of the table

Returns:

the table metadata

Throws:

HiveException - if there's an internal error or if the table doesn't exist

getTable
```
public Table getTable(String tableName,
                      boolean throwException)
               throws HiveException
```
Returns metadata for the table named tableName

Parameters:

tableName - the name of the table

throwException - controls whether an exception is thrown or a returns a null

Returns:

the table metadata

Throws:

HiveException - if there's an internal error or if the table doesn't exist

getTable
```
public Table getTable(String dbName,
                      String tableName)
               throws HiveException
```
Returns metadata of the table

Parameters:

dbName - the name of the database

tableName - the name of the table

Returns:

the table

Throws:

HiveException - if there's an internal error or if the table doesn't exist

getTable
```
public Table getTable(String dbName,
                      String tableName,
                      boolean throwException)
               throws HiveException
```
Returns metadata of the table

Parameters:

dbName - the name of the database

tableName - the name of the table

throwException - controls whether an exception is thrown or a returns a null

Returns:

the table or if throwException is false a null value.

Throws:

HiveException

getAllTables
```
public List<String> getAllTables()
                          throws HiveException
```
Get all table names for the current database.

Returns:

List of table names

Throws:

HiveException

getAllTables
```
public List<String> getAllTables(String dbName)
                          throws HiveException
```
Get all table names for the specified database.

Parameters:

dbName -

Returns:

List of table names

Throws:

HiveException

getAllTableObjects
```
public List<Table> getAllTableObjects(String dbName)
                               throws HiveException
```
Get all tables for the specified database.

Parameters:

dbName -

Returns:

List of table names

Throws:

HiveException

getTablesByPattern
```
public List<String> getTablesByPattern(String tablePattern)
                                throws HiveException
```
Returns all existing tables from default database which match the given pattern. The matching occurs as per Java regular expressions

Parameters:

tablePattern - java re pattern

Returns:

list of table names

Throws:

HiveException

getTablesByPattern
```
public List<String> getTablesByPattern(String dbName,
                                       String tablePattern)
                                throws HiveException
```
Returns all existing tables from the specified database which match the given pattern. The matching occurs as per Java regular expressions.

Parameters:

dbName -

tablePattern -

Returns:

list of table names

Throws:

HiveException

getTablesForDb
```
public List<String> getTablesForDb(String database,
                                   String tablePattern)
                            throws HiveException
```
Returns all existing tables from the given database which match the given pattern. The matching occurs as per Java regular expressions

Parameters:

database - the database name

tablePattern - java re pattern

Returns:

list of table names

Throws:

HiveException

getTablesByType
```
public List<String> getTablesByType(String dbName,
                                    String pattern,
                                    TableType type)
                             throws HiveException
```
Returns all existing tables of a type (VIRTUAL_VIEW|EXTERNAL_TABLE|MANAGED_TABLE) from the specified database which match the given pattern. The matching occurs as per Java regular expressions.

Parameters:

dbName - Database name to find the tables in. if null, uses the current database in this session.

pattern - A pattern to match for the table names.If null, returns all names from this DB.

type - The type of tables to return. VIRTUAL_VIEWS for views. If null, returns all tables and views.

Returns:

list of table names that match the pattern.

Throws:

HiveException

getRewritingMaterializedViews
```
public List<org.apache.calcite.plan.RelOptMaterialization> getRewritingMaterializedViews()
                                                                                  throws HiveException
```
Get the materialized views that have been enabled for rewriting from the metastore. If the materialized view is in the cache, we do not need to parse it to generate a logical plan for the rewriting. Instead, we return the version present in the cache.

Returns:

the list of materialized views available for rewriting

Throws:

HiveException

getAllDatabases
```
public List<String> getAllDatabases()
                             throws HiveException
```
Get all existing database names.

Returns:

List of database names.

Throws:

HiveException

getDatabasesByPattern
```
public List<String> getDatabasesByPattern(String databasePattern)
                                   throws HiveException
```
Get all existing databases that match the given pattern. The matching occurs as per Java regular expressions

Parameters:

databasePattern - java re pattern

Returns:

list of database names

Throws:

HiveException

grantPrivileges

public boolean grantPrivileges(PrivilegeBag privileges)
                        throws HiveException

Throws:: HiveException

revokePrivileges

public boolean revokePrivileges(PrivilegeBag privileges,
                                boolean grantOption)
                         throws HiveException

Parameters:: privileges - a bag of privileges
Returns:: true on success
Throws:: HiveException

databaseExists
```
public boolean databaseExists(String dbName)
                       throws HiveException
```
Query metadata to see if a database with the given name already exists.

Parameters:

dbName -

Returns:

true if a database with the given name already exists, false if does not exist.

Throws:

HiveException

getDatabase
```
public Database getDatabase(String dbName)
                     throws HiveException
```
Get the database by name.

Parameters:

dbName - the name of the database.

Returns:

a Database object if this database exists, null otherwise.

Throws:

HiveException

getDatabaseCurrent
```
public Database getDatabaseCurrent()
                            throws HiveException
```
Get the Database object for current database

Returns:

a Database object if this database exists, null otherwise.

Throws:

HiveException

loadPartition

public void loadPartition(org.apache.hadoop.fs.Path loadPath,
                          String tableName,
                          Map<String,String> partSpec,
                          boolean replace,
                          boolean inheritTableSpecs,
                          boolean isSkewedStoreAsSubdir,
                          boolean isSrcLocal,
                          boolean isAcid,
                          boolean hasFollowingStatsTask)
                   throws HiveException

Throws:: HiveException

loadPartition
```
public Partition loadPartition(org.apache.hadoop.fs.Path loadPath,
                               Table tbl,
                               Map<String,String> partSpec,
                               boolean replace,
                               boolean inheritTableSpecs,
                               boolean isSkewedStoreAsSubdir,
                               boolean isSrcLocal,
                               boolean isAcid,
                               boolean hasFollowingStatsTask)
                        throws HiveException
```
Load a directory into a Hive Table Partition - Alters existing content of the partition with the contents of loadPath. - If the partition does not exist - one is created - files in loadPath are moved into Hive. But the directory itself is not removed.

Parameters:

loadPath - Directory containing files to load into Table

tbl - name of table to be loaded.

partSpec - defines which partition needs to be loaded

replace - if true - replace files in the partition, otherwise add files to the partition

inheritTableSpecs - if true, on [re]creating the partition, take the location/inputformat/outputformat/serde details from table spec

isSrcLocal - If the source directory is LOCAL

isAcid - true if this is an ACID operation

Throws:

HiveException

loadDynamicPartitions

public Map<Map<String,String>,Partition> loadDynamicPartitions(org.apache.hadoop.fs.Path loadPath,
                                                               String tableName,
                                                               Map<String,String> partSpec,
                                                               boolean replace,
                                                               int numDP,
                                                               boolean listBucketingEnabled,
                                                               boolean isAcid,
                                                               long txnId,
                                                               boolean hasFollowingStatsTask,
                                                               AcidUtils.Operation operation)
                                                        throws HiveException

Given a source directory name of the load path, load all dynamically generated partitions into the specified table and return a list of strings that represent the dynamic partition paths.

Parameters:: loadPath -; tableName -; partSpec -; replace -; numDP - number of dynamic partitions; listBucketingEnabled -; isAcid - true if this is an ACID operation; txnId - txnId, can be 0 unless isAcid == true
Returns:: partition map details (PartitionSpec and Partition)
Throws:: HiveException

loadTable
```
public void loadTable(org.apache.hadoop.fs.Path loadPath,
                      String tableName,
                      boolean replace,
                      boolean isSrcLocal,
                      boolean isSkewedStoreAsSubdir,
                      boolean isAcid,
                      boolean hasFollowingStatsTask)
               throws HiveException
```
Load a directory into a Hive Table. - Alters existing content of table with the contents of loadPath. - If table does not exist - an exception is thrown - files in loadPath are moved into Hive. But the directory itself is not removed.

Parameters:

loadPath - Directory containing files to load into Table

tableName - name of table to be loaded.

replace - if true - replace files in the table, otherwise add files to table

isSrcLocal - If the source directory is LOCAL

isSkewedStoreAsSubdir - if list bucketing enabled

hasFollowingStatsTask - if there is any following stats task

isAcid - true if this is an ACID based write

Throws:

HiveException

createPartition
```
public Partition createPartition(Table tbl,
                                 Map<String,String> partSpec)
                          throws HiveException
```
Creates a partition.

Parameters:

tbl - table for which partition needs to be created

partSpec - partition keys and their values

Returns:

created partition object

Throws:

HiveException - if table doesn't exist or partition already exists

createPartitions

public List<Partition> createPartitions(AddPartitionDesc addPartitionDesc)
                                 throws HiveException

Throws:: HiveException

getPartition

public Partition getPartition(Table tbl,
                              Map<String,String> partSpec,
                              boolean forceCreate)
                       throws HiveException

Throws:: HiveException

getPartition
```
public Partition getPartition(Table tbl,
                              Map<String,String> partSpec,
                              boolean forceCreate,
                              String partPath,
                              boolean inheritTableSpecs)
                       throws HiveException
```
Returns partition metadata

Parameters:

tbl - the partition's table

partSpec - partition keys and values

forceCreate - if this is true and partition doesn't exist then a partition is created

partPath - the path where the partition data is located

inheritTableSpecs - whether to copy over the table specs for if/of/serde

Returns:

result partition object or null if there is no partition

Throws:

HiveException

getPartition
```
public Partition getPartition(Table tbl,
                              Map<String,String> partSpec,
                              boolean forceCreate,
                              String partPath,
                              boolean inheritTableSpecs,
                              List<org.apache.hadoop.fs.Path> newFiles)
                       throws HiveException
```
Returns partition metadata

Parameters:

tbl - the partition's table

partSpec - partition keys and values

forceCreate - if this is true and partition doesn't exist then a partition is created

partPath - the path where the partition data is located

inheritTableSpecs - whether to copy over the table specs for if/of/serde

newFiles - An optional list of new files that were moved into this partition. If non-null these will be included in the DML event sent to the metastore.

Returns:

result partition object or null if there is no partition

Throws:

HiveException

dropPartition

public boolean dropPartition(String tblName,
                             List<String> part_vals,
                             boolean deleteData)
                      throws HiveException

Throws:: HiveException

dropPartition

public boolean dropPartition(String db_name,
                             String tbl_name,
                             List<String> part_vals,
                             boolean deleteData)
                      throws HiveException

Throws:: HiveException

dropPartition

public boolean dropPartition(String dbName,
                             String tableName,
                             List<String> partVals,
                             PartitionDropOptions options)
                      throws HiveException

Throws:: HiveException

dropPartitions

public List<Partition> dropPartitions(String tblName,
                                      List<DropTableDesc.PartSpec> partSpecs,
                                      boolean deleteData,
                                      boolean ifExists)
                               throws HiveException

Throws:: HiveException

dropPartitions

public List<Partition> dropPartitions(String dbName,
                                      String tblName,
                                      List<DropTableDesc.PartSpec> partSpecs,
                                      boolean deleteData,
                                      boolean ifExists)
                               throws HiveException

Throws:: HiveException

dropPartitions

public List<Partition> dropPartitions(String tblName,
                                      List<DropTableDesc.PartSpec> partSpecs,
                                      PartitionDropOptions dropOptions)
                               throws HiveException

Throws:: HiveException

dropPartitions

public List<Partition> dropPartitions(String dbName,
                                      String tblName,
                                      List<DropTableDesc.PartSpec> partSpecs,
                                      PartitionDropOptions dropOptions)
                               throws HiveException

Throws:: HiveException

getPartitionNames

public List<String> getPartitionNames(String tblName,
                                      short max)
                               throws HiveException

Throws:: HiveException

getPartitionNames

public List<String> getPartitionNames(String dbName,
                                      String tblName,
                                      short max)
                               throws HiveException

Throws:: HiveException

getPartitionNames

public List<String> getPartitionNames(String dbName,
                                      String tblName,
                                      Map<String,String> partSpec,
                                      short max)
                               throws HiveException

Throws:: HiveException

getPartitions
```
public List<Partition> getPartitions(Table tbl)
                              throws HiveException
```
get all the partitions that the table has

Parameters:

tbl - object for which partition is needed

Returns:

list of partition objects

Throws:

HiveException

getAllPartitionsOf
```
public Set<Partition> getAllPartitionsOf(Table tbl)
                                  throws HiveException
```
Get all the partitions; unlike getPartitions(Table), does not include auth.

Parameters:

tbl - table for which partitions are needed

Returns:

list of partition objects

Throws:

HiveException

getPartitions
```
public List<Partition> getPartitions(Table tbl,
                                     Map<String,String> partialPartSpec,
                                     short limit)
                              throws HiveException
```
get all the partitions of the table that matches the given partial specification. partition columns whose value is can be anything should be an empty string.

Parameters:

tbl - object for which partition is needed. Must be partitioned.

limit - number of partitions to return

Returns:

list of partition objects

Throws:

HiveException

getPartitions
```
public List<Partition> getPartitions(Table tbl,
                                     Map<String,String> partialPartSpec)
                              throws HiveException
```
get all the partitions of the table that matches the given partial specification. partition columns whose value is can be anything should be an empty string.

Parameters:

tbl - object for which partition is needed. Must be partitioned.

Returns:

list of partition objects

Throws:

HiveException

getPartitionsByNames
```
public List<Partition> getPartitionsByNames(Table tbl,
                                            Map<String,String> partialPartSpec)
                                     throws HiveException
```
get all the partitions of the table that matches the given partial specification. partition columns whose value is can be anything should be an empty string.

Parameters:

tbl - object for which partition is needed. Must be partitioned.

partialPartSpec - partial partition specification (some subpartitions can be empty).

Returns:

list of partition objects

Throws:

HiveException

getPartitionsByNames
```
public List<Partition> getPartitionsByNames(Table tbl,
                                            List<String> partNames)
                                     throws HiveException
```
Get all partitions of the table that matches the list of given partition names.

Parameters:

tbl - object for which partition is needed. Must be partitioned.

partNames - list of partition names

Returns:

list of partition objects

Throws:

HiveException

getPartitionsByFilter

public List<Partition> getPartitionsByFilter(Table tbl,
                                             String filter)
                                      throws HiveException,
                                             MetaException,
                                             NoSuchObjectException,
                                             org.apache.thrift.TException

Get a list of Partitions by filter.

Parameters:: tbl - The table containing the partitions.; filter - A string represent partition predicates.
Returns:: a list of partitions satisfying the partition predicates.
Throws:: HiveException; MetaException; NoSuchObjectException; org.apache.thrift.TException

getPartitionsByExpr

public boolean getPartitionsByExpr(Table tbl,
                                   ExprNodeGenericFuncDesc expr,
                                   HiveConf conf,
                                   List<Partition> result)
                            throws HiveException,
                                   org.apache.thrift.TException

Get a list of Partitions by expr.

Parameters:: tbl - The table containing the partitions.; expr - A serialized expression for partition predicates.; conf - Hive config.; result - the resulting list of partitions
Returns:: whether the resulting list contains partitions which may or may not match the expr
Throws:: HiveException; org.apache.thrift.TException

getNumPartitionsByFilter

public int getNumPartitionsByFilter(Table tbl,
                                    String filter)
                             throws HiveException,
                                    MetaException,
                                    NoSuchObjectException,
                                    org.apache.thrift.TException

Get a number of Partitions by filter.

Parameters:: tbl - The table containing the partitions.; filter - A string represent partition predicates.
Returns:: the number of partitions satisfying the partition predicates.
Throws:: HiveException; MetaException; NoSuchObjectException; org.apache.thrift.TException

validatePartitionNameCharacters

public void validatePartitionNameCharacters(List<String> partVals)
                                     throws HiveException

Throws:: HiveException

createRole

public void createRole(String roleName,
                       String ownerName)
                throws HiveException

Throws:: HiveException

dropRole

public void dropRole(String roleName)
              throws HiveException

Throws:: HiveException

getAllRoleNames

public List<String> getAllRoleNames()
                             throws HiveException

Get all existing role names.

Returns:: List of role names.
Throws:: HiveException

getRoleGrantInfoForPrincipal

public List<RolePrincipalGrant> getRoleGrantInfoForPrincipal(String principalName,
                                                             PrincipalType principalType)
                                                      throws HiveException

Throws:: HiveException

grantRole

public boolean grantRole(String roleName,
                         String userName,
                         PrincipalType principalType,
                         String grantor,
                         PrincipalType grantorType,
                         boolean grantOption)
                  throws HiveException

Throws:: HiveException

revokeRole

public boolean revokeRole(String roleName,
                          String userName,
                          PrincipalType principalType,
                          boolean grantOption)
                   throws HiveException

Throws:: HiveException

listRoles

public List<Role> listRoles(String userName,
                            PrincipalType principalType)
                     throws HiveException

Throws:: HiveException

get_privilege_set

public PrincipalPrivilegeSet get_privilege_set(HiveObjectType objectType,
                                               String db_name,
                                               String table_name,
                                               List<String> part_values,
                                               String column_name,
                                               String user_name,
                                               List<String> group_names)
                                        throws HiveException

Parameters:: objectType - hive object type; db_name - database name; table_name - table name; part_values - partition values; column_name - column name; user_name - user name; group_names - group names
Returns:: the privilege set
Throws:: HiveException

showPrivilegeGrant

public List<HiveObjectPrivilege> showPrivilegeGrant(HiveObjectType objectType,
                                                    String principalName,
                                                    PrincipalType principalType,
                                                    String dbName,
                                                    String tableName,
                                                    List<String> partValues,
                                                    String columnName)
                                             throws HiveException

Parameters:: objectType - hive object type; principalName -; principalType -; dbName -; tableName -; partValues -; columnName -
Returns:: list of privileges
Throws:: HiveException

clearDestForSubDirSrc

public static void clearDestForSubDirSrc(HiveConf conf,
                                         org.apache.hadoop.fs.Path dest,
                                         org.apache.hadoop.fs.Path src,
                                         boolean isSrcLocal)
                                  throws IOException

Throws:: IOException

moveFile

public static boolean moveFile(HiveConf conf,
                               org.apache.hadoop.fs.Path srcf,
                               org.apache.hadoop.fs.Path destf,
                               boolean replace,
                               boolean isSrcLocal)
                        throws HiveException

Throws:: HiveException

needToCopy

protected static boolean needToCopy(org.apache.hadoop.fs.Path srcf,
                                    org.apache.hadoop.fs.Path destf,
                                    org.apache.hadoop.fs.FileSystem srcFs,
                                    org.apache.hadoop.fs.FileSystem destFs)
                             throws HiveException

If moving across different FileSystems or differnent encryption zone, need to do a File copy instead of rename. TODO- consider if need to do this for different file authority.

Throws:: HiveException

copyFiles

protected static void copyFiles(HiveConf conf,
                                org.apache.hadoop.fs.Path srcf,
                                org.apache.hadoop.fs.Path destf,
                                org.apache.hadoop.fs.FileSystem fs,
                                boolean isSrcLocal,
                                boolean isAcid,
                                List<org.apache.hadoop.fs.Path> newFiles)
                         throws HiveException

Copy files. This handles building the mapping for buckets and such between the source and destination

Parameters:: conf - Configuration object; srcf - source directory, if bucketed should contain bucket files; destf - directory to move files into; fs - Filesystem; isSrcLocal - true if source is on local file system; isAcid - true if this is an ACID based write; newFiles - if this is non-null, a list of files that were created as a result of this move will be returned.
Throws:: HiveException

replaceFiles
```
protected void replaceFiles(org.apache.hadoop.fs.Path tablePath,
                            org.apache.hadoop.fs.Path srcf,
                            org.apache.hadoop.fs.Path destf,
                            org.apache.hadoop.fs.Path oldPath,
                            HiveConf conf,
                            boolean isSrcLocal,
                            boolean purge)
                     throws HiveException
```
Replaces files in the partition with new data set specified by srcf. Works by renaming directory of srcf to the destination file. srcf, destf, and tmppath should resident in the same DFS, but the oldPath can be in a different DFS.

Parameters:

tablePath - path of the table. Used to identify permission inheritance.

srcf - Source directory to be renamed to tmppath. It should be a leaf directory where the final data files reside. However it could potentially contain subdirectories as well.

destf - The directory where the final data needs to go

oldPath - The directory where the old data location, need to be cleaned up. Most of time, will be the same as destf, unless its across FileSystem boundaries.

purge - When set to true files which needs to be deleted are not moved to Trash

isSrcLocal - If the source directory is LOCAL

Throws:

HiveException

trashFiles

public static boolean trashFiles(org.apache.hadoop.fs.FileSystem fs,
                                 org.apache.hadoop.fs.FileStatus[] statuses,
                                 org.apache.hadoop.conf.Configuration conf,
                                 boolean purge)
                          throws IOException

Trashes or deletes all files under a directory. Leaves the directory as is.

Parameters:: fs - FileSystem to use; statuses - fileStatuses of files to be deleted; conf - hive configuration
Returns:: true if deletion successful
Throws:: IOException

isHadoop1
```
public static boolean isHadoop1()
```

exchangeTablePartitions

public List<Partition> exchangeTablePartitions(Map<String,String> partitionSpecs,
                                               String sourceDb,
                                               String sourceTable,
                                               String destDb,
                                               String destinationTableName)
                                        throws HiveException

Throws:: HiveException

getSychronizedMSC

@InterfaceAudience.LimitedPrivate(value="Hive")
 @InterfaceStability.Unstable
public SynchronizedMetaStoreClient getSychronizedMSC()
                                                                                                                            throws MetaException

Returns:: synchronized metastore client
Throws:: MetaException

getMSC

@InterfaceAudience.LimitedPrivate(value="Hive")
 @InterfaceStability.Unstable
public IMetaStoreClient getMSC()
                                                                                                      throws MetaException

Returns:: the metastore client for the current thread
Throws:: MetaException

getMSC

@InterfaceAudience.LimitedPrivate(value="Hive")
 @InterfaceStability.Unstable
public IMetaStoreClient getMSC(boolean allowEmbedded,
                                                                                                             boolean forceCreate)
                                                                                                      throws MetaException

Returns:: the metastore client for the current thread
Throws:: MetaException

getFieldsFromDeserializer

public static List<FieldSchema> getFieldsFromDeserializer(String name,
                                                          Deserializer serde)
                                                   throws HiveException

Throws:: HiveException

getIndexes

public List<Index> getIndexes(String dbName,
                              String tblName,
                              short max)
                       throws HiveException

Throws:: HiveException

setPartitionColumnStatistics

public boolean setPartitionColumnStatistics(SetPartitionsStatsRequest request)
                                     throws HiveException

Throws:: HiveException

getTableColumnStatistics

public List<ColumnStatisticsObj> getTableColumnStatistics(String dbName,
                                                          String tableName,
                                                          List<String> colNames)
                                                   throws HiveException

Throws:: HiveException

getPartitionColumnStatistics

public Map<String,List<ColumnStatisticsObj>> getPartitionColumnStatistics(String dbName,
                                                                          String tableName,
                                                                          List<String> partNames,
                                                                          List<String> colNames)
                                                                   throws HiveException

Throws:: HiveException

getAggrColStatsFor

public AggrStats getAggrColStatsFor(String dbName,
                                    String tblName,
                                    List<String> colNames,
                                    List<String> partName)

deleteTableColumnStatistics

public boolean deleteTableColumnStatistics(String dbName,
                                           String tableName,
                                           String colName)
                                    throws HiveException

Throws:: HiveException

deletePartitionColumnStatistics

public boolean deletePartitionColumnStatistics(String dbName,
                                               String tableName,
                                               String partName,
                                               String colName)
                                        throws HiveException

Throws:: HiveException

newTable

public Table newTable(String tableName)
               throws HiveException

Throws:: HiveException

getDelegationToken

public String getDelegationToken(String owner,
                                 String renewer)
                          throws HiveException

Throws:: HiveException

cancelDelegationToken

public void cancelDelegationToken(String tokenStrForm)
                           throws HiveException

Throws:: HiveException

compact

public void compact(String dbname,
                    String tableName,
                    String partName,
                    String compactType,
                    Map<String,String> tblproperties)
             throws HiveException

Deprecated. use compact2(String, String, String, String, Map)

Throws:: HiveException

compact2
```
public CompactionResponse compact2(String dbname,
                                   String tableName,
                                   String partName,
                                   String compactType,
                                   Map<String,String> tblproperties)
                            throws HiveException
```
Enqueue a compaction request. Only 1 compaction for a given resource (db/table/partSpec) can be scheduled/running at any given time.

Parameters:

dbname - name of the database, if null default will be used.

tableName - name of the table, cannot be null

partName - name of the partition, if null table will be compacted (valid only for non-partitioned tables).

compactType - major or minor

tblproperties - the list of tblproperties to overwrite for this compaction

Returns:

id of new request or id already existing request for specified resource

Throws:

HiveException

showCompactions

public ShowCompactResponse showCompactions()
                                    throws HiveException

Throws:: HiveException

showTransactions

public GetOpenTxnsInfoResponse showTransactions()
                                         throws HiveException

Throws:: HiveException

abortTransactions

public void abortTransactions(List<Long> txnids)
                       throws HiveException

Throws:: HiveException

createFunction

public void createFunction(Function func)
                    throws HiveException

Throws:: HiveException

alterFunction

public void alterFunction(String dbName,
                          String funcName,
                          Function newFunction)
                   throws HiveException

Throws:: HiveException

dropFunction

public void dropFunction(String dbName,
                         String funcName)
                  throws HiveException

Throws:: HiveException

getFunction

public Function getFunction(String dbName,
                            String funcName)
                     throws HiveException

Throws:: HiveException

getAllFunctions

public List<Function> getAllFunctions()
                               throws HiveException

Throws:: HiveException

getFunctions

public List<String> getFunctions(String dbName,
                                 String pattern)
                          throws HiveException

Throws:: HiveException

setMetaConf

public void setMetaConf(String propName,
                        String propValue)
                 throws HiveException

Throws:: HiveException

getMetaConf

public String getMetaConf(String propName)
                   throws HiveException

Throws:: HiveException

clearMetaCallTiming
```
public void clearMetaCallTiming()
```

dumpAndClearMetaCallTiming

public com.google.common.collect.ImmutableMap<String,Long> dumpAndClearMetaCallTiming(String phase)

getFileMetadata

public Iterable<Map.Entry<Long,ByteBuffer>> getFileMetadata(List<Long> fileIds)
                                                     throws HiveException

Throws:: HiveException

getFileMetadataByExpr

public Iterable<Map.Entry<Long,MetadataPpdResult>> getFileMetadataByExpr(List<Long> fileIds,
                                                                         ByteBuffer sarg,
                                                                         boolean doGetFooters)
                                                                  throws HiveException

Throws:: HiveException

clearFileMetadata

public void clearFileMetadata(List<Long> fileIds)
                       throws HiveException

Throws:: HiveException

putFileMetadata

public void putFileMetadata(List<Long> fileIds,
                            List<ByteBuffer> metadata)
                     throws HiveException

Throws:: HiveException

cacheFileMetadata

public void cacheFileMetadata(String dbName,
                              String tableName,
                              String partName,
                              boolean allParts)
                       throws HiveException

Throws:: HiveException

dropConstraint

public void dropConstraint(String dbName,
                           String tableName,
                           String constraintName)
                    throws HiveException,
                           NoSuchObjectException

Throws:: HiveException; NoSuchObjectException

getPrimaryKeys

public PrimaryKeyInfo getPrimaryKeys(String dbName,
                                     String tblName)
                              throws HiveException

Get all primary key columns associated with the table.

Parameters:: dbName - Database Name; tblName - Table Name
Returns:: Primary Key associated with the table.
Throws:: HiveException

getForeignKeys

public ForeignKeyInfo getForeignKeys(String dbName,
                                     String tblName)
                              throws HiveException

Get all foreign keys associated with the table.

Parameters:: dbName - Database Name; tblName - Table Name
Returns:: Foreign keys associated with the table.
Throws:: HiveException

addPrimaryKey

public void addPrimaryKey(List<SQLPrimaryKey> primaryKeyCols)
                   throws HiveException,
                          NoSuchObjectException

Throws:: HiveException; NoSuchObjectException

addForeignKey

public void addForeignKey(List<SQLForeignKey> foreignKeyCols)
                   throws HiveException,
                          NoSuchObjectException

Throws:: HiveException; NoSuchObjectException

Class Hive

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reloadFunctions

get

get

getWithFastCheck

getWithFastCheck

getWithoutRegisterFns

get

get

get

set

closeCurrent

createDatabase

createDatabase

dropDatabase

dropDatabase

dropDatabase

createTable

createTable

createTable

alterTable

alterTable

alterIndex

alterIndex

alterPartition

alterPartition

alterPartitions

renamePartition

alterDatabase

createTable

createTable

createTable

getFieldsFromDeserializerForMsStorage

createIndex

getIndex

getIndex

dropIndex

dropIndex

dropTable

dropTable

dropTable

dropTable

dropTable

getConf

getTable

getTable

getTable

getTable

getAllTables

getAllTables

getAllTableObjects

getTablesByPattern

getTablesByPattern

getTablesForDb

getTablesByType

getRewritingMaterializedViews

getAllDatabases

getDatabasesByPattern

grantPrivileges

revokePrivileges

databaseExists

getDatabase

getDatabaseCurrent

loadPartition

loadPartition

loadDynamicPartitions

loadTable

createPartition

createPartitions

getPartition

getPartition

getPartition

dropPartition

dropPartition

dropPartition

dropPartitions