org.apache.hadoop.hive.metastore.messaging

Class MessageFactory

java.lang.Object

org.apache.hadoop.hive.metastore.messaging.MessageFactory

Direct Known Subclasses:

JSONMessageFactory

public abstract class MessageFactory
extends Object

Abstract Factory for the construction of HCatalog message instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABORT_TXN_EVENT
static String	ADD_FOREIGNKEY_EVENT
static String	ADD_NOTNULLCONSTRAINT_EVENT
static String	ADD_PARTITION_EVENT
static String	ADD_PRIMARYKEY_EVENT
static String	ADD_SCHEMA_VERSION_EVENT
static String	ADD_UNIQUECONSTRAINT_EVENT
static String	ALLOC_WRITE_ID_EVENT
static String	ALTER_CATALOG_EVENT
static String	ALTER_DATABASE_EVENT
static String	ALTER_ISCHEMA_EVENT
static String	ALTER_PARTITION_EVENT
static String	ALTER_SCHEMA_VERSION_EVENT
static String	ALTER_TABLE_EVENT
static String	COMMIT_TXN_EVENT
protected static org.apache.hadoop.conf.Configuration	conf
static String	CREATE_CATALOG_EVENT
static String	CREATE_DATABASE_EVENT
static String	CREATE_FUNCTION_EVENT
static String	CREATE_ISCHEMA_EVENT
static String	CREATE_TABLE_EVENT
static String	DROP_CATALOG_EVENT
static String	DROP_CONSTRAINT_EVENT
static String	DROP_DATABASE_EVENT
static String	DROP_FUNCTION_EVENT
static String	DROP_ISCHEMA_EVENT
static String	DROP_PARTITION_EVENT
static String	DROP_SCHEMA_VERSION_EVENT
static String	DROP_TABLE_EVENT
static String	INSERT_EVENT
protected static String	MS_SERVER_URL
protected static String	MS_SERVICE_PRINCIPAL
static String	OPEN_TXN_EVENT

Constructor Summary

Constructors

Constructor and Description
MessageFactory()

Method Summary

Modifier and Type	Method and Description
abstract AbortTxnMessage	buildAbortTxnMessage(Long txnId) Factory method for building abort txn message
abstract AddForeignKeyMessage	buildAddForeignKeyMessage(List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> fks) Factory method for building add foreign key message
abstract AddNotNullConstraintMessage	buildAddNotNullConstraintMessage(List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> nns) Factory method for building add not null constraint message
abstract AddPartitionMessage	buildAddPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table, Iterator<org.apache.hadoop.hive.metastore.api.Partition> partitions, Iterator<PartitionFiles> partitionFiles) Factory method for AddPartitionMessage.
abstract AddPrimaryKeyMessage	buildAddPrimaryKeyMessage(List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> pks) Factory method for building add primary key message
abstract AddUniqueConstraintMessage	buildAddUniqueConstraintMessage(List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uks) Factory method for building add unique constraint message
abstract AllocWriteIdMessage	buildAllocWriteIdMessage(List<org.apache.hadoop.hive.metastore.api.TxnToWriteId> txnToWriteIdList, String dbName, String tableName) Factory method for building alloc write id message
abstract AlterCatalogMessage	buildAlterCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog oldCat, org.apache.hadoop.hive.metastore.api.Catalog newCat)
abstract AlterDatabaseMessage	buildAlterDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database beforeDb, org.apache.hadoop.hive.metastore.api.Database afterDb) Factory method for AlterDatabaseMessage.
abstract AlterPartitionMessage	buildAlterPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table, org.apache.hadoop.hive.metastore.api.Partition before, org.apache.hadoop.hive.metastore.api.Partition after, boolean isTruncateOp) Factory method for building AlterPartitionMessage
abstract AlterTableMessage	buildAlterTableMessage(org.apache.hadoop.hive.metastore.api.Table before, org.apache.hadoop.hive.metastore.api.Table after, boolean isTruncateOp) Factory method for AlterTableMessage.
abstract CommitTxnMessage	buildCommitTxnMessage(Long txnId) Factory method for building commit txn message
abstract CreateCatalogMessage	buildCreateCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog catalog)
abstract CreateDatabaseMessage	buildCreateDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database db) Factory method for CreateDatabaseMessage.
abstract CreateFunctionMessage	buildCreateFunctionMessage(org.apache.hadoop.hive.metastore.api.Function fn) Factory method for CreateFunctionMessage.
abstract CreateTableMessage	buildCreateTableMessage(org.apache.hadoop.hive.metastore.api.Table table, Iterator<String> files) Factory method for CreateTableMessage.
abstract DropCatalogMessage	buildDropCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog catalog)
abstract DropConstraintMessage	buildDropConstraintMessage(String dbName, String tableName, String constraintName) Factory method for building drop constraint message
abstract DropDatabaseMessage	buildDropDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database db) Factory method for DropDatabaseMessage.
abstract DropFunctionMessage	buildDropFunctionMessage(org.apache.hadoop.hive.metastore.api.Function fn) Factory method for DropFunctionMessage.
abstract DropPartitionMessage	buildDropPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table, Iterator<org.apache.hadoop.hive.metastore.api.Partition> partitions) Factory method for DropPartitionMessage.
abstract DropTableMessage	buildDropTableMessage(org.apache.hadoop.hive.metastore.api.Table table) Factory method for DropTableMessage.
abstract InsertMessage	buildInsertMessage(org.apache.hadoop.hive.metastore.api.Table tableObj, org.apache.hadoop.hive.metastore.api.Partition ptnObj, boolean replace, Iterator<String> files) Factory method for building insert message
abstract OpenTxnMessage	buildOpenTxnMessage(Long fromTxnId, Long toTxnId) Factory method for building open txn message using start and end transaction range
abstract MessageDeserializer	getDeserializer()
static MessageDeserializer	getDeserializer(String format, String version) Getter for MessageDeserializer, corresponding to the specified format and version.
static MessageFactory	getInstance() Getter for MessageFactory instance.
abstract String	getMessageFormat() Getter for message-format.

