org.apache.hadoop.hive.metastore

Class MetaStoreEventListener

java.lang.Object

org.apache.hadoop.hive.metastore.MetaStoreEventListener

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable

Direct Known Subclasses:

HMSMetricsListener, SessionPropertiesListener, TransactionalMetaStoreEventListener

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class MetaStoreEventListener
extends Object
implements org.apache.hadoop.conf.Configurable

This abstract class needs to be extended to provide implementation of actions that needs to be performed when a particular event occurs on a metastore. These methods are called whenever an event occurs on metastore. Status of the event whether it was successful or not is contained in container event object.

Constructor Summary

Constructors

Constructor and Description
MetaStoreEventListener(org.apache.hadoop.conf.Configuration config)

Method Summary

Modifier and Type	Method and Description
boolean	doesAddEventsToNotificationLogTable() This is to check if the listener adds the event info to notification log table.
org.apache.hadoop.conf.Configuration	getConf()
void	onAbortTxn(AbortTxnEvent abortTxnEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to abort a transaction.
void	onAcidWrite(AcidWriteEvent acidWriteEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to perform acid write operation.
void	onAddCheckConstraint(AddCheckConstraintEvent addCheckConstraintEvent)
void	onAddDefaultConstraint(AddDefaultConstraintEvent addDefaultConstraintEvent)
void	onAddForeignKey(AddForeignKeyEvent addForeignKeyEvent)
void	onAddNotNullConstraint(AddNotNullConstraintEvent addNotNullConstraintEvent)
void	onAddPartition(AddPartitionEvent partitionEvent)
void	onAddPrimaryKey(AddPrimaryKeyEvent addPrimaryKeyEvent)
void	onAddSchemaVersion(AddSchemaVersionEvent addSchemaVersionEvent)
void	onAddUniqueConstraint(AddUniqueConstraintEvent addUniqueConstraintEvent)
void	onAllocWriteId(AllocWriteIdEvent allocWriteIdEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to alloc a new write id.
void	onAlterCatalog(AlterCatalogEvent alterCatalogEvent)
void	onAlterDatabase(AlterDatabaseEvent dbEvent)
void	onAlterDataConnector(AlterDataConnectorEvent dcEvent)
void	onAlterISchema(AlterISchemaEvent alterISchemaEvent)
void	onAlterPartition(AlterPartitionEvent partitionEvent)
void	onAlterSchemaVersion(AlterSchemaVersionEvent alterSchemaVersionEvent)
void	onAlterTable(AlterTableEvent tableEvent)
void	onBatchAcidWrite(BatchAcidWriteEvent batchAcidWriteEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to perform acid write operation in a batch.
void	onCommitCompaction(CommitCompactionEvent commitCompactionEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to commit a compaction transaction.
void	onCommitTxn(CommitTxnEvent commitTxnEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to commit a transaction.
void	onConfigChange(ConfigChangeEvent tableEvent)
void	onCreateCatalog(CreateCatalogEvent createCatalogEvent)
void	onCreateDatabase(CreateDatabaseEvent dbEvent)
void	onCreateDataConnector(CreateDataConnectorEvent connectorEvent)
void	onCreateFunction(CreateFunctionEvent fnEvent)
void	onCreateISchema(CreateISchemaEvent createISchemaEvent)
void	onCreateTable(CreateTableEvent tableEvent)
void	onDeletePartitionColumnStat(DeletePartitionColumnStatEvent deletePartColStatEvent) This will be called to delete partition column stats
void	onDeleteTableColumnStat(DeleteTableColumnStatEvent deleteTableColumnStatEvent) This will be called to delete table column stats
void	onDropCatalog(DropCatalogEvent dropCatalogEvent)
void	onDropConstraint(DropConstraintEvent dropConstraintEvent)
void	onDropDatabase(DropDatabaseEvent dbEvent)
void	onDropDataConnector(DropDataConnectorEvent connectorEvent)
void	onDropFunction(DropFunctionEvent fnEvent)
void	onDropISchema(DropISchemaEvent dropISchemaEvent)
void	onDropPartition(DropPartitionEvent partitionEvent)
void	onDropSchemaVersion(DropSchemaVersionEvent dropSchemaVersionEvent)
void	onDropTable(DropTableEvent tableEvent)
void	onInsert(InsertEvent insertEvent) This will be called when an insert is executed that does not cause a partition to be added.
void	onLoadPartitionDone(LoadPartitionDoneEvent partSetDoneEvent)
void	onOpenTxn(OpenTxnEvent openTxnEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called when a new transaction is started.
void	onReload(ReloadEvent reloadEvent) This will be called to reload table/partition
void	onUpdatePartitionColumnStat(UpdatePartitionColumnStatEvent updatePartColStatEvent) This will be called to update partition column stats
void	onUpdatePartitionColumnStatInBatch(UpdatePartitionColumnStatEventBatch updatePartColStatEvent, Connection dbConn, SQLGenerator sqlGenerator) This will be called to update batch of partition column stats.The backend RDBMS operations are done using direct sql mode.
void	onUpdateTableColumnStat(UpdateTableColumnStatEvent updateTableColumnStatEvent) This will be called to update table column stats
void	setConf(org.apache.hadoop.conf.Configuration config)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaStoreEventListener

public MetaStoreEventListener(org.apache.hadoop.conf.Configuration config)

Method Detail

onConfigChange

public void onConfigChange(ConfigChangeEvent tableEvent)
                    throws MetaException

Parameters:

tableEvent - table event.

Throws:

MetaException

onCreateTable

public void onCreateTable(CreateTableEvent tableEvent)
                   throws MetaException

Parameters:

tableEvent - table event.

Throws:

MetaException

onDropTable

public void onDropTable(DropTableEvent tableEvent)
                 throws MetaException

Parameters:

tableEvent - table event.

Throws:

MetaException

onAlterTable

public void onAlterTable(AlterTableEvent tableEvent)
                  throws MetaException

Parameters:

tableEvent - alter table event

Throws:

MetaException

onAddPartition

public void onAddPartition(AddPartitionEvent partitionEvent)
                    throws MetaException

Parameters:

partitionEvent - add partition event

Throws:

MetaException

onDropPartition

public void onDropPartition(DropPartitionEvent partitionEvent)
                     throws MetaException

Parameters:

partitionEvent - partition event

Throws:

MetaException

onAlterPartition

public void onAlterPartition(AlterPartitionEvent partitionEvent)
                      throws MetaException

Parameters:

partitionEvent - partition event

Throws:

MetaException

onCreateDatabase

public void onCreateDatabase(CreateDatabaseEvent dbEvent)
                      throws MetaException

Parameters:

dbEvent - database event

Throws:

MetaException

onDropDatabase

public void onDropDatabase(DropDatabaseEvent dbEvent)
                    throws MetaException

Parameters:

dbEvent - database event

Throws:

MetaException

onCreateDataConnector

public void onCreateDataConnector(CreateDataConnectorEvent connectorEvent)
                           throws MetaException

Parameters:

connectorEvent - dataconnector event

Throws:

MetaException

onDropDataConnector

public void onDropDataConnector(DropDataConnectorEvent connectorEvent)
                         throws MetaException

Parameters:

connectorEvent - dataconnector event

Throws:

MetaException

onAlterDataConnector

public void onAlterDataConnector(AlterDataConnectorEvent dcEvent)
                          throws MetaException

Parameters:

dcEvent - alter data connector event

Throws:

MetaException

onAlterDatabase

public void onAlterDatabase(AlterDatabaseEvent dbEvent)
                     throws MetaException

Parameters:

dbEvent - alter database event

Throws:

MetaException

onLoadPartitionDone

public void onLoadPartitionDone(LoadPartitionDoneEvent partSetDoneEvent)
                         throws MetaException

Parameters:

partSetDoneEvent -

Throws:

MetaException

onCreateFunction

public void onCreateFunction(CreateFunctionEvent fnEvent)
                      throws MetaException

Parameters:

fnEvent - function event

Throws:

MetaException

onDropFunction

public void onDropFunction(DropFunctionEvent fnEvent)
                    throws MetaException

Parameters:

fnEvent - function event

Throws:

MetaException

onInsert

public void onInsert(InsertEvent insertEvent)
              throws MetaException

This will be called when an insert is executed that does not cause a partition to be added. If an insert causes a partition to be added it will cause onAddPartition(org.apache.hadoop.hive.metastore.events.AddPartitionEvent) to be called instead.

Parameters:

insertEvent -

Throws:

MetaException

onAddPrimaryKey

public void onAddPrimaryKey(AddPrimaryKeyEvent addPrimaryKeyEvent)
                     throws MetaException

Parameters:

addPrimaryKeyEvent - add primary key event

Throws:

MetaException

onAddForeignKey

public void onAddForeignKey(AddForeignKeyEvent addForeignKeyEvent)
                     throws MetaException

Parameters:

addForeignKeyEvent - add foreign key event

Throws:

MetaException

onAddUniqueConstraint

public void onAddUniqueConstraint(AddUniqueConstraintEvent addUniqueConstraintEvent)
                           throws MetaException

Parameters:

addUniqueConstraintEvent - add unique constraint event

Throws:

MetaException

onAddNotNullConstraint

public void onAddNotNullConstraint(AddNotNullConstraintEvent addNotNullConstraintEvent)
                            throws MetaException

Parameters:

addNotNullConstraintEvent - add not null constraint event

Throws:

MetaException

onAddDefaultConstraint

public void onAddDefaultConstraint(AddDefaultConstraintEvent addDefaultConstraintEvent)
                            throws MetaException

Parameters:

addDefaultConstraintEvent - add default constraint event

Throws:

MetaException

onAddCheckConstraint

public void onAddCheckConstraint(AddCheckConstraintEvent addCheckConstraintEvent)
                          throws MetaException

Parameters:

addCheckConstraintEvent - add check constraint event

Throws:

MetaException

onDropConstraint

public void onDropConstraint(DropConstraintEvent dropConstraintEvent)
                      throws MetaException

Parameters:

dropConstraintEvent - drop constraint event

Throws:

MetaException

onCreateISchema

public void onCreateISchema(CreateISchemaEvent createISchemaEvent)
                     throws MetaException

Throws:

MetaException

onAlterISchema

public void onAlterISchema(AlterISchemaEvent alterISchemaEvent)
                    throws MetaException

Throws:

MetaException

onDropISchema

public void onDropISchema(DropISchemaEvent dropISchemaEvent)
                   throws MetaException

Throws:

MetaException

onAddSchemaVersion

public void onAddSchemaVersion(AddSchemaVersionEvent addSchemaVersionEvent)
                        throws MetaException

Throws:

MetaException

onAlterSchemaVersion

public void onAlterSchemaVersion(AlterSchemaVersionEvent alterSchemaVersionEvent)
                          throws MetaException

Throws:

MetaException

onDropSchemaVersion

public void onDropSchemaVersion(DropSchemaVersionEvent dropSchemaVersionEvent)
                         throws MetaException

Throws:

MetaException

onCreateCatalog

public void onCreateCatalog(CreateCatalogEvent createCatalogEvent)
                     throws MetaException

Throws:

MetaException

onAlterCatalog

public void onAlterCatalog(AlterCatalogEvent alterCatalogEvent)
                    throws MetaException

Throws:

MetaException

onDropCatalog

public void onDropCatalog(DropCatalogEvent dropCatalogEvent)
                   throws MetaException

Throws:

MetaException

onOpenTxn

public void onOpenTxn(OpenTxnEvent openTxnEvent,
                      Connection dbConn,
                      SQLGenerator sqlGenerator)
               throws MetaException

This will be called when a new transaction is started.

Parameters:

openTxnEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onCommitTxn

public void onCommitTxn(CommitTxnEvent commitTxnEvent,
                        Connection dbConn,
                        SQLGenerator sqlGenerator)
                 throws MetaException

This will be called to commit a transaction.

Parameters:

commitTxnEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onAbortTxn

public void onAbortTxn(AbortTxnEvent abortTxnEvent,
                       Connection dbConn,
                       SQLGenerator sqlGenerator)
                throws MetaException

This will be called to abort a transaction.

Parameters:

abortTxnEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onAllocWriteId

public void onAllocWriteId(AllocWriteIdEvent allocWriteIdEvent,
                           Connection dbConn,
                           SQLGenerator sqlGenerator)
                    throws MetaException

This will be called to alloc a new write id.

Parameters:

allocWriteIdEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onAcidWrite

public void onAcidWrite(AcidWriteEvent acidWriteEvent,
                        Connection dbConn,
                        SQLGenerator sqlGenerator)
                 throws MetaException

This will be called to perform acid write operation.

Parameters:

acidWriteEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onBatchAcidWrite

public void onBatchAcidWrite(BatchAcidWriteEvent batchAcidWriteEvent,
                             Connection dbConn,
                             SQLGenerator sqlGenerator)
                      throws MetaException

This will be called to perform acid write operation in a batch.

Parameters:

batchAcidWriteEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException

onUpdateTableColumnStat

public void onUpdateTableColumnStat(UpdateTableColumnStatEvent updateTableColumnStatEvent)
                             throws MetaException

This will be called to update table column stats

Parameters:

updateTableColumnStatEvent - event to be processed

Throws:

MetaException

onDeleteTableColumnStat

public void onDeleteTableColumnStat(DeleteTableColumnStatEvent deleteTableColumnStatEvent)
                             throws MetaException

This will be called to delete table column stats

Parameters:

deleteTableColumnStatEvent - event to be processed

Throws:

MetaException

onUpdatePartitionColumnStat

public void onUpdatePartitionColumnStat(UpdatePartitionColumnStatEvent updatePartColStatEvent)
                                 throws MetaException

This will be called to update partition column stats

Parameters:

updatePartColStatEvent - event to be processed

Throws:

MetaException

onUpdatePartitionColumnStatInBatch

public void onUpdatePartitionColumnStatInBatch(UpdatePartitionColumnStatEventBatch updatePartColStatEvent,
                                               Connection dbConn,
                                               SQLGenerator sqlGenerator)
                                        throws MetaException

This will be called to update batch of partition column stats.The backend RDBMS operations are done using direct sql mode.

Parameters:

updatePartColStatEvent - event to be processed

Throws:

MetaException

onDeletePartitionColumnStat

public void onDeletePartitionColumnStat(DeletePartitionColumnStatEvent deletePartColStatEvent)
                                 throws MetaException

This will be called to delete partition column stats

Parameters:

deletePartColStatEvent - event to be processed

Throws:

MetaException

onCommitCompaction

public void onCommitCompaction(CommitCompactionEvent commitCompactionEvent,
                               Connection dbConn,
                               SQLGenerator sqlGenerator)
                        throws MetaException

This will be called to commit a compaction transaction.

Parameters:

commitCompactionEvent - event to be processed

dbConn - jdbc connection to remote meta store db.

sqlGenerator - helper class to generate db specific sql string.

Throws:

MetaException - ex

onReload

public void onReload(ReloadEvent reloadEvent)
              throws MetaException

This will be called to reload table/partition

Parameters:

reloadEvent - event to be processed

Throws:

MetaException

doesAddEventsToNotificationLogTable

public boolean doesAddEventsToNotificationLogTable()

This is to check if the listener adds the event info to notification log table.

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf

public void setConf(org.apache.hadoop.conf.Configuration config)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable