Package io.trino.plugin.hive.metastore.cache

Class CachingHiveMetastore

java.lang.Object

io.trino.plugin.hive.metastore.cache.CachingHiveMetastore

All Implemented Interfaces:

HiveMetastore

@ThreadSafe
public class CachingHiveMetastore
extends Object
implements HiveMetastore

Hive Metastore Cache

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CachingHiveMetastore.CachingHiveMetastoreBuilder
static enum	CachingHiveMetastore.StatsRecording

Field Summary

Fields

Modifier and Type	Field	Description
protected final HiveMetastore	delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CachingHiveMetastore(HiveMetastore delegate, boolean metadataCacheEnabled, boolean statsCacheEnabled, OptionalLong expiresAfterWriteMillis, OptionalLong statsExpiresAfterWriteMillis, OptionalLong refreshMills, Optional<Executor> executor, long maximumSize, CachingHiveMetastore.StatsRecording statsRecording, boolean cacheMissing, boolean partitionCacheEnabled)

Method Summary

Modifier and Type	Method	Description
void	abortTransaction(long transactionId)
void	acquireSharedReadLock(AcidTransactionOwner transactionOwner, String queryId, long transactionId, List<SchemaTableName> fullTables, List<HivePartition> partitions)
void	acquireTableWriteLock(AcidTransactionOwner transactionOwner, String queryId, long transactionId, String dbName, String tableName, io.trino.hive.thrift.metastore.DataOperationType operation, boolean isDynamicPartitionWrite)
void	addColumn(String databaseName, String tableName, String columnName, HiveType columnType, String columnComment)
void	addDynamicPartitions(String dbName, String tableName, List<String> partitionNames, long transactionId, long writeId, AcidOperation operation)
void	addPartitions(String databaseName, String tableName, List<PartitionWithStatistics> partitions)
long	allocateWriteId(String dbName, String tableName, long transactionId)
void	alterPartition(String databaseName, String tableName, PartitionWithStatistics partition)
void	alterPartitions(String dbName, String tableName, List<Partition> partitions, long writeId)
void	alterTransactionalTable(Table table, long transactionId, long writeId, PrincipalPrivileges principalPrivileges)
static CachingHiveMetastore.CachingHiveMetastoreBuilder	builder()
static CachingHiveMetastore.CachingHiveMetastoreBuilder	builder(CachingHiveMetastore.CachingHiveMetastoreBuilder other)
void	checkSupportsTransactions()
void	commentColumn(String databaseName, String tableName, String columnName, Optional<String> comment)
void	commentTable(String databaseName, String tableName, Optional<String> comment)
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)
void	flushCache()
void	flushPartitionCache(String schemaName, String tableName, List<String> partitionColumns, List<String> partitionValues)
List<String>	getAllDatabases()
io.airlift.jmx.CacheStatsMBean	getAllTableNamesStats()
Optional<List<SchemaTableName>>	getAllTables()
List<String>	getAllTables(String databaseName)
io.airlift.jmx.CacheStatsMBean	getAllViewNamesStats()
Optional<List<SchemaTableName>>	getAllViews()
List<String>	getAllViews(String databaseName)	Lists views and materialized views from given database.
Optional<String>	getConfigValue(String name)
io.airlift.jmx.CacheStatsMBean	getConfigValuesStats()
Optional<Database>	getDatabase(String databaseName)
io.airlift.jmx.CacheStatsMBean	getDatabaseNamesStats()
io.airlift.jmx.CacheStatsMBean	getDatabaseStats()
io.airlift.jmx.CacheStatsMBean	getGrantedPrincipalsStats()
Optional<Partition>	getPartition(Table table, List<String> partitionValues)
io.airlift.jmx.CacheStatsMBean	getPartitionFilterStats()
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)	The method will cache and return columns specified in the Table.getDataColumns() but may return more if other columns are already cached for a given partition.
io.airlift.jmx.CacheStatsMBean	getPartitionStatisticsStats()
io.airlift.jmx.CacheStatsMBean	getPartitionStats()
io.airlift.jmx.CacheStatsMBean	getRoleGrantsStats()
io.airlift.jmx.CacheStatsMBean	getRolesStats()
Set<HiveColumnStatisticType>	getSupportedColumnStatistics(Type type)
Optional<Table>	getTable(String databaseName, String tableName)
io.airlift.jmx.CacheStatsMBean	getTableNamesStats()
io.airlift.jmx.CacheStatsMBean	getTablePrivilegesStats()
PartitionStatistics	getTableStatistics(Table table)	The method will cache and return columns specified in the Table.getDataColumns() but may return more if other columns are already cached.
io.airlift.jmx.CacheStatsMBean	getTableStatisticsStats()
io.airlift.jmx.CacheStatsMBean	getTableStats()
List<String>	getTablesWithParameter(String databaseName, String parameterKey, String parameterValue)
io.airlift.jmx.CacheStatsMBean	getTableWithParameterStats()
String	getValidWriteIds(List<SchemaTableName> tables, long currentTransactionId)
io.airlift.jmx.CacheStatsMBean	getViewNamesStats()
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)
protected void	invalidateDatabase(String databaseName)
void	invalidateTable(String databaseName, String tableName)
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)
static CachingHiveMetastore	memoizeMetastore(HiveMetastore delegate, long maximumSize)
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)
void	sendTransactionHeartbeat(long transactionId)
void	setDatabaseOwner(String databaseName, HivePrincipal principal)
void	setTableOwner(String databaseName, String tableName, HivePrincipal principal)
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)
void	updateTableWriteId(String dbName, String tableName, long transactionId, long writeId, OptionalLong rowCountChange)

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected final HiveMetastore delegate

