Package io.trino.plugin.hive.metastore

Interface HiveMetastore

All Known Implementing Classes:

AlluxioHiveMetastore, BridgingHiveMetastore, CachingHiveMetastore, FileHiveMetastore, ForwardingHiveMetastore, GlueHiveMetastore, RecordingHiveMetastore

public interface HiveMetastore

Method Summary

Modifier and Type	Method	Description
default void	abortTransaction(long transactionId)
default void	acquireSharedReadLock(AcidTransactionOwner transactionOwner, String queryId, long transactionId, List<SchemaTableName> fullTables, List<HivePartition> partitions)
default void	acquireTableWriteLock(AcidTransactionOwner transactionOwner, String queryId, long transactionId, String dbName, String tableName, org.apache.hadoop.hive.metastore.api.DataOperationType operation, boolean isDynamicPartitionWrite)
void	addColumn(String databaseName, String tableName, String columnName, HiveType columnType, String columnComment)
default void	addDynamicPartitions(String dbName, String tableName, List<String> partitionNames, long transactionId, long writeId, AcidOperation operation)
void	addPartitions(String databaseName, String tableName, List<PartitionWithStatistics> partitions)
default long	allocateWriteId(String dbName, String tableName, long transactionId)
void	alterPartition(String databaseName, String tableName, PartitionWithStatistics partition)
default void	alterPartitions(String dbName, String tableName, List<Partition> partitions, long writeId)
default void	alterTransactionalTable(Table table, long transactionId, long writeId, PrincipalPrivileges principalPrivileges)
void	commentColumn(String databaseName, String tableName, String columnName, Optional<String> comment)
void	commentTable(String databaseName, String tableName, Optional<String> comment)
default void	commitTransaction(long transactionId)
void	createDatabase(Database database)
void	createRole(String role, String grantor)
void	createTable(Table table, PrincipalPrivileges principalPrivileges)
void	dropColumn(String databaseName, String tableName, String columnName)
void	dropDatabase(String databaseName, boolean deleteData)
void	dropPartition(String databaseName, String tableName, List<String> parts, boolean deleteData)
void	dropRole(String role)
void	dropTable(String databaseName, String tableName, boolean deleteData)
List<String>	getAllDatabases()
List<String>	getAllTables(String databaseName)
List<String>	getAllViews(String databaseName)
default Optional<String>	getConfigValue(String name)
Optional<Database>	getDatabase(String databaseName)
Optional<Partition>	getPartition(Table table, List<String> partitionValues)
Optional<List<String>>	getPartitionNamesByFilter(String databaseName, String tableName, List<String> columnNames, TupleDomain<String> partitionKeysFilter)	Return a list of partition names, with optional filtering (hint to improve performance if possible).
Map<String,Optional<Partition>>	getPartitionsByNames(Table table, List<String> partitionNames)
Map<String,PartitionStatistics>	getPartitionStatistics(Table table, List<Partition> partitions)
Set<ColumnStatisticType>	getSupportedColumnStatistics(Type type)
Optional<Table>	getTable(String databaseName, String tableName)
PartitionStatistics	getTableStatistics(Table table)
List<String>	getTablesWithParameter(String databaseName, String parameterKey, String parameterValue)
default String	getValidWriteIds(List<SchemaTableName> tables, long currentTransactionId)
void	grantRoles(Set<String> roles, Set<HivePrincipal> grantees, boolean adminOption, HivePrincipal grantor)
void	grantTablePrivileges(String databaseName, String tableName, String tableOwner, HivePrincipal grantee, HivePrincipal grantor, Set<HivePrivilegeInfo.HivePrivilege> privileges, boolean grantOption)
Set<RoleGrant>	listGrantedPrincipals(String role)
Set<RoleGrant>	listRoleGrants(HivePrincipal principal)
Set<String>	listRoles()
Set<HivePrivilegeInfo>	listTablePrivileges(String databaseName, String tableName, Optional<String> tableOwner, Optional<HivePrincipal> principal)
default long	openTransaction(AcidTransactionOwner transactionOwner)
void	renameColumn(String databaseName, String tableName, String oldColumnName, String newColumnName)
void	renameDatabase(String databaseName, String newDatabaseName)
void	renameTable(String databaseName, String tableName, String newDatabaseName, String newTableName)
void	replaceTable(String databaseName, String tableName, Table newTable, PrincipalPrivileges principalPrivileges)	This should only be used if the semantic here is drop and add.
void	revokeRoles(Set<String> roles, Set<HivePrincipal> grantees, boolean adminOption, HivePrincipal grantor)
void	revokeTablePrivileges(String databaseName, String tableName, String tableOwner, HivePrincipal grantee, HivePrincipal grantor, Set<HivePrivilegeInfo.HivePrivilege> privileges, boolean grantOption)
default void	sendTransactionHeartbeat(long transactionId)
void	setDatabaseOwner(String databaseName, HivePrincipal principal)
void	setTableOwner(String databaseName, String tableName, HivePrincipal principal)
default void	updatePartitionStatistics(Table table, String partitionName, Function<PartitionStatistics,PartitionStatistics> update)
void	updatePartitionStatistics(Table table, Map<String,Function<PartitionStatistics,PartitionStatistics>> updates)
void	updateTableStatistics(String databaseName, String tableName, AcidTransaction transaction, Function<PartitionStatistics,PartitionStatistics> update)
default void	updateTableWriteId(String dbName, String tableName, long transactionId, long writeId, OptionalLong rowCountChange)

