Package org.apache.iceberg.hive

Class HiveCatalog

java.lang.Object

org.apache.iceberg.BaseMetastoreCatalog

org.apache.iceberg.view.BaseMetastoreViewCatalog

org.apache.iceberg.hive.HiveCatalog

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.conf.Configurable, Catalog, SupportsNamespaces, ViewCatalog

public class HiveCatalog
extends BaseMetastoreViewCatalog
implements SupportsNamespaces, org.apache.hadoop.conf.Configurable

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.iceberg.view.BaseMetastoreViewCatalog

BaseMetastoreViewCatalog.BaseMetastoreViewCatalogTableBuilder, BaseMetastoreViewCatalog.BaseViewBuilder

Nested classes/interfaces inherited from class org.apache.iceberg.BaseMetastoreCatalog

BaseMetastoreCatalog.BaseMetastoreCatalogTableBuilder

Nested classes/interfaces inherited from interface org.apache.iceberg.catalog.Catalog

Catalog.TableBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HMS_DB_OWNER
static java.lang.String	HMS_DB_OWNER_TYPE
static java.lang.String	HMS_TABLE_OWNER
static java.lang.String	LIST_ALL_TABLES
static java.lang.String	LIST_ALL_TABLES_DEFAULT

Constructor Summary

Constructors

Constructor	Description
HiveCatalog()

Method Summary