Constructor Details

CachingHiveMetastore

protected CachingHiveMetastore(HiveMetastore delegate,
 boolean metadataCacheEnabled,
 boolean statsCacheEnabled,
 OptionalLong expiresAfterWriteMillis,
 OptionalLong statsExpiresAfterWriteMillis,
 OptionalLong refreshMills,
 Optional<Executor> executor,
 long maximumSize,
 CachingHiveMetastore.StatsRecording statsRecording,
 boolean cacheMissing,
 boolean partitionCacheEnabled)

Method Details

builder

public static CachingHiveMetastore.CachingHiveMetastoreBuilder builder()

builder

public static CachingHiveMetastore.CachingHiveMetastoreBuilder builder(CachingHiveMetastore.CachingHiveMetastoreBuilder other)

memoizeMetastore

public static CachingHiveMetastore memoizeMetastore(HiveMetastore delegate,
 long maximumSize)

flushCache

public void flushCache()

flushPartitionCache

public void flushPartitionCache(String schemaName,
 String tableName,
 List<String> partitionColumns,
 List<String> partitionValues)

getDatabase

public Optional<Database> getDatabase(String databaseName)

Specified by:

getDatabase in interface HiveMetastore

getAllDatabases

public List<String> getAllDatabases()

Specified by:

getAllDatabases in interface HiveMetastore

getTable

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

Specified by:

getTable in interface HiveMetastore

getSupportedColumnStatistics

public Set<HiveColumnStatisticType> getSupportedColumnStatistics(Type type)

Specified by:

getSupportedColumnStatistics in interface HiveMetastore

getTableStatistics

public PartitionStatistics getTableStatistics(Table table)

The method will cache and return columns specified in the Table.getDataColumns() but may return more if other columns are already cached.

Specified by:

getTableStatistics in interface HiveMetastore

getPartitionStatistics

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

The method will cache and return columns specified in the Table.getDataColumns() but may return more if other columns are already cached for a given partition.

Specified by:

getPartitionStatistics in interface HiveMetastore

updateTableStatistics

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

Specified by:

updateTableStatistics in interface HiveMetastore