Methods inherited from class java.lang.Object

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

Field Detail

ADD_PARTITION_EVENT

public static final String ADD_PARTITION_EVENT

See Also:

Constant Field Values

ALTER_PARTITION_EVENT

public static final String ALTER_PARTITION_EVENT

See Also:

Constant Field Values

DROP_PARTITION_EVENT

public static final String DROP_PARTITION_EVENT

See Also:

Constant Field Values

CREATE_TABLE_EVENT

public static final String CREATE_TABLE_EVENT

See Also:

Constant Field Values

ALTER_TABLE_EVENT

public static final String ALTER_TABLE_EVENT

See Also:

Constant Field Values

DROP_TABLE_EVENT

public static final String DROP_TABLE_EVENT

See Also:

Constant Field Values

CREATE_DATABASE_EVENT

public static final String CREATE_DATABASE_EVENT

See Also:

Constant Field Values

ALTER_DATABASE_EVENT

public static final String ALTER_DATABASE_EVENT

See Also:

Constant Field Values

DROP_DATABASE_EVENT

public static final String DROP_DATABASE_EVENT

See Also:

Constant Field Values

INSERT_EVENT

public static final String INSERT_EVENT

See Also:

Constant Field Values

CREATE_FUNCTION_EVENT

public static final String CREATE_FUNCTION_EVENT

See Also:

Constant Field Values

DROP_FUNCTION_EVENT

public static final String DROP_FUNCTION_EVENT

See Also:

Constant Field Values

ADD_PRIMARYKEY_EVENT

public static final String ADD_PRIMARYKEY_EVENT

See Also:

Constant Field Values

ADD_FOREIGNKEY_EVENT

public static final String ADD_FOREIGNKEY_EVENT

See Also:

Constant Field Values

ADD_UNIQUECONSTRAINT_EVENT

public static final String ADD_UNIQUECONSTRAINT_EVENT

See Also:

Constant Field Values

ADD_NOTNULLCONSTRAINT_EVENT

public static final String ADD_NOTNULLCONSTRAINT_EVENT

See Also:

Constant Field Values

DROP_CONSTRAINT_EVENT

public static final String DROP_CONSTRAINT_EVENT

See Also:

Constant Field Values

CREATE_ISCHEMA_EVENT

public static final String CREATE_ISCHEMA_EVENT

See Also:

Constant Field Values

ALTER_ISCHEMA_EVENT

public static final String ALTER_ISCHEMA_EVENT

See Also:

Constant Field Values

DROP_ISCHEMA_EVENT

public static final String DROP_ISCHEMA_EVENT

See Also:

Constant Field Values

ADD_SCHEMA_VERSION_EVENT

public static final String ADD_SCHEMA_VERSION_EVENT

See Also:

Constant Field Values

ALTER_SCHEMA_VERSION_EVENT

public static final String ALTER_SCHEMA_VERSION_EVENT

See Also:

Constant Field Values

DROP_SCHEMA_VERSION_EVENT

public static final String DROP_SCHEMA_VERSION_EVENT

See Also:

Constant Field Values

CREATE_CATALOG_EVENT

public static final String CREATE_CATALOG_EVENT

See Also:

Constant Field Values

DROP_CATALOG_EVENT

