org.apache.iceberg.hive

Class HiveCatalog

java.lang.Object

org.apache.iceberg.BaseMetastoreCatalog

org.apache.iceberg.hive.HiveCatalog

All Implemented Interfaces:

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

public class HiveCatalog
extends BaseMetastoreCatalog
implements java.io.Closeable, SupportsNamespaces, org.apache.hadoop.conf.Configurable

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
HiveCatalog()
HiveCatalog(org.apache.hadoop.conf.Configuration conf)
HiveCatalog(java.lang.String name, java.lang.String uri, int clientPoolSize, org.apache.hadoop.conf.Configuration conf) Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0
HiveCatalog(java.lang.String name, java.lang.String uri, java.lang.String warehouse, int clientPoolSize, org.apache.hadoop.conf.Configuration conf) Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0
HiveCatalog(java.lang.String name, java.lang.String uri, java.lang.String warehouse, int clientPoolSize, org.apache.hadoop.conf.Configuration conf, java.util.Map<java.lang.String,java.lang.String> properties) Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0

Method Summary

Modifier and Type	Method and Description
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.
protected void	finalize()
org.apache.hadoop.conf.Configuration	getConf()
void	initialize(java.lang.String inputName, java.util.Map<java.lang.String,java.lang.String> properties) Initialize a catalog given a custom name and a map of catalog properties.
protected boolean	isValidIdentifier(TableIdentifier tableIdentifier)
java.util.List<Namespace>	listNamespaces(Namespace namespace) List namespaces from the namespace.
java.util.List<TableIdentifier>	listTables(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)
boolean	removeProperties(Namespace namespace, java.util.Set<java.lang.String> properties) Remove a set of metadata from a namespace in the catalog.
void	renameTable(TableIdentifier from, TableIdentifier originalTo) Rename a table.
void	setConf(org.apache.hadoop.conf.Configuration conf)
boolean	setProperties(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> properties) Apply a set of metadata to a namespace in the catalog.
java.lang.String	toString()

Methods inherited from class org.apache.iceberg.BaseMetastoreCatalog

buildTable, createTable, fullTableName, loadTable, newCreateTableTransaction, newReplaceTableTransaction

Methods inherited from class java.lang.Object

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

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

createNamespace, listNamespaces, namespaceExists

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

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

Constructor Detail

HiveCatalog

public HiveCatalog()

HiveCatalog

public HiveCatalog(org.apache.hadoop.conf.Configuration conf)

HiveCatalog

@Deprecated
public HiveCatalog(java.lang.String name,
                               java.lang.String uri,
                               int clientPoolSize,
                               org.apache.hadoop.conf.Configuration conf)

Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0

Hive Catalog constructor.

Parameters:

name - catalog name

uri - Hive metastore uri

clientPoolSize - size of client pool

conf - Hadoop Configuration

HiveCatalog

@Deprecated
public HiveCatalog(java.lang.String name,
                               java.lang.String uri,
                               java.lang.String warehouse,
                               int clientPoolSize,
                               org.apache.hadoop.conf.Configuration conf)

Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0

Hive Catalog constructor.

Parameters:

name - catalog name

uri - Hive metastore uri

warehouse - location of Hive warehouse

clientPoolSize - size of client pool

conf - Hadoop Configuration

HiveCatalog

@Deprecated
public HiveCatalog(java.lang.String name,
                               java.lang.String uri,
                               java.lang.String warehouse,
                               int clientPoolSize,
                               org.apache.hadoop.conf.Configuration conf,
                               java.util.Map<java.lang.String,java.lang.String> properties)

Deprecated. please use the no-arg constructor, setConf and initialize to construct the catalog. Will be removed in v0.12.0

Hive Catalog constructor.

Parameters:

name - catalog name

uri - Hive metastore uri

warehouse - location of Hive warehouse

clientPoolSize - size of client pool

conf - Hadoop Configuration

properties - extra Hive configuration properties

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

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 namespaces from the namespace.

For example, if table a.b.t exists, use 'SELECT NAMESPACE IN a' this method must return Namepace.of("a","b") Namespace.

Specified by:

listNamespaces in interface SupportsNamespaces

Returns:

a List of namespace Namespace names

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

Apply a set of metadata to a namespace in the catalog.

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 metadata from a namespace in the catalog.

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

defaultWarehouseLocation

protected java.lang.String defaultWarehouseLocation(TableIdentifier tableIdentifier)

Specified by:

defaultWarehouseLocation in class BaseMetastoreCatalog

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

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