updatePartitionStatistics

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

Specified by:

updatePartitionStatistics in interface HiveMetastore

updatePartitionStatistics

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

Specified by:

updatePartitionStatistics in interface HiveMetastore

getAllTables

public List<String> getAllTables(String databaseName)

Specified by:

getAllTables in interface HiveMetastore

getAllTables

public Optional<List<SchemaTableName>> getAllTables()

Specified by:

getAllTables in interface HiveMetastore

Returns:

List of tables, views and materialized views names from all schemas or Optional.empty if operation is not supported

getTablesWithParameter

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

Specified by:

getTablesWithParameter in interface HiveMetastore

getAllViews

public List<String> getAllViews(String databaseName)

Description copied from interface: HiveMetastore

Lists views and materialized views from given database.

Specified by:

getAllViews in interface HiveMetastore

getAllViews

public Optional<List<SchemaTableName>> getAllViews()

Specified by:

getAllViews in interface HiveMetastore

Returns:

List of views including materialized views names from all schemas or Optional.empty if operation is not supported

createDatabase

public void createDatabase(Database database)

Specified by:

createDatabase in interface HiveMetastore

dropDatabase

public void dropDatabase(String databaseName,
 boolean deleteData)

Specified by:

dropDatabase in interface HiveMetastore

renameDatabase

public void renameDatabase(String databaseName,
 String newDatabaseName)

Specified by:

renameDatabase in interface HiveMetastore

setDatabaseOwner

public void setDatabaseOwner(String databaseName,
 HivePrincipal principal)

Specified by:

setDatabaseOwner in interface HiveMetastore

invalidateDatabase

protected void invalidateDatabase(String databaseName)

createTable

public void createTable(Table table,
 PrincipalPrivileges principalPrivileges)

Specified by:

createTable in interface HiveMetastore

dropTable

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

Specified by:

dropTable in interface HiveMetastore

replaceTable

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

Description copied from interface: HiveMetastore

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.

Specified by:

replaceTable in interface HiveMetastore

renameTable

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

Specified by:

renameTable in interface HiveMetastore

commentTable

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

Specified by:

commentTable in interface HiveMetastore

setTableOwner

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

Specified by:

setTableOwner in interface HiveMetastore

commentColumn

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

Specified by:

commentColumn in interface HiveMetastore

addColumn

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

Specified by:

addColumn in interface HiveMetastore

renameColumn

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

Specified by:

renameColumn in interface HiveMetastore

dropColumn

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

Specified by:

dropColumn in interface HiveMetastore

invalidateTable

public void invalidateTable(String databaseName,
 String tableName)

getPartition

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

Specified by:

getPartition in interface HiveMetastore

getPartitionNamesByFilter

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

Description copied from interface: HiveMetastore

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

Specified by:

getPartitionNamesByFilter in interface HiveMetastore

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

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

Specified by:

getPartitionsByNames in interface HiveMetastore

addPartitions

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

Specified by:

addPartitions in interface HiveMetastore

dropPartition

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

Specified by:

dropPartition in interface HiveMetastore

alterPartition

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

Specified by:

alterPartition in interface HiveMetastore

createRole

public void createRole(String role,
 String grantor)

Specified by:

createRole in interface HiveMetastore

dropRole

public void dropRole(String role)

Specified by:

dropRole in interface HiveMetastore

listRoles

public Set<String> listRoles()

Specified by:

listRoles in interface HiveMetastore

grantRoles

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

Specified by:

grantRoles in interface HiveMetastore

revokeRoles

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

Specified by:

revokeRoles in interface HiveMetastore

listGrantedPrincipals

public Set<RoleGrant> listGrantedPrincipals(String role)

Specified by:

listGrantedPrincipals in interface HiveMetastore

listRoleGrants

public Set<RoleGrant> listRoleGrants(HivePrincipal principal)

Specified by:

listRoleGrants in interface HiveMetastore

