Page History

 package org.apache.hcatalog.api;

import java.util.List;

import org.apache.hcatalog.common.HCatException;
import org.apache.hcatalog.mapreduce.HCatDatabaseInfo;
import org.apache.hcatalog.mapreduce.HCatPartitionInfo;
import org.apache.hcatalog.mapreduce.HCatTableInfo;

/**
 * The Interface HCatClient containing APIs for HCatalog DDL commands.
 */
public interface HCatClient {

    /**
     * Gets the database like.
     *
     * @param regex The regular expression. Providing "*" would retrieve all the names
     *              of the databases.
     * @return The list of all the database names.
     * @throws HCatException
     */
    public List<String> getDatabaseLike(String regex) throws HCatException;

    /**
     * Gets the database.
     *
     * @param dbName The name of the database.
     * @return An instance of HCatDatabaseInfo.
     * @throws HCatException
     */
    public HCatDatabaseInfo getDatabase(String dbName) throws HCatException;

       /**
     * Creates the database.
     *
     *Get @paramall dbInfoexisting Andatabases instancethat of HCatCreateDBDesc.
     * @return true, if successful
     * @throws HCatException
     */
    public boolean createDatabase(HCatCreateDBDesc dbInfo)
            throws HCatException;

    /**
     * Deletes a database.
     *
     * @param dbName The name of the database to delete.
     * @param ifExists Hive returns an error if the database specified does not exist,
     *                 unless ifExists is set to true.
     * @param mode This is set to either "restrict" or "cascade". Restrict will
     *             remove the schema if all the tables are empty. Cascade removes
     *             everything including data and definitions.
     * @param userGroup The user group to use
     * @param permissions The permissions string to use. The format is "rwxrw-r-x".
     * @return true, if successful
    match the given
     * pattern. The matching occurs as per Java regular expressions
     *
     * @param databasePattern
     *          java re pattern
     * @return list of database names
     * @throws HCatException
     */
    public abstract List<String> listDatabaseNamesByPattern(String pattern) throws HCatException;

