Package org.apache.gravitino

Interface CatalogProvider

@Evolving public interface CatalogProvider
A Catalog provider is a class that provides a short name for a catalog. This short name is used when creating a catalog.

There are two kinds of catalogs in Gravitino, one is managed catalog and another is external catalog.

Managed catalog: A catalog and its subsidiary objects are all managed by Gravitino. Gravitino takes care of the lifecycle of the catalog and its objects. For those catalogs, Gravitino uses the type of the catalog as the provider short name. Note that for each catalog type, there is only one implementation of managed catalog for that type. Currently, Gravitino has model and fileset catalogs that are managed catalogs.

External catalog: A catalog its subsidiary objects are stored by an external sources, such as Hive catalog, the DB and tables are stored in HMS. For those catalogs, Gravitino uses a unique name as the provider short name to load the catalog. For example, Hive catalog uses "hive" as the provider short name.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    shortName()
    The string that represents the catalog that this provider uses.
    static String
    shortNameForManagedCatalog(Catalog.Type type)
    Form the provider short name for a managed catalog.

  • Method Details

    • shortNameForManagedCatalog

      static String shortNameForManagedCatalog(Catalog.Type type)
      Form the provider short name for a managed catalog. The provider short name for a managed catalog is the catalog type in lowercase.
      Parameters:
      type - The catalog type.
      Returns:
      The provider short name for the managed catalog.

    • shortName

      String shortName()
      The string that represents the catalog that this provider uses. This is overridden by children to provide a nice alias for the catalog.
      Returns:
      The string that represents the catalog that this provider uses.