grantTablePrivileges

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

Specified by:

grantTablePrivileges in interface HiveMetastore

revokeTablePrivileges

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

Specified by:

revokeTablePrivileges in interface HiveMetastore

listTablePrivileges

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

Specified by:

listTablePrivileges in interface HiveMetastore

principal - when empty, all table privileges are returned

getConfigValue

public Optional<String> getConfigValue(String name)

Specified by:

getConfigValue in interface HiveMetastore

checkSupportsTransactions

public void checkSupportsTransactions()

Specified by:

checkSupportsTransactions in interface HiveMetastore

openTransaction

public long openTransaction(AcidTransactionOwner transactionOwner)

Specified by:

openTransaction in interface HiveMetastore

commitTransaction

public void commitTransaction(long transactionId)

Specified by:

commitTransaction in interface HiveMetastore

abortTransaction

public void abortTransaction(long transactionId)

Specified by:

abortTransaction in interface HiveMetastore

sendTransactionHeartbeat

public void sendTransactionHeartbeat(long transactionId)

Specified by:

sendTransactionHeartbeat in interface HiveMetastore

acquireSharedReadLock

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

Specified by:

acquireSharedReadLock in interface HiveMetastore

getValidWriteIds

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

Specified by:

getValidWriteIds in interface HiveMetastore

allocateWriteId

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

Specified by:

allocateWriteId in interface HiveMetastore

acquireTableWriteLock

public void acquireTableWriteLock(AcidTransactionOwner transactionOwner,
 String queryId,
 long transactionId,
 String dbName,
 String tableName,
 io.trino.hive.thrift.metastore.DataOperationType operation,
 boolean isDynamicPartitionWrite)

Specified by:

acquireTableWriteLock in interface HiveMetastore

updateTableWriteId

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

Specified by:

updateTableWriteId in interface HiveMetastore

alterPartitions

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

Specified by:

alterPartitions in interface HiveMetastore

addDynamicPartitions

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

Specified by:

addDynamicPartitions in interface HiveMetastore

alterTransactionalTable

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

Specified by:

alterTransactionalTable in interface HiveMetastore

getDatabaseStats

public io.airlift.jmx.CacheStatsMBean getDatabaseStats()

getDatabaseNamesStats

public io.airlift.jmx.CacheStatsMBean getDatabaseNamesStats()

getTableStats

public io.airlift.jmx.CacheStatsMBean getTableStats()

getTableNamesStats

public io.airlift.jmx.CacheStatsMBean getTableNamesStats()

getAllTableNamesStats

public io.airlift.jmx.CacheStatsMBean getAllTableNamesStats()

getTableWithParameterStats

public io.airlift.jmx.CacheStatsMBean getTableWithParameterStats()

getTableStatisticsStats

public io.airlift.jmx.CacheStatsMBean getTableStatisticsStats()

getPartitionStatisticsStats

public io.airlift.jmx.CacheStatsMBean getPartitionStatisticsStats()

getViewNamesStats

public io.airlift.jmx.CacheStatsMBean getViewNamesStats()

getAllViewNamesStats

public io.airlift.jmx.CacheStatsMBean getAllViewNamesStats()

getPartitionStats

public io.airlift.jmx.CacheStatsMBean getPartitionStats()

getPartitionFilterStats

public io.airlift.jmx.CacheStatsMBean getPartitionFilterStats()

getTablePrivilegesStats

public io.airlift.jmx.CacheStatsMBean getTablePrivilegesStats()

getRolesStats

public io.airlift.jmx.CacheStatsMBean getRolesStats()

getRoleGrantsStats

public io.airlift.jmx.CacheStatsMBean getRoleGrantsStats()

getGrantedPrincipalsStats

public io.airlift.jmx.CacheStatsMBean getGrantedPrincipalsStats()

getConfigValuesStats

public io.airlift.jmx.CacheStatsMBean getConfigValuesStats()