Package org.apache.iceberg.nessie

Class NessieCatalog

java.lang.Object

org.apache.iceberg.BaseMetastoreCatalog

org.apache.iceberg.view.BaseMetastoreViewCatalog

org.apache.iceberg.nessie.NessieCatalog

All Implemented Interfaces:

Closeable, AutoCloseable, Catalog, SupportsNamespaces, ViewCatalog, Configurable<Object>

public class NessieCatalog
extends BaseMetastoreViewCatalog
implements SupportsNamespaces, Configurable<Object>

Nessie implementation of Iceberg Catalog.

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

Constructor Summary

Constructors

Constructor	Description
NessieCatalog()

Method Summary

Modifier and Type	Method	Description
void	close()
void	createNamespace(Namespace namespace, Map<String,String> metadata)	Create a namespace in the catalog.
protected String	defaultWarehouseLocation(TableIdentifier table)
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.
void	initialize(String name, Map<String,String> options)	Initialize a view catalog given a custom name and a map of catalog properties.
void	initialize(String name, NessieIcebergClient client, FileIO fileIO, Map<String,String> catalogOptions)	An alternative way to initialize the catalog using a pre-configured NessieIcebergClient and FileIO instance.
List<Namespace>	listNamespaces(Namespace namespace)	List child namespaces from the namespace.
List<TableIdentifier>	listTables(Namespace namespace)	Return all the identifiers under this namespace.
List<TableIdentifier>	listViews(Namespace namespace)	Return all the identifiers under this namespace.
Map<String,String>	loadNamespaceMetadata(Namespace namespace)	Load the given namespace and return its properties.
String	name()	Return the name for this catalog.
protected TableOperations	newTableOps(TableIdentifier tableIdentifier)
protected ViewOperations	newViewOps(TableIdentifier identifier)
protected Map<String,String>	properties()
boolean	removeProperties(Namespace namespace, Set<String> properties)	Remove a set of property keys from a namespace in the catalog.
void	renameTable(TableIdentifier from, TableIdentifier to)	Rename a table.
void	renameView(TableIdentifier from, TableIdentifier to)	Rename a view.
void	setConf(Object conf)
boolean	setProperties(Namespace namespace, Map<String,String> properties)	Set a collection of properties on a namespace in the catalog.

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

buildTable, buildView, loadView

Methods inherited from class org.apache.iceberg.BaseMetastoreCatalog

fullTableName, isValidIdentifier, isValidMetadataIdentifier, loadTable, metricsReporter, registerTable, toString

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

Constructor Details

NessieCatalog

public NessieCatalog()

Method Details

initialize

public void initialize(String name,
 Map<String,String> options)

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:

name - a custom name for the catalog

options - catalog properties

initialize

public void initialize(String name,
 NessieIcebergClient client,
 FileIO fileIO,
 Map<String,String> catalogOptions)

An alternative way to initialize the catalog using a pre-configured NessieIcebergClient and FileIO instance.

Parameters:

name - The name of the catalog, defaults to "nessie" if null

client - The pre-configured NessieIcebergClient instance to use

fileIO - The FileIO instance to use

catalogOptions - The catalog options to use

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class BaseMetastoreCatalog

Throws:

IOException

name

public 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

newTableOps

protected TableOperations newTableOps(TableIdentifier tableIdentifier)

Specified by:

newTableOps in class BaseMetastoreCatalog

defaultWarehouseLocation

protected String defaultWarehouseLocation(TableIdentifier table)

Specified by:

defaultWarehouseLocation in class BaseMetastoreCatalog

listTables

public 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

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 to)

Description copied from interface: Catalog

Rename a table.

Specified by:

renameTable in interface Catalog

Parameters:

from - identifier of the table to rename

to - new table name

createNamespace

public void createNamespace(Namespace namespace,
 Map<String,String> metadata)

Description copied from interface: SupportsNamespaces

Create a namespace in the catalog.

Specified by:

createNamespace in interface SupportsNamespaces

Parameters:

namespace - a multi-part namespace

metadata - a string Map of properties for the given namespace

listNamespaces

public List<Namespace> listNamespaces(Namespace namespace)
                               throws NoSuchNamespaceException

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

Throws:

NoSuchNamespaceException - If the namespace does not exist (optional)

loadNamespaceMetadata

public Map<String,String> loadNamespaceMetadata(Namespace namespace)
                                         throws NoSuchNamespaceException

Load the given namespace and return its properties.

Specified by:

loadNamespaceMetadata in interface SupportsNamespaces

Parameters:

namespace - a namespace. Namespace

Returns:

a string map of properties for the given namespace

Throws:

NoSuchNamespaceException - If the namespace does not exist

dropNamespace

public boolean dropNamespace(Namespace namespace)
                      throws NamespaceNotEmptyException

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.

Throws:

NamespaceNotEmptyException - If the namespace is not empty

setProperties

public boolean setProperties(Namespace namespace,
 Map<String,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,
 Set<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

setConf

public void setConf(Object conf)

Specified by:

setConf in interface Configurable<Object>

properties

protected Map<String,String> properties()

Overrides:

properties in class BaseMetastoreCatalog

newViewOps

protected ViewOperations newViewOps(TableIdentifier identifier)

Specified by:

newViewOps in class BaseMetastoreViewCatalog

listViews

public 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

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

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