Modifier and Type	Method	Description
Catalog.TableBuilder	buildTable(TableIdentifier identifier, Schema schema)	/** Instantiate a builder to either create a table or start a create/replace transaction.
ViewBuilder	buildView(TableIdentifier identifier)	Instantiate a builder to create or replace a SQL view.
void	close()
void	createNamespace(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> meta)	Create a namespace in the catalog.
protected java.lang.String	defaultWarehouseLocation(TableIdentifier tableIdentifier)
boolean	dropNamespace(Namespace namespace)	Drop a namespace.
boolean	dropTable(TableIdentifier identifier, boolean purge)	Drop a table; optionally delete data and metadata files.
boolean	dropView(TableIdentifier identifier)	Drop a view.
org.apache.hadoop.conf.Configuration	getConf()
void	initialize(java.lang.String inputName, java.util.Map<java.lang.String,java.lang.String> properties)	Initialize a view catalog given a custom name and a map of catalog properties.
protected boolean	isValidIdentifier(TableIdentifier tableIdentifier)
java.util.List<Namespace>	listNamespaces(Namespace namespace)	List child namespaces from the namespace.
java.util.List<TableIdentifier>	listTables(Namespace namespace)	Return all the identifiers under this namespace.
java.util.List<TableIdentifier>	listViews(Namespace namespace)	Return all the identifiers under this namespace.
java.util.Map<java.lang.String,java.lang.String>	loadNamespaceMetadata(Namespace namespace)	Load metadata properties for a namespace.
java.lang.String	name()	Return the name for this catalog.
TableOperations	newTableOps(TableIdentifier tableIdentifier)
protected ViewOperations	newViewOps(TableIdentifier identifier)
protected java.util.Map<java.lang.String,java.lang.String>	properties()
boolean	removeProperties(Namespace namespace, java.util.Set<java.lang.String> properties)	Remove a set of property keys from a namespace in the catalog.
void	renameTable(TableIdentifier from, TableIdentifier originalTo)	Rename a table.
void	renameView(TableIdentifier from, TableIdentifier to)	Rename a view.
void	setConf(org.apache.hadoop.conf.Configuration conf)
boolean	setProperties(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> properties)	Set a collection of properties on a namespace in the catalog.
java.lang.String	toString()

Methods inherited from class org.apache.iceberg.view.BaseMetastoreViewCatalog

loadView

Methods inherited from class org.apache.iceberg.BaseMetastoreCatalog

fullTableName, loadTable, metricsReporter, registerTable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.catalog.Catalog

createTable, createTable, createTable, createTable, dropTable, invalidateTable, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newCreateTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, newReplaceTableTransaction, tableExists

Methods inherited from interface org.apache.iceberg.catalog.SupportsNamespaces

createNamespace, listNamespaces, namespaceExists

Methods inherited from interface org.apache.iceberg.catalog.ViewCatalog

invalidateView, viewExists

Field Detail

LIST_ALL_TABLES

public static final java.lang.String LIST_ALL_TABLES

See Also:

Constant Field Values

LIST_ALL_TABLES_DEFAULT

public static final java.lang.String LIST_ALL_TABLES_DEFAULT

See Also:

Constant Field Values

HMS_TABLE_OWNER

public static final java.lang.String HMS_TABLE_OWNER

See Also:

Constant Field Values

HMS_DB_OWNER

public static final java.lang.String HMS_DB_OWNER

See Also:

Constant Field Values

HMS_DB_OWNER_TYPE

public static final java.lang.String HMS_DB_OWNER_TYPE

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: ViewCatalog

Initialize a view catalog given a custom name and a map of catalog properties.

A custom view 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

Specified by:

initialize in interface ViewCatalog

Overrides:

initialize in class BaseMetastoreViewCatalog

Parameters:

inputName - a custom name for the catalog

properties - catalog properties

buildTable

public Catalog.TableBuilder buildTable(TableIdentifier identifier,
                                       Schema schema)

Description copied from interface: Catalog

/** Instantiate a builder to either create a table or start a create/replace transaction.

Specified by:

buildTable in interface Catalog

Overrides:

buildTable in class BaseMetastoreViewCatalog

Parameters:

identifier - a table identifier

schema - a schema

Returns:

the builder to create a table or start a create/replace transaction

buildView

public ViewBuilder buildView(TableIdentifier identifier)

Description copied from interface: ViewCatalog

Instantiate a builder to create or replace a SQL view.

Specified by:

buildView in interface ViewCatalog

Overrides:

buildView in class BaseMetastoreViewCatalog

Parameters:

identifier - a view identifier

Returns:

a view builder

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

listViews

public java.util.List<TableIdentifier> listViews(Namespace namespace)

Description copied from interface: ViewCatalog

Return all the identifiers under this namespace.

Specified by:

listViews in interface ViewCatalog

Parameters:

namespace - a namespace

Returns:

a list of identifiers for views

name

public java.lang.String name()

Description copied from interface: ViewCatalog

Return the name for this catalog.

Specified by:

name in interface Catalog

Specified by:

name in interface ViewCatalog

Overrides:

name in class BaseMetastoreViewCatalog

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

dropView

public boolean dropView(TableIdentifier identifier)

Description copied from interface: ViewCatalog

Drop a view.

Specified by:

dropView in interface ViewCatalog

Parameters:

identifier - a view identifier

Returns:

true if the view was dropped, false if the view 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

renameView

public void renameView(TableIdentifier from,
                       TableIdentifier to)

Description copied from interface: ViewCatalog

Rename a view.

Specified by:

renameView in interface ViewCatalog

Parameters:

from - identifier of the view to rename

to - new view identifier

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

listNamespaces

public java.util.List<Namespace> listNamespaces(Namespace namespace)

Description copied from interface: SupportsNamespaces

List child namespaces from the namespace.

For two existing tables named 'a.b.c.table' and 'a.b.d.table', this method returns:

• Given: Namespace.empty()
• Returns: Namespace.of("a")

• Given: Namespace.of("a")
• Returns: Namespace.of("a", "b")

• Given: Namespace.of("a", "b")
• Returns: Namespace.of("a", "b", "c") and Namespace.of("a", "b", "d")

• Given: Namespace.of("a", "b", "c")
• Returns: empty list, because there are no child namespaces

Specified by:

listNamespaces in interface SupportsNamespaces

Returns:

a List of child Namespace names from 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

isValidIdentifier

protected boolean isValidIdentifier(TableIdentifier tableIdentifier)

Overrides:

isValidIdentifier in class BaseMetastoreCatalog

newTableOps

public TableOperations newTableOps(TableIdentifier tableIdentifier)

Specified by:

newTableOps in class BaseMetastoreCatalog

newViewOps

protected ViewOperations newViewOps(TableIdentifier identifier)

Specified by:

newViewOps in class BaseMetastoreViewCatalog

defaultWarehouseLocation

protected java.lang.String defaultWarehouseLocation(TableIdentifier tableIdentifier)

Specified by:

defaultWarehouseLocation in class BaseMetastoreCatalog

toString

public java.lang.String toString()

Overrides:

toString in class BaseMetastoreCatalog

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

properties

protected java.util.Map<java.lang.String,java.lang.String> properties()

Overrides:

properties in class BaseMetastoreCatalog

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class BaseMetastoreCatalog

Throws:

java.io.IOException