Class HiveCatalog

    • Field Detail

      • LIST_ALL_TABLES_DEFAULT

        public static final java.lang.String LIST_ALL_TABLES_DEFAULT
        See Also:
        Constant Field Values
    • Constructor Detail

      • HiveCatalog

        public HiveCatalog()
    • Method Detail

      • initialize

        public void initialize​(java.lang.String inputName,
                               java.util.Map<java.lang.String,​java.lang.String> properties)
        Description copied from interface: Catalog
        Initialize a catalog given a custom name and a map of catalog properties.

        A custom Catalog implementation must have a no-arg constructor. A compute engine like Spark or Flink will first initialize the catalog without any arguments, and then call this method to complete catalog initialization with properties passed into the engine.

        Specified by:
        initialize in interface Catalog
        Parameters:
        inputName - a custom name for the catalog
        properties - catalog properties
      • listTables

        public java.util.List<TableIdentifier> listTables​(Namespace namespace)
        Description copied from interface: Catalog
        Return all the identifiers under this namespace.
        Specified by:
        listTables in interface Catalog
        Parameters:
        namespace - a namespace
        Returns:
        a list of identifiers for tables
      • name

        public java.lang.String name()
        Description copied from interface: Catalog
        Return the name for this catalog.
        Specified by:
        name in interface Catalog
        Returns:
        this catalog's name
      • dropTable

        public boolean dropTable​(TableIdentifier identifier,
                                 boolean purge)
        Description copied from interface: Catalog
        Drop a table; optionally delete data and metadata files.

        If purge is set to true the implementation should delete all data and metadata files.

        Specified by:
        dropTable in interface Catalog
        Parameters:
        identifier - a table identifier
        purge - if true, delete all data and metadata files in the table
        Returns:
        true if the table was dropped, false if the table did not exist
      • renameTable

        public void renameTable​(TableIdentifier from,
                                TableIdentifier originalTo)
        Description copied from interface: Catalog
        Rename a table.
        Specified by:
        renameTable in interface Catalog
        Parameters:
        from - identifier of the table to rename
        originalTo - new table name
      • registerTable

        public Table registerTable​(TableIdentifier identifier,
                                   java.lang.String metadataFileLocation)
        Description copied from interface: Catalog
        Register a table with the catalog if it does not exist.
        Specified by:
        registerTable in interface Catalog
        Parameters:
        identifier - a table identifier
        metadataFileLocation - the location of a metadata file
        Returns:
        a Table instance
      • createNamespace

        public void createNamespace​(Namespace namespace,
                                    java.util.Map<java.lang.String,​java.lang.String> meta)
        Description copied from interface: SupportsNamespaces
        Create a namespace in the catalog.
        Specified by:
        createNamespace in interface SupportsNamespaces
        Parameters:
        namespace - a multi-part namespace
        meta - a string Map of properties for the given namespace
      • dropNamespace

        public boolean dropNamespace​(Namespace namespace)
        Description copied from interface: SupportsNamespaces
        Drop a namespace. If the namespace exists and was dropped, this will return true.
        Specified by:
        dropNamespace in interface SupportsNamespaces
        Parameters:
        namespace - a namespace. Namespace
        Returns:
        true if the namespace was dropped, false otherwise.
      • setProperties

        public boolean setProperties​(Namespace namespace,
                                     java.util.Map<java.lang.String,​java.lang.String> properties)
        Description copied from interface: SupportsNamespaces
        Set a collection of properties on a namespace in the catalog.

        Properties that are not in the given map are not modified or removed by this method.

        Specified by:
        setProperties in interface SupportsNamespaces
        Parameters:
        namespace - a namespace. Namespace
        properties - a collection of metadata to apply to the namespace
      • removeProperties

        public boolean removeProperties​(Namespace namespace,
                                        java.util.Set<java.lang.String> properties)
        Description copied from interface: SupportsNamespaces
        Remove a set of property keys from a namespace in the catalog.

        Properties that are not in the given set are not modified or removed by this method.

        Specified by:
        removeProperties in interface SupportsNamespaces
        Parameters:
        namespace - a namespace. Namespace
        properties - a collection of metadata to apply to the namespace
      • loadNamespaceMetadata

        public java.util.Map<java.lang.String,​java.lang.String> loadNamespaceMetadata​(Namespace namespace)
        Description copied from interface: SupportsNamespaces
        Load metadata properties for a namespace.
        Specified by:
        loadNamespaceMetadata in interface SupportsNamespaces
        Parameters:
        namespace - a namespace. Namespace
        Returns:
        a string map of properties for the given namespace
      • setConf

        public void setConf​(org.apache.hadoop.conf.Configuration conf)
        Specified by:
        setConf in interface org.apache.hadoop.conf.Configurable
      • getConf

        public org.apache.hadoop.conf.Configuration getConf()
        Specified by:
        getConf in interface org.apache.hadoop.conf.Configurable