Package org.apache.iceberg.nessie

Class NessieCatalog

java.lang.Object

org.apache.iceberg.BaseMetastoreCatalog

org.apache.iceberg.nessie.NessieCatalog

All Implemented Interfaces:

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

public class NessieCatalog
extends BaseMetastoreCatalog
implements java.lang.AutoCloseable, SupportsNamespaces, org.apache.hadoop.conf.Configurable

Nessie implementation of Iceberg Catalog.

A note on namespaces: Nessie namespaces are implicit and do not need to be explicitly created or deleted. The create and delete namespace methods are no-ops for the NessieCatalog. One can still list namespaces that have objects stored in them to assist with namespace-centric catalog exploration.

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	Description
NessieCatalog()

Method Summary

Modifier and Type	Method	Description
void	close()
void	createNamespace(Namespace namespace, java.util.Map<java.lang.String,java.lang.String> metadata)	Create a namespace in the catalog.
protected java.lang.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.
org.apache.hadoop.conf.Configuration	getConf()
void	initialize(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> options)	Initialize a catalog given a custom name and a map of catalog properties.
void	initialize(java.lang.String name, NessieIcebergClient client, FileIO fileIO, java.util.Map<java.lang.String,java.lang.String> catalogOptions)	An alternative way to initialize the catalog using a pre-configured NessieIcebergClient and FileIO instance.
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 the given namespace but return an empty map because namespace properties are currently not supported.
java.lang.String	name()	Return the name for this catalog.
protected TableOperations	newTableOps(TableIdentifier tableIdentifier)
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 to)	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)	Set a collection of properties on a namespace in the catalog.

Methods inherited from class org.apache.iceberg.BaseMetastoreCatalog

buildTable, fullTableName, isValidIdentifier, loadTable, properties, 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, registerTable, tableExists

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

createNamespace, listNamespaces, namespaceExists

Constructor Detail

NessieCatalog

public NessieCatalog()

Method Detail

initialize

public void initialize(java.lang.String name,
                       java.util.Map<java.lang.String,java.lang.String> options)

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:

name - a custom name for the catalog

options - catalog properties

initialize

public void initialize(java.lang.String name,
                       NessieIcebergClient client,
                       FileIO fileIO,
                       java.util.Map<java.lang.String,java.lang.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 java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

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

newTableOps

protected TableOperations newTableOps(TableIdentifier tableIdentifier)

Specified by:

newTableOps in class BaseMetastoreCatalog

defaultWarehouseLocation

protected java.lang.String defaultWarehouseLocation(TableIdentifier table)

Specified by:

defaultWarehouseLocation in class BaseMetastoreCatalog

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

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,
                            java.util.Map<java.lang.String,java.lang.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 java.util.List<Namespace> listNamespaces(Namespace namespace)
                                         throws NoSuchNamespaceException

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

Throws:

NoSuchNamespaceException - If the namespace does not exist (optional)

loadNamespaceMetadata

public java.util.Map<java.lang.String,java.lang.String> loadNamespaceMetadata(Namespace namespace)
                                                                             throws NoSuchNamespaceException

Load the given namespace but return an empty map because namespace properties are currently not supported.

Specified by:

loadNamespaceMetadata in interface SupportsNamespaces

Parameters:

namespace - a namespace. Namespace

Returns:

an empty map

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,
                             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

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