    /**
     * Gets the database.
     *
     * @param dbName The name of the database.
     * @return An instance of HCatDatabaseInfo.
     * @throws HCatException
     */
    public boolean deleteDatabase(String dbName, boolean ifExists, String mode,
            String userGroup, String permissions */
    public abstract HCatDatabase getDatabase(String dbName) throws HCatException;

       /**
         * GetsCreates the tablesdatabase.
 like a pattern specified.
     *
         * @param dbNamedbInfo TheAn nameinstance of the databaseHCatCreateDBDesc.
         * @param@throws regexHCatException
 The regular expression. Providing "*"/
 would retrieve all thepublic names
     *              of  the table.
     * @return A list of all table names matching the specified pattern.
     * @throws HCatException
     */
    public List<String> getTablesLike(String dbName, String regex)
            throws HCatException;

    /**
     * Gets the table.
     *
     *abstract void createDatabase(HCatCreateDBDesc dbInfo)
            throws HCatException;

    /**
     * Drops a database.
     *
     * @param dbName The name of the database to delete.
         * @param tableName The name ofifExists Hive returns an error if the table.
     * @return An instance of HCatTableInfo.
     * @throws HCatException
     */
    public HCatTableInfo getTable(String dbName, String tableName)
            throws HCatException;

    /**
     * Creates the table.
     *
     * @param createTableDesc An instance of HCatCreateTableDesc class.
     * @return true, if successful.
     * @throws HCatException the h cat exception
     */
    public boolean createTable(HCatCreateTableDesc createTableDesc)
            throws HCatException;

    /**
     * Creates the table like an existing table.
     *
     * @param dbName The name of the database.
     * @param existingTblName The name of the existing table.
     * @param newTableName The name of the new table.
     * @param ifExists the if exists
     * @param isExternal Set to "true", if table has be created at a different
     *                   location other than default.
     * @param location The location for the table.
     * @return true, if successful
     * @throws HCatException
     */
    public boolean createTableLike(String dbName, String existingTblName,
            String newTableName, boolean ifExists, boolean isExternal,
            String locationdatabase specified does not exist,
     *                 unless ifExists is set to true.
     * @param mode This is set to either "restrict" or "cascade". Restrict will
     *             remove the schema if all the tables are empty. Cascade removes
     *             everything including data and definitions.
     * @throws HCatException
     */
    public abstract void dropDatabase(String dbName, boolean ifExists, String mode) throws HCatException;

       /**
      * Delete a table.
     *
     * @param dbName The name of the database.
     * @param tableName The name of the table.
     * @param ifExists Hive returns an error if the database specified does not exist,
     *                 unless ifExists is set to true.
     * @param userGroup The user group to use.
     * @param permissions The permissions string to use. The format is "rwxrw-r-x".
     * @return true, if successful
     * @throws HCatException
     */
    public boolean deleteTable* Returns all existing tables from the specified database which match the given
     * pattern. The matching occurs as per Java regular expressions.
     * @param dbName
     * @param tablePattern
     * @return list of table names
     * @throws HCatException
     */
    public abstract List<String> listTableNamesByPattern(String dbName, String tableName,tablePattern)
            boolean ifExists, String userGroup, String permissions)
                      throws HCatException;

       /**
         * RenamesGets athe table.
         *
         * @param dbName The name of the database.
         * @param oldNametableName The name of the table.
 to  be renamed.
     * @param@return newName The new nameAn instance of the tableHCatTableInfo.
     * @param userGroup The user* group to use.
     * @param permissions The permissions string to use. The format is "rwxrw-r-x".
     * @return true, if successful
     * @throws HCatException
     */
    public boolean renameTable(String dbName, String oldName, String newName,
            String userGroup, String permissions) throws HCatException;

    /**
     * Gets all the partitions.
     *
     * @param dbName The name of the database.
     * @param tblName The name of the table.
     * @return A list of partition names.
     * @throws HCatException the h cat exception
     */
    public List<HCatPartitionInfo> getPartitions(String dbName, String tblName)
           @throws HCatException
     */
    public abstract HCatTable getTable(String dbName, String tableName)
            throws HCatException;

    /**
     * Creates the table.
     *
     * @param createTableDesc An instance of HCatCreateTableDesc class.
     * @throws HCatException the h cat exception
     */
    public abstract void createTable(HCatCreateTableDesc createTableDesc)
            throws HCatException;

       /**
         * GetsCreates the partition.
     table like an existing table.
     *
         * @param dbName The database namename of the database.
     * @param tableName The table name.
     * @param partitionNameexistingTblName The partition name, Commaof separatedthe list of col_name='value'.
     * @return An instance of HCatPartitionInfo.
     * @throws HCatException
     */
    public HCatPartitionInfo getPartition(String dbName, String tableName,
            String partitionName) throws HCatException;

    /**
     * Adds the partition.
     *
     * @param partInfo An instance of HCatAddPartitionDesc.
     * @return true, if successful
     * @throws HCatException the h cat exception
     */
    public boolean addPartition(HCatAddPartitionDesc partInfo) throws HCatException;

    /**
     * Deletes partition.
     *
     * @param dbName The database name.
     * @param tableName The table name.
     * @param partitionName The partition name, Comma separated list of col_name='value'.
     * @param ifExists Hive returns an error if the partition specified does not exist, unless ifExists is set to true.
     * @param userGroup The user group to use.
     * @param permissions The permissions string to use. The format is "rwxrw-r-x".
     * @return true, if successful
     * @throws HCatException
     */
    public boolean deletePartition(String dbName, String tableName,
            String partitionName, boolean ifExists, String userGroup,
            String permissions) throws HCatException;

    /**
     * List partitions by filter.
     *
     * @param dbName The database name.
     * @param tblName The table name.
     * @param filter The filter string,
     *    for example "part1 = \"p1_abc\" and part2 <= "\p2_test\"". Filtering can
     *    be done only on string partition keys.
     * @return list of partitions
     * @throws HCatException the h cat exception
     */
    public List<HCatPartitionInfo> listPartitionsByFilterexisting table.
     * @param newTableName The name of the new table.
     * @param ifNotExists If true, then error related to already table existing is skipped.
     * @param isExternal Set to "true", if table has be created at a different
     *                   location other than default.
     * @param location The location for the table.
     * @throws HCatException
     */
    public abstract void createTableLike(String dbName, String existingTblName,
            String newTableName, boolean ifNotExists, boolean isExternal,
            String location) throws HCatException;

    /**
     * Drop table.
     *
     * @param dbName The name of the database.
     * @param tableName The name of the table.
     * @param ifExists Hive returns an error if the database specified does not exist,
     *                 unless ifExists is set to true.
     * @throws HCatException
     */
    public abstract void dropTable(String dbName, String tblNametableName,
              String filter) throws HCatException;

}

public interface CommandProcessor {
  public voidboolean init()ifExists) throws HCatException;

