HiveMetaHook (Hive Standalone Metastore Common Code 4.0.0 API)

All Known Implementing Classes:

DefaultHiveMetaHook
```
@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface HiveMetaHook
```
HiveMetaHook defines notification methods which are invoked as part of transactions against the metastore, allowing external catalogs such as HBase to be kept in sync with Hive's metastore.
Implementations can use MetaStoreUtils.isExternalTable(org.apache.hadoop.hive.metastore.api.Table) to distinguish external tables from managed tables.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_PARTITION_KEY_CHANGE`
`static List<String>`	`allowedAlterTypes`
`static String`	`ALTER_TABLE_OPERATION_TYPE`
`static String`	`ALTERLOCATION`
`static String`	`EXTERNAL`
`static String`	`ICEBERG`
`static String`	`INITIALIZE_ROLLBACK_MIGRATION`
`static String`	`MIGRATE_HIVE_TO_ICEBERG`
`static String`	`OLD_DB_NAME`
`static String`	`OLD_TABLE_NAME`
`static String`	`PROPERTIES_SEPARATOR`
`static String`	`SET_PROPERTIES`
`static String`	`SKIP_METASTORE_ALTER`
`static String`	`TABLE_TYPE`
`static String`	`TRANSLATED_TO_EXTERNAL`
`static String`	`UNSET_PROPERTIES`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`commitAlterTable(Table table, EnvironmentContext context)` Called after a table is altered in the metastore during ALTER TABLE.
`void`	`commitCreateTable(Table table)` Called after successfully adding a new table definition to the metastore during CREATE TABLE.
`void`	`commitDropTable(Table table, boolean deleteData)` Called after successfully removing a table definition from the metastore during DROP TABLE.
`default boolean`	`createHMSTableInHook()` Returns true if the HMS table should be created by the implementing class.
`default void`	`postGetTable(Table table)` Set storage handler specific table properties
`default void`	`preAlterTable(Table table, EnvironmentContext context)` Called before a table is altered in the metastore during ALTER TABLE.
`default void`	`preCreateTable(CreateTableRequest request)` Called before a new table definition is added to the metastore during CREATE TABLE.
`void`	`preCreateTable(Table table)` Called before a new table definition is added to the metastore during CREATE TABLE.
`default void`	`preDropPartitions(Table table, EnvironmentContext context, List<org.apache.commons.lang3.tuple.Pair<Integer,byte[]>> partExprs)` Called before dropping the partitions from the table in the metastore during ALTER TABLE DROP PARTITION.
`void`	`preDropTable(Table table)` Called before a table definition is removed from the metastore during DROP TABLE.
`default void`	`preDropTable(Table table, boolean deleteData)` Called before a table definition is removed from the metastore during DROP TABLE
`default void`	`preTruncateTable(Table table, EnvironmentContext context)` Called before deleting the data and statistics from the table in the metastore during TRUNCATE TABLE.
`default void`	`preTruncateTable(Table table, EnvironmentContext context, List<String> partNames)`
`default void`	`rollbackAlterTable(Table table, EnvironmentContext context)` Called after failure altering a table definition from the metastore during ALTER TABLE
`void`	`rollbackCreateTable(Table table)` Called after failure adding a new table definition to the metastore during CREATE TABLE.
`void`	`rollbackDropTable(Table table)` Called after failure removing a table definition from the metastore during DROP TABLE.

- Field Detail
  - ALTER_TABLE_OPERATION_TYPE
```
static final String ALTER_TABLE_OPERATION_TYPE
```
    See Also:
    
    Constant Field Values
  - allowedAlterTypes
```
static final List<String> allowedAlterTypes
```
  - ALTERLOCATION
```
static final String ALTERLOCATION
```
    See Also:
    
    Constant Field Values
  - ALLOW_PARTITION_KEY_CHANGE
```
static final String ALLOW_PARTITION_KEY_CHANGE
```
    See Also:
    
    Constant Field Values
  - SET_PROPERTIES
```
static final String SET_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - UNSET_PROPERTIES
```
static final String UNSET_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - TRANSLATED_TO_EXTERNAL
```
static final String TRANSLATED_TO_EXTERNAL
```
    See Also:
    
    Constant Field Values
  - TABLE_TYPE
```
static final String TABLE_TYPE
```
    See Also:
    
    Constant Field Values
  - EXTERNAL
```
static final String EXTERNAL
```
    See Also:
    
    Constant Field Values
  - ICEBERG
```
static final String ICEBERG
```
    See Also:
    
    Constant Field Values
  - PROPERTIES_SEPARATOR
```
static final String PROPERTIES_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - MIGRATE_HIVE_TO_ICEBERG
```
static final String MIGRATE_HIVE_TO_ICEBERG
```
    See Also:
    
    Constant Field Values
  - INITIALIZE_ROLLBACK_MIGRATION
```
static final String INITIALIZE_ROLLBACK_MIGRATION
```
    See Also:
    
    Constant Field Values
  - SKIP_METASTORE_ALTER
```
static final String SKIP_METASTORE_ALTER
```
    See Also:
    
    Constant Field Values
  - OLD_TABLE_NAME
```
static final String OLD_TABLE_NAME
```
    See Also:
    
    Constant Field Values
  - OLD_DB_NAME
```
static final String OLD_DB_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - preCreateTable
```
void preCreateTable(Table table)
             throws MetaException
