org.apache.hadoop.hive.metastore

Interface MetaStoreFilterHook

All Known Implementing Classes:

AuthorizationMetaStoreFilterHook, DefaultMetaStoreFilterHookImpl

@InterfaceAudience.LimitedPrivate(value="Apache Sentry (Incubating)")
@InterfaceStability.Evolving
public interface MetaStoreFilterHook

Metadata filter hook for metastore client. This will be useful for authorization plugins on hiveserver2 to filter metadata results, especially in case of non-impersonation mode where the metastore doesn't know the end user's identity.

Method Summary

Methods

Modifier and Type	Method and Description
Database	filterDatabase(Database dataBase) filter to given database object if applicable
List<String>	filterDatabases(List<String> dbList) Filter given list of databases
Index	filterIndex(Index index)
List<Index>	filterIndexes(List<Index> indexeList) Filter given list of index objects
List<String>	filterIndexNames(String dbName, String tblName, List<String> indexList) Filter given list of index names
Partition	filterPartition(Partition partition) filter to given partition object if applicable
List<String>	filterPartitionNames(String dbName, String tblName, List<String> partitionNames) Filter given list of partition names
List<Partition>	filterPartitions(List<Partition> partitionList) Filter given list of partitions
List<PartitionSpec>	filterPartitionSpecs(List<PartitionSpec> partitionSpecList) Filter given list of partition specs
Table	filterTable(Table table) filter to given table object if applicable
List<String>	filterTableNames(String dbName, List<String> tableList) Filter given list of tables
List<Table>	filterTables(List<Table> tableList) Filter given list of tables

Method Detail

filterDatabases

List<String> filterDatabases(List<String> dbList)
                             throws MetaException

Filter given list of databases

Parameters:

dbList -

Returns:

List of filtered Db names

Throws:

MetaException

filterDatabase

Database filterDatabase(Database dataBase)
                        throws MetaException,
                               NoSuchObjectException

filter to given database object if applicable

Parameters:

dataBase -

Returns:

the same database if it's not filtered out

Throws:

NoSuchObjectException

MetaException

filterTableNames

List<String> filterTableNames(String dbName,
                            List<String> tableList)
                              throws MetaException

Filter given list of tables

Parameters:

dbName -

tableList -

Throws:

MetaException

filterTable

Table filterTable(Table table)
                  throws MetaException,
                         NoSuchObjectException

filter to given table object if applicable

Parameters:

table -

Returns:

the same table if it's not filtered out

Throws:

NoSuchObjectException

MetaException

filterTables

List<Table> filterTables(List<Table> tableList)
                         throws MetaException

Filter given list of tables

Parameters:

dbName -

tableList -

Throws:

MetaException

filterPartitions

List<Partition> filterPartitions(List<Partition> partitionList)
                                 throws MetaException

Filter given list of partitions

Parameters:

partitionList -

Returns:

Throws:

MetaException

filterPartitionSpecs

List<PartitionSpec> filterPartitionSpecs(List<PartitionSpec> partitionSpecList)
                                         throws MetaException

Filter given list of partition specs

Parameters:

partitionSpecList -

Returns:

Throws:

MetaException

filterPartition

Partition filterPartition(Partition partition)
                          throws MetaException,
                                 NoSuchObjectException

filter to given partition object if applicable

Parameters:

partition -

Returns:

the same partition object if it's not filtered out

Throws:

NoSuchObjectException

MetaException

filterPartitionNames

List<String> filterPartitionNames(String dbName,
                                String tblName,
                                List<String> partitionNames)
                                  throws MetaException

Filter given list of partition names

Parameters:

dbName -

tblName -

partitionNames -

Returns:

Throws:

MetaException

filterIndex

Index filterIndex(Index index)
                  throws MetaException,
                         NoSuchObjectException

Throws:

MetaException

NoSuchObjectException

filterIndexNames

List<String> filterIndexNames(String dbName,
                            String tblName,
                            List<String> indexList)
                              throws MetaException

Filter given list of index names

Parameters:

dbName -

tblName -

indexList -

Returns:

Throws:

MetaException

filterIndexes

List<Index> filterIndexes(List<Index> indexeList)
                          throws MetaException

Filter given list of index objects

Parameters:

indexeList -

Returns:

Throws:

MetaException