public static final String DROP_CATALOG_EVENT

See Also:

Constant Field Values

OPEN_TXN_EVENT

public static final String OPEN_TXN_EVENT

See Also:

Constant Field Values

COMMIT_TXN_EVENT

public static final String COMMIT_TXN_EVENT

See Also:

Constant Field Values

ABORT_TXN_EVENT

public static final String ABORT_TXN_EVENT

See Also:

Constant Field Values

ALLOC_WRITE_ID_EVENT

public static final String ALLOC_WRITE_ID_EVENT

See Also:

Constant Field Values

ALTER_CATALOG_EVENT

public static final String ALTER_CATALOG_EVENT

See Also:

Constant Field Values

conf

protected static final org.apache.hadoop.conf.Configuration conf

MS_SERVER_URL

protected static final String MS_SERVER_URL

MS_SERVICE_PRINCIPAL

protected static final String MS_SERVICE_PRINCIPAL

Constructor Detail

MessageFactory

public MessageFactory()

Method Detail

getInstance

public static MessageFactory getInstance()

Getter for MessageFactory instance.

getDeserializer

public static MessageDeserializer getDeserializer(String format,
                                                  String version)

Getter for MessageDeserializer, corresponding to the specified format and version.

Parameters:

format - Serialization format for notifications.

version - Version of serialization format (currently ignored.)

Returns:

MessageDeserializer.

getDeserializer

public abstract MessageDeserializer getDeserializer()

getMessageFormat

public abstract String getMessageFormat()

Getter for message-format.

buildCreateDatabaseMessage

public abstract CreateDatabaseMessage buildCreateDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database db)

Factory method for CreateDatabaseMessage.

Parameters:

db - The Database being added.

Returns:

CreateDatabaseMessage instance.

buildAlterDatabaseMessage

public abstract AlterDatabaseMessage buildAlterDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database beforeDb,
                                                               org.apache.hadoop.hive.metastore.api.Database afterDb)

Factory method for AlterDatabaseMessage.

Parameters:

beforeDb - The Database before alter.

afterDb - The Database after alter.

Returns:

AlterDatabaseMessage instance.

buildDropDatabaseMessage

public abstract DropDatabaseMessage buildDropDatabaseMessage(org.apache.hadoop.hive.metastore.api.Database db)

Factory method for DropDatabaseMessage.

Parameters:

db - The Database being dropped.

Returns:

DropDatabaseMessage instance.

buildCreateTableMessage

public abstract CreateTableMessage buildCreateTableMessage(org.apache.hadoop.hive.metastore.api.Table table,
                                                           Iterator<String> files)

Factory method for CreateTableMessage.

Parameters:

table - The Table being created.

files - Iterator of files

Returns:

CreateTableMessage instance.

buildAlterTableMessage

public abstract AlterTableMessage buildAlterTableMessage(org.apache.hadoop.hive.metastore.api.Table before,
                                                         org.apache.hadoop.hive.metastore.api.Table after,
                                                         boolean isTruncateOp)

Factory method for AlterTableMessage. Unlike most of these calls, this one can return null, which means no message should be sent. This is because there are many flavors of alter table (add column, add partition, etc.). Some are covered elsewhere (like add partition) and some are not yet supported.

Parameters:

before - The table before the alter

after - The table after the alter

isTruncateOp - Flag to denote truncate table

Returns:

buildDropTableMessage

public abstract DropTableMessage buildDropTableMessage(org.apache.hadoop.hive.metastore.api.Table table)

Factory method for DropTableMessage.

Parameters:

table - The Table being dropped.

Returns:

DropTableMessage instance.

buildAddPartitionMessage

public abstract AddPartitionMessage buildAddPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table,
                                                             Iterator<org.apache.hadoop.hive.metastore.api.Partition> partitions,
                                                             Iterator<PartitionFiles> partitionFiles)

Factory method for AddPartitionMessage.

Parameters:

table - The Table to which the partitions are added.

partitions - The iterator to set of Partitions being added.

partitionFiles - The iterator of partition files

Returns:

AddPartitionMessage instance.

buildAlterPartitionMessage

public abstract AlterPartitionMessage buildAlterPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table,
                                                                 org.apache.hadoop.hive.metastore.api.Partition before,
                                                                 org.apache.hadoop.hive.metastore.api.Partition after,
                                                                 boolean isTruncateOp)

Factory method for building AlterPartitionMessage

Parameters:

table - The table in which the partition is being altered

before - The partition before it was altered

after - The partition after it was altered

isTruncateOp - Flag to denote truncate partition

Returns:

a new AlterPartitionMessage

buildDropPartitionMessage