  public CommandProcessorResponse run(String command) throws CommandNeedRetryException;
}

/**
 * The Class HCatCommandDesc contains methods which help in validating,
 * building command descriptors and queries.
 */
public abstract class HCatCommandDesc{

    public abstract void validateCommandDesc() throws HCatException;
    abstract String buildQuery() throws HCatException;
    abstract boolean isValidationComplete();

}

public class HCatCreateDBDesc extends HCatCommandDesc {

    private String databaseName;
    private String locationUri;
    private String comment;
    private Map<String, String> dbProperties;

    /**  /**
     * Renames a table.
     *
     * @param dbName The name of the database.
     * @param oldName The name of the table to be renamed.
     * @param newName The new name of the table.
     * @throws HCatException
     */
    public abstract void renameTable(String dbName, String oldName, String newName) throws HCatException;

    /**
     * Gets all the partitions.
     *
     * @param dbName The name of the database.
     * Gets @param tblName The name of the database propertiestable.
     * @return A list of partition names.
     * @return@throws HCatException the databaseh cat propertiesexception
     */
    Map<String, String> getDatabaseProperties() {public abstract List<HCatPartition> getPartitions(String dbName, String tblName)
        return this.dbProperties;
   throws }HCatException;

    /**
     * SetsGets the database propertiespartition.
     *
     * @param dbPropsdbName theThe dbdatabase propsname.
     */
 @param tableName The publictable void setDatabaseProperties(Map<String, String> dbProps) {
        this.dbProperties = dbProps;
    }

    /**name.
     * @param partitionName The partition name, Comma separated list of col_name='value'.
     * @return An instance of HCatPartitionInfo.
     * Gets the name.@throws HCatException
     */
    public *abstract @returnHCatPartition the name
     */getPartition(String dbName, String tableName,
    String getName() {
      String partitionName) returnthrows this.databaseNameHCatException;
    }

    /**
     * SetsAdds the namepartition.
     *
     * @param databaseNamepartInfo An theinstance newof nameHCatAddPartitionDesc.
     */
 @throws HCatException the publich void setName(String databaseName) {
cat exception
     */
    public this.databaseNameabstract = databaseName;
    }void addPartition(HCatAddPartitionDesc partInfo) throws HCatException;

    /**
     * GetsDrops the commentpartition.
     *
     * @param dbName @returnThe thedatabase commentname.
     */
 @param tableName The String getComment() {table name.
     * @param partitionName return this.comment;
    }

