org.apache.hadoop.hive.metastore

Interface MetaStoreFilterHook

All Known Implementing Classes:

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

Modifier and Type	Method and Description
default Catalog	filterCatalog(Catalog catalog) Filter a catalog object.
default List<String>	filterCatalogs(List<String> catalogs) Filter a list of catalog names.
Database	filterDatabase(Database dataBase) filter to given database object if applicable
List<String>	filterDatabases(List<String> dbList) Filter given list of databases
List<String>	filterDataConnectors(List<String> dcList) Filter given list of data connectors
Partition	filterPartition(Partition partition) filter to given partition object if applicable
List<String>	filterPartitionNames(String catName, 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<TableMeta>	filterTableMetas(List<TableMeta> tableMetas) Filter a list of TableMeta objects.
List<TableMeta>	filterTableMetas(String catName, String dbName, List<TableMeta> tableMetas) Deprecated. Replaced by filterTableMetas(List)
List<String>	filterTableNames(String catName, String dbName, List<String> tableList) Filter given list of tables
List<Table>	filterTables(List<Table> tableList) Filter given list of tables

Method Detail

filterCatalog

default Catalog filterCatalog(Catalog catalog)
                       throws MetaException

Filter a catalog object. Default implementation returns the passed in catalog.

Parameters:

catalog - catalog to filter

Returns:

filtered catalog

Throws:

MetaException - something bad happened

filterCatalogs

default List<String> filterCatalogs(List<String> catalogs)
                             throws MetaException

Filter a list of catalog names. Default implementation returns the passed in list.

Parameters:

catalogs - list of catalog names.

Returns:

filtered list of catalog names.

Throws:

MetaException - something bad happened.

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 catName,
                              String dbName,
                              List<String> tableList)
                       throws MetaException

Filter given list of tables

Parameters:

catName - catalog name

dbName - database name

tableList - list of table returned by the metastore

Returns:

List of filtered table names

Throws:

MetaException

filterTableMetas

@Deprecated
List<TableMeta> filterTableMetas(String catName,
                                             String dbName,
                                             List<TableMeta> tableMetas)
                                      throws MetaException

Deprecated. Replaced by filterTableMetas(List)

Filter given list of TableMeta objects

Parameters:

catName - catalog name

dbName - database name

tableMetas - list of table returned by the metastore

Returns:

List of filtered table names

Throws:

MetaException

filterTableMetas

List<TableMeta> filterTableMetas(List<TableMeta> tableMetas)
                          throws MetaException

Filter a list of TableMeta objects.

Parameters:

tableMetas - list of TableMetas to filter

Returns:

filtered table metas

Throws:

MetaException - something went wrong

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:

tableList -

Returns:

List of filtered table names

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 catName,
                                  String dbName,
                                  String tblName,
                                  List<String> partitionNames)
                           throws MetaException

Filter given list of partition names

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

partitionNames - list of partition names.

Returns:

list of filtered partition names.

Throws:

MetaException

filterDataConnectors

List<String> filterDataConnectors(List<String> dcList)
                           throws MetaException

Filter given list of data connectors

Parameters:

dcList -

Returns:

List of filtered Dc names

Throws:

MetaException