public abstract DropPartitionMessage buildDropPartitionMessage(org.apache.hadoop.hive.metastore.api.Table table,
                                                               Iterator<org.apache.hadoop.hive.metastore.api.Partition> partitions)

Factory method for DropPartitionMessage.

Parameters:

table - The Table from which the partition is dropped.

partitions - The set of partitions being dropped.

Returns:

DropPartitionMessage instance.

buildCreateFunctionMessage

public abstract CreateFunctionMessage buildCreateFunctionMessage(org.apache.hadoop.hive.metastore.api.Function fn)

Factory method for CreateFunctionMessage.

Parameters:

fn - The Function being added.

Returns:

CreateFunctionMessage instance.

buildDropFunctionMessage

public abstract DropFunctionMessage buildDropFunctionMessage(org.apache.hadoop.hive.metastore.api.Function fn)

Factory method for DropFunctionMessage.

Parameters:

fn - The Function being dropped.

Returns:

DropFunctionMessage instance.

buildInsertMessage

public abstract InsertMessage buildInsertMessage(org.apache.hadoop.hive.metastore.api.Table tableObj,
                                                 org.apache.hadoop.hive.metastore.api.Partition ptnObj,
                                                 boolean replace,
                                                 Iterator<String> files)

Factory method for building insert message

Parameters:

tableObj - Table object where the insert occurred in

ptnObj - Partition object where the insert occurred in, may be null if the insert was done into a non-partitioned table

replace - Flag to represent if INSERT OVERWRITE or INSERT INTO

files - Iterator of file created

Returns:

instance of InsertMessage

buildOpenTxnMessage

public abstract OpenTxnMessage buildOpenTxnMessage(Long fromTxnId,
                                                   Long toTxnId)

Factory method for building open txn message using start and end transaction range

Parameters:

fromTxnId - start transaction id (inclusive)

toTxnId - end transaction id (inclusive)

Returns:

instance of OpenTxnMessage

buildCommitTxnMessage

public abstract CommitTxnMessage buildCommitTxnMessage(Long txnId)

Factory method for building commit txn message

Parameters:

txnId - Id of the transaction to be committed

Returns:

instance of CommitTxnMessage

buildAbortTxnMessage

public abstract AbortTxnMessage buildAbortTxnMessage(Long txnId)

Factory method for building abort txn message

Parameters:

txnId - Id of the transaction to be aborted

Returns:

instance of AbortTxnMessage

buildAllocWriteIdMessage

public abstract AllocWriteIdMessage buildAllocWriteIdMessage(List<org.apache.hadoop.hive.metastore.api.TxnToWriteId> txnToWriteIdList,
                                                             String dbName,
                                                             String tableName)

Factory method for building alloc write id message

Parameters:

txnToWriteIdList - List of Txn Ids and write id map

dbName - db for which write ids to be allocated

tableName - table for which write ids to be allocated

Returns:

instance of AllocWriteIdMessage

buildAddPrimaryKeyMessage

public abstract AddPrimaryKeyMessage buildAddPrimaryKeyMessage(List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> pks)

Factory method for building add primary key message

Parameters:

pks - list of primary keys

Returns:

instance of AddPrimaryKeyMessage

buildAddForeignKeyMessage

public abstract AddForeignKeyMessage buildAddForeignKeyMessage(List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> fks)

Factory method for building add foreign key message

Parameters:

fks - list of foreign keys

Returns:

instance of AddForeignKeyMessage

buildAddUniqueConstraintMessage

public abstract AddUniqueConstraintMessage buildAddUniqueConstraintMessage(List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uks)

Factory method for building add unique constraint message

Parameters:

uks - list of unique constraints

Returns:

instance of SQLUniqueConstraint

buildAddNotNullConstraintMessage

public abstract AddNotNullConstraintMessage buildAddNotNullConstraintMessage(List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> nns)

Factory method for building add not null constraint message

Parameters:

nns - list of not null constraints

Returns:

instance of SQLNotNullConstraint

buildDropConstraintMessage

public abstract DropConstraintMessage buildDropConstraintMessage(String dbName,
                                                                 String tableName,
                                                                 String constraintName)

Factory method for building drop constraint message

Parameters:

dbName -

tableName -

constraintName -

Returns:

buildCreateCatalogMessage

public abstract CreateCatalogMessage buildCreateCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog catalog)

buildDropCatalogMessage

public abstract DropCatalogMessage buildDropCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog catalog)

buildAlterCatalogMessage

public abstract AlterCatalogMessage buildAlterCatalogMessage(org.apache.hadoop.hive.metastore.api.Catalog oldCat,
                                                             org.apache.hadoop.hive.metastore.api.Catalog newCat)