Method Detail

getDatabase

Optional<Database> getDatabase(String databaseName)

getAllDatabases

List<String> getAllDatabases()

getTable

Optional<Table> getTable(String databaseName,
                         String tableName)

getSupportedColumnStatistics

Set<ColumnStatisticType> getSupportedColumnStatistics(Type type)

getTableStatistics

PartitionStatistics getTableStatistics(Table table)

getPartitionStatistics

Map<String,PartitionStatistics> getPartitionStatistics(Table table,
                                                             List<Partition> partitions)

updateTableStatistics

void updateTableStatistics(String databaseName,
                           String tableName,
                           AcidTransaction transaction,
                           Function<PartitionStatistics,PartitionStatistics> update)

updatePartitionStatistics

default void updatePartitionStatistics(Table table,
                                       String partitionName,
                                       Function<PartitionStatistics,PartitionStatistics> update)

updatePartitionStatistics

void updatePartitionStatistics(Table table,
                               Map<String,Function<PartitionStatistics,PartitionStatistics>> updates)

getAllTables

List<String> getAllTables(String databaseName)

getTablesWithParameter

List<String> getTablesWithParameter(String databaseName,
                                    String parameterKey,
                                    String parameterValue)

getAllViews

List<String> getAllViews(String databaseName)

createDatabase

void createDatabase(Database database)

dropDatabase

void dropDatabase(String databaseName,
                  boolean deleteData)

renameDatabase

void renameDatabase(String databaseName,
                    String newDatabaseName)

setDatabaseOwner

void setDatabaseOwner(String databaseName,
                      HivePrincipal principal)

createTable

void createTable(Table table,
                 PrincipalPrivileges principalPrivileges)

dropTable

void dropTable(String databaseName,
               String tableName,
               boolean deleteData)

replaceTable

void replaceTable(String databaseName,
                  String tableName,
                  Table newTable,
                  PrincipalPrivileges principalPrivileges)

This should only be used if the semantic here is drop and add. Trying to alter one field of a table object previously acquired from getTable is probably not what you want.

renameTable

void renameTable(String databaseName,
                 String tableName,
                 String newDatabaseName,
                 String newTableName)

commentTable

void commentTable(String databaseName,
                  String tableName,
                  Optional<String> comment)

setTableOwner

void setTableOwner(String databaseName,
                   String tableName,
                   HivePrincipal principal)

commentColumn

void commentColumn(String databaseName,
                   String tableName,
                   String columnName,
                   Optional<String> comment)

addColumn

void addColumn(String databaseName,
               String tableName,
               String columnName,
               HiveType columnType,
               String columnComment)

renameColumn

void renameColumn(String databaseName,
                  String tableName,
                  String oldColumnName,
                  String newColumnName)

dropColumn

void dropColumn(String databaseName,
                String tableName,
                String columnName)

getPartition

Optional<Partition> getPartition(Table table,
                                 List<String> partitionValues)

getPartitionNamesByFilter

Optional<List<String>> getPartitionNamesByFilter(String databaseName,
                                                 String tableName,
                                                 List<String> columnNames,
                                                 TupleDomain<String> partitionKeysFilter)