    /**The partition name, Comma separated list of col_name='value'.
     * Sets@param ifExists theHive comment.
returns an error if the *
partition specified does not exist, *unless @paramifExists commentis theset newto commenttrue.
     * @throws HCatException
     */
    public abstract void setCommentdropPartition(String dbName, comment)String {tableName,
          this.comment = comment;
String partitionName, boolean  }ifExists) throws HCatException;

    /**
     * List Getspartitions theby locationfilter.
     *
     * @return the location@param dbName The database name.
     */
 @param tblName The String getLocation() {table name.
     * @param filter return this.locationUri;The filter string,
    }

 *    /**
for example "part1 =  * Sets the location.\"p1_abc\" and part2 <= "\p2_test\"". Filtering can
     *
    be *done @paramonly locationon thestring newpartition locationkeys.
     */
 @return list of publicpartitions
 void setLocation(String location) {
        this.locationUri = location;
    }

    /* @return   * @throws HCatException the h cat exception
     */
    public abstract List<HCatPartition> listPartitionsByFilter(String dbName, String tblName,
    /* @throws HCatException
     * @see org.apache.hcatalog.api.HCatCommandDescBuilder#buildCommandDesc()
String filter) throws HCatException;

     /**/
    @Override
 * Mark  public void validateCommandDesc()partition for event.
     *
     * @param dbName The database name.
  throws   HCatException* {

@param tblName The table }name.

     /* @param desc partKVs the part k vs
    /* @return
 * @param eventType the event type
     /* @throws HCatException the h cat exception
     */
  @see org.apache.hcatalog.api.HCatCommandDescBuilder#buildQuery(java.lang.Class)
     */
    @Override public abstract void markPartitionForEvent(String dbName, String tblName,
    String buildQuery() throws HCatException {
    Map<String, String> partKVs, PartitionEventType //eventType)
 TODO Auto-generated method stub
        returnthrows nullHCatException;
    }

    /* @return*
     * @see org.apache.hcatalog.api.HCatCommandDesc#isValidationComplete()Checks if is partition marked for event.
     */
    @Override * @param dbName the db name
    boolean isValidationComplete() { * @param tblName the tbl name
     * @param partKVs //the TODOpart Auto-generated method stub
k vs
     * @param eventType the returnevent false;type
    }

}

public class HCatCreateTableDesc extends HCatCommandDesc{

    private String tableName; * @return true, if is partition marked for event
    private boolean* isExternal;
@throws HCatException the h private ArrayList<HCatFieldSchema> cols;cat exception
    private ArrayList<HCatFieldSchema> partCols; */
    privatepublic ArrayList<String>abstract bucketCols;
    private ArrayList<Order> sortCols;boolean isPartitionMarkedForEvent(String dbName, String tblName,
    private int numBuckets;
    private String dbName;
Map<String, String> partKVs, PartitionEventType privateeventType)
 String comment;
    private String fileFormat;
    private Stringthrows locationHCatException;

    private/**
 String storageHandler;
   * privateGets Map<String,the String>delegation tblProps;token.
     private*
 boolean ifNotExists;

   * ArrayList<HCatFieldSchema> getColsString() {@param owner the owner
     * return this.getCols();
    }

@param renewerKerberosPrincipalName the renewer kerberos principal name
     boolean* getIfNotExists() {
  @return the delegation token
     * return this.ifNotExists;
    }
@throws HCatException the h cat exception
    / **/
    public abstract *String Sets the if not exists.getDelegationToken(String owner, String renewerKerberosPrincipalName) throws
     *  If true, the user will not receive an error if the table already exists. HCatException;

    /**
     * Renew delegation token.
     *
     * @param ifNotExiststokenStrForm the newtoken ifstr not existsform
     */ @return the long
    public void* setIfNotExists(boolean ifNotExists) {
   @throws HCatException the h cat exception
   this.ifNotExists = ifNotExists;*/
    }

public abstract long renewDelegationToken(String getTableName(tokenStrForm) {throws HCatException;

    /**
     * returnCancel delegation thistoken.tableName;
     }*

     String getDatabaseName(){
     * @param tokenStrForm the token str form
   return this.dbName;
  * @throws HCatException the h cat exception
     */
     }public abstract void cancelDelegationToken(String tokenStrForm) throws HCatException;

    /**
     * SetsClose the databasehcatalog nameclient.
     *
     * @param@throws dbNameHCatException the newh databasecat nameexception
     */
    public abstract void setDatabaseNameclose(String dbName){
        this.dbName = dbName;
    }

    /**
     * Sets the table name.
     *
     * @param tableName the new table name
     */
    public void setTableName(String tableName) {
      this.tableName = tableName;
    }

    ArrayList<HCatFieldSchema> getCols() {
       // ArrayList<FieldSchema> cols = this.tableDesc.getCols();
        return null;
    }

    /**
     * Sets the table columns.
     *
     * @param cols List of columns.
     */
    public void setCols(ArrayList<HCatFieldSchema> cols) {
        //convert and set.
      this.cols = null;
    }

    ArrayList<HCatFieldSchema> getPartCols() {
        return null;
    }

    /**
     * Sets the part cols.
     *
     * @param partCols List of partition columns.
     */
    public void setPartCols(ArrayList<HCatFieldSchema> partCols) {
      //this.partCols = partCols;
    }

    ArrayList<String> getBucketCols() {
        return this.bucketCols;
    }

    /**
     * Sets the bucket cols.
     *
     * @param bucketCols The list of columns to be used for clustering.
     */
    public void setBucketCols(ArrayList<String> bucketCols) {
      this.bucketCols = bucketCols;
    }

    int getNumBuckets() {
        return this.numBuckets;
    }

    /**
     * Sets the num buckets.
     *
     * @param numBuckets The number of buckets.
     */
    public void setNumBuckets(int numBuckets) {
      this.numBuckets = numBuckets;
    }

    String getComment() {
        return this.comment;
    }

    /**
     * Sets the comment.
     *
     * @param comment The comment for the table.
     */
    public void setComment(String comment) {
      this.comment = comment;
    }


    String getStorageHandler() {
        return this.storageHandler;
    }

    /**
     * Sets the storage handler.
     *
     * @param storageHandler the new storage handler
     */
    public void setStorageHandler(String storageHandler) {
      this.storageHandler = storageHandler;
    }

    String getLocation() {
        return this.location;
    }

    /**
     * Sets the location.
     *
     * @param location the new location
     */
    public void setLocation(String location) {
      this.location = location;
    }

    boolean getExternal() {
        return this.isExternal;
    }

    /**
     * Sets the external.
     *
     * @param isExternal True/False, indicating if the table is an external table.
     */
    public void setExternal(boolean isExternal) {
      this.isExternal = isExternal;
    }

    ArrayList<Order> getSortCols() {
        return this.sortCols;
    }

    /**
     * Sets the sort cols.
     *
     * @param sortCols the sortCols to set
     */
    public void setSortCols(ArrayList<Order> sortCols) {
      this.sortCols = sortCols;
    }

    /**
     * @return the table properties
     */
    Map<String, String> getTblProps() {
        return this.tblProps;
    }

    /**
     * @param tblProps
     *          the table properties to set
     */
    public void setTblProps(Map<String, String> tblProps) {
      this.tblProps = tblProps;
    }

    /**
     * Sets the file format.
     *
     * @param format the new file format
     */
    public void setFileFormat(String format){
        this.fileFormat = format;
    }

    String getFileFormat(){
        return this.fileFormat;
    }

    /* @return
    /* @throws HCatException
     * @see org.apache.hcatalog.api.HCatCommandDescBuilder#buildCommandDesc()
     */
    @Override
    public void validateCommandDesc() throws HCatException {
        // TODO Auto-generated method stub
    }


    /* @param desc
    /* @return
    /* @throws HCatException
     * @see org.apache.hcatalog.api.HCatCommandDescBuilder#buildQuery(org.apache.hcatalog.api.HCatCommandDescBuilder)
     */
    @Override
    String buildQuery() throws HCatException {
        // TODO Auto-generated method stub
        return null;
    }


    /* @return
     * @see org.apache.hcatalog.api.HCatCommandDesc#isValidationComplete()
     */
    @Override
    boolean isValidationComplete() {
        // TODO Auto-generated method stub
        return false;
    }

public class HCatAddPartitionDesc extends HCatCommandDesc {

    //private AddPartitionDesc addPartDesc;
    private String dbName;
    private String tableName;
    private String location;
    private LinkedHashMap<String,String> partSpec;

    /**
     * @return database name
     */
     String getDbName() {
         return this.dbName;
    }

    /**
     * Sets the db name.
     *
     * @param dbName database name
     */
    public void setDbName(String dbName) {
      this.dbName = dbName;
    }

    /**
     * @return the table we're going to add the partitions to.
     */
     String getTableName() {
      return this.tableName;
    }

    /**
     * Sets the table name.
     *
     * @param tableName the table we're going to add the partitions to.
     */
    public void setTableName(String tableName) {
      this.tableName = tableName;
    }

    String getLocation() {
      return this.location;
    }

    /**
     * Sets the location.
     *
     * @param location The location of partition in relation to table
     */
    public void setLocation(String location) {
      this.location = location;
    }

    /**
     * @return partition specification.
     */
     LinkedHashMap<String, String> getPartSpec() {
         return this.partSpec;
    }

    /**
     * Adds the partition name and value.
     *
     * @param colName The column name.
     * @param value The value.
     */
    public void addPartSpec(String colName, String value) {
      this.partSpec.put(colName, value);
    }

    @Override
    public void validateCommandDesc()
            throws HCatException {

    }

    /* @return
    /* @throws HCatException
     * @see org.apache.hcatalog.api.HCatCommandDesc#buildQuery()
     */
    @Override
    String buildQuery() throws HCatException {
        // TODO Auto-generated method stub
        return null;
    }

    /* @return
     * @see org.apache.hcatalog.api.HCatCommandDesc#isValidationComplete()
     */
    @Override
    boolean isValidationComplete() {
        // TODO Auto-generated method stub
        return false;
    }

}