```
    Called before a new table definition is added to the metastore during CREATE TABLE.
    
    Parameters:
    
    table - new table definition
    
    Throws:
    
    MetaException
  - preCreateTable
```
default void preCreateTable(CreateTableRequest request)
                     throws MetaException
```
    Called before a new table definition is added to the metastore during CREATE TABLE.
    
    Parameters:
    
    request - the whole request to create a new table
    
    Throws:
    
    MetaException
  - rollbackCreateTable
```
void rollbackCreateTable(Table table)
                  throws MetaException
```
    Called after failure adding a new table definition to the metastore during CREATE TABLE.
    
    Parameters:
    
    table - new table definition
    
    Throws:
    
    MetaException
  - commitCreateTable
```
void commitCreateTable(Table table)
                throws MetaException
```
    Called after successfully adding a new table definition to the metastore during CREATE TABLE.
    
    Parameters:
    
    table - new table definition
    
    Throws:
    
    MetaException
  - preDropTable
```
void preDropTable(Table table)
           throws MetaException
```
    Called before a table definition is removed from the metastore during DROP TABLE.
    
    Parameters:
    
    table - table definition
    
    Throws:
    
    MetaException
  - preDropTable
```
default void preDropTable(Table table,
                          boolean deleteData)
                   throws MetaException
```
    Called before a table definition is removed from the metastore during DROP TABLE
    
    Parameters:
    
    table - table definition
    
    deleteData - whether to delete data as well; this should typically be ignored in the case of an external table
    
    Throws:
    
    MetaException
  - rollbackDropTable
```
void rollbackDropTable(Table table)
                throws MetaException
```
    Called after failure removing a table definition from the metastore during DROP TABLE.
    
    Parameters:
    
    table - table definition
    
    Throws:
    
    MetaException
  - commitDropTable
```
void commitDropTable(Table table,
                     boolean deleteData)
              throws MetaException
```
    Called after successfully removing a table definition from the metastore during DROP TABLE.
    
    Parameters:
    
    table - table definition
    
    deleteData - whether to delete data as well; this should typically be ignored in the case of an external table
    
    Throws:
    
    MetaException
  - preAlterTable
```
default void preAlterTable(Table table,
                           EnvironmentContext context)
                    throws MetaException
```
    Called before a table is altered in the metastore during ALTER TABLE.
    
    Parameters:
    
    table - new table definition
    
    Throws:
    
    MetaException
  - commitAlterTable
```
default void commitAlterTable(Table table,
                              EnvironmentContext context)
                       throws MetaException
```
    Called after a table is altered in the metastore during ALTER TABLE.
    
    Parameters:
    
    table - new table definition
    
    context - environment context, containing information about the alter operation type
    
    Throws:
    
    MetaException
  - rollbackAlterTable
```
default void rollbackAlterTable(Table table,
                                EnvironmentContext context)
                         throws MetaException
```
    Called after failure altering a table definition from the metastore during ALTER TABLE
    
    Parameters:
    
    table - new table definition
    
    context - context of the alter operation
    
    Throws:
    
    MetaException
  - preTruncateTable
```
default void preTruncateTable(Table table,
                              EnvironmentContext context)
                       throws MetaException
```
    Called before deleting the data and statistics from the table in the metastore during TRUNCATE TABLE.
    
    Parameters:
    
    table - table to be truncated
    
    context - context of the truncate operation
    
    Throws:
    
    MetaException
  - preTruncateTable
```
default void preTruncateTable(Table table,
                              EnvironmentContext context,
                              List<String> partNames)
                       throws MetaException
```
    Throws:
    
    MetaException
  - createHMSTableInHook
```
default boolean createHMSTableInHook()
```
    Returns true if the HMS table should be created by the implementing class.
    
    Returns:
  - postGetTable
```
default void postGetTable(Table table)
```
    Set storage handler specific table properties
    
    Parameters:
    
    table -
  - preDropPartitions
```
default void preDropPartitions(Table table,
                               EnvironmentContext context,
                               List<org.apache.commons.lang3.tuple.Pair<Integer,byte[]>> partExprs)
                        throws MetaException
```
    Called before dropping the partitions from the table in the metastore during ALTER TABLE DROP PARTITION.
    
    Parameters:
    
    table - table whose partition needs to be dropped
    
    context - context of the operation
    
    partExprs - List of partition expressions
    
    Throws:
    
    MetaException

Interface HiveMetaHook

Field Summary

Method Summary

Field Detail

ALTER_TABLE_OPERATION_TYPE

allowedAlterTypes

ALTERLOCATION

ALLOW_PARTITION_KEY_CHANGE

SET_PROPERTIES

UNSET_PROPERTIES

TRANSLATED_TO_EXTERNAL

TABLE_TYPE

EXTERNAL

ICEBERG

PROPERTIES_SEPARATOR

MIGRATE_HIVE_TO_ICEBERG

INITIALIZE_ROLLBACK_MIGRATION

SKIP_METASTORE_ALTER

OLD_TABLE_NAME

OLD_DB_NAME

Method Detail

preCreateTable

preCreateTable

rollbackCreateTable

commitCreateTable

preDropTable

preDropTable

rollbackDropTable

commitDropTable

preAlterTable

commitAlterTable

rollbackAlterTable

preTruncateTable

preTruncateTable

createHMSTableInHook

postGetTable

preDropPartitions