Return a list of partition names, with optional filtering (hint to improve performance if possible).

Parameters:

databaseName - the name of the database

tableName - the name of the table

columnNames - the list of partition column names

partitionKeysFilter - optional filter for the partition column values

Returns:

a list of partition names as created by MetastoreUtil.toPartitionName(java.util.List<java.lang.String>, java.util.List<java.lang.String>)

See Also:

TupleDomain

getPartitionsByNames

Map<String,Optional<Partition>> getPartitionsByNames(Table table,
                                                           List<String> partitionNames)

addPartitions

void addPartitions(String databaseName,
                   String tableName,
                   List<PartitionWithStatistics> partitions)

dropPartition

void dropPartition(String databaseName,
                   String tableName,
                   List<String> parts,
                   boolean deleteData)

alterPartition

void alterPartition(String databaseName,
                    String tableName,
                    PartitionWithStatistics partition)

createRole

void createRole(String role,
                String grantor)

dropRole

void dropRole(String role)

listRoles

Set<String> listRoles()

grantRoles

void grantRoles(Set<String> roles,
                Set<HivePrincipal> grantees,
                boolean adminOption,
                HivePrincipal grantor)

revokeRoles

void revokeRoles(Set<String> roles,
                 Set<HivePrincipal> grantees,
                 boolean adminOption,
                 HivePrincipal grantor)

listGrantedPrincipals

Set<RoleGrant> listGrantedPrincipals(String role)

listRoleGrants

Set<RoleGrant> listRoleGrants(HivePrincipal principal)

grantTablePrivileges

void grantTablePrivileges(String databaseName,
                          String tableName,
                          String tableOwner,
                          HivePrincipal grantee,
                          HivePrincipal grantor,
                          Set<HivePrivilegeInfo.HivePrivilege> privileges,
                          boolean grantOption)

revokeTablePrivileges

void revokeTablePrivileges(String databaseName,
                           String tableName,
                           String tableOwner,
                           HivePrincipal grantee,
                           HivePrincipal grantor,
                           Set<HivePrivilegeInfo.HivePrivilege> privileges,
                           boolean grantOption)

listTablePrivileges

Set<HivePrivilegeInfo> listTablePrivileges(String databaseName,
                                           String tableName,
                                           Optional<String> tableOwner,
                                           Optional<HivePrincipal> principal)

Parameters:

tableOwner -

principal - when empty, all table privileges are returned

openTransaction

default long openTransaction(AcidTransactionOwner transactionOwner)

commitTransaction

default void commitTransaction(long transactionId)

abortTransaction

default void abortTransaction(long transactionId)

sendTransactionHeartbeat

default void sendTransactionHeartbeat(long transactionId)

acquireSharedReadLock

default void acquireSharedReadLock(AcidTransactionOwner transactionOwner,
                                   String queryId,
                                   long transactionId,
                                   List<SchemaTableName> fullTables,
                                   List<HivePartition> partitions)

getValidWriteIds

default String getValidWriteIds(List<SchemaTableName> tables,
                                long currentTransactionId)

getConfigValue

default Optional<String> getConfigValue(String name)

allocateWriteId

default long allocateWriteId(String dbName,
                             String tableName,
                             long transactionId)

acquireTableWriteLock

default void acquireTableWriteLock(AcidTransactionOwner transactionOwner,
                                   String queryId,
                                   long transactionId,
                                   String dbName,
                                   String tableName,
                                   org.apache.hadoop.hive.metastore.api.DataOperationType operation,
                                   boolean isDynamicPartitionWrite)

updateTableWriteId

default void updateTableWriteId(String dbName,
                                String tableName,
                                long transactionId,
                                long writeId,
                                OptionalLong rowCountChange)

alterPartitions

default void alterPartitions(String dbName,
                             String tableName,
                             List<Partition> partitions,
                             long writeId)

addDynamicPartitions

default void addDynamicPartitions(String dbName,
                                  String tableName,
                                  List<String> partitionNames,
                                  long transactionId,
                                  long writeId,
                                  AcidOperation operation)

alterTransactionalTable

default void alterTransactionalTable(Table table,
                                     long transactionId,
                                     long writeId,
                                     PrincipalPrivileges principalPrivileges)