Package org.apache.iceberg.flink

Class FlinkCatalogFactory

java.lang.Object

org.apache.iceberg.flink.FlinkCatalogFactory

All Implemented Interfaces:

org.apache.flink.table.factories.CatalogFactory, org.apache.flink.table.factories.Factory

public class FlinkCatalogFactory
extends Object
implements org.apache.flink.table.factories.CatalogFactory

A Flink Catalog factory implementation that creates FlinkCatalog.

This supports the following catalog configuration options:

• type - Flink catalog factory key, should be "iceberg"
• catalog-type - iceberg catalog type, "hive", "hadoop" or "rest"
• uri - the Hive Metastore URI (Hive catalog only)
• clients - the Hive Client Pool Size (Hive catalog only)
• warehouse - the warehouse path (Hadoop catalog only)
• default-database - a database name to use as the default
• base-namespace - a base namespace as the prefix for all databases (Hadoop catalog only)
• cache-enabled - whether to enable catalog cache

To use a custom catalog that is not a Hive or Hadoop catalog, extend this class and override createCatalogLoader(String, Map, Configuration).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.factories.CatalogFactory

org.apache.flink.table.factories.CatalogFactory.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_NAMESPACE
static final String	DEFAULT_CATALOG_NAME
static final String	DEFAULT_DATABASE
static final String	DEFAULT_DATABASE_NAME
static final String	FACTORY_IDENTIFIER
static final String	HADOOP_CONF_DIR
static final String	HIVE_CONF_DIR
static final String	ICEBERG_CATALOG_TYPE
static final String	ICEBERG_CATALOG_TYPE_HADOOP
static final String	ICEBERG_CATALOG_TYPE_HIVE
static final String	ICEBERG_CATALOG_TYPE_REST

Constructor Summary

Constructors

Constructor	Description
FlinkCatalogFactory()

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.conf.Configuration	clusterHadoopConf()
protected org.apache.flink.table.catalog.Catalog	createCatalog(String name, Map<String,String> properties, org.apache.hadoop.conf.Configuration hadoopConf)
org.apache.flink.table.catalog.Catalog	createCatalog(org.apache.flink.table.factories.CatalogFactory.Context context)
String	factoryIdentifier()
Set<org.apache.flink.configuration.ConfigOption<?>>	optionalOptions()
Set<org.apache.flink.configuration.ConfigOption<?>>	requiredOptions()

Methods inherited from class java.lang.Object

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

Field Details

FACTORY_IDENTIFIER

public static final String FACTORY_IDENTIFIER

See Also:

• Constant Field Values

ICEBERG_CATALOG_TYPE

public static final String ICEBERG_CATALOG_TYPE

See Also:

• Constant Field Values

ICEBERG_CATALOG_TYPE_HADOOP

public static final String ICEBERG_CATALOG_TYPE_HADOOP

See Also:

• Constant Field Values

ICEBERG_CATALOG_TYPE_HIVE

public static final String ICEBERG_CATALOG_TYPE_HIVE

See Also:

• Constant Field Values

ICEBERG_CATALOG_TYPE_REST

public static final String ICEBERG_CATALOG_TYPE_REST

See Also:

• Constant Field Values

HIVE_CONF_DIR

public static final String HIVE_CONF_DIR

See Also:

• Constant Field Values

HADOOP_CONF_DIR

public static final String HADOOP_CONF_DIR

See Also:

• Constant Field Values

DEFAULT_DATABASE

public static final String DEFAULT_DATABASE

See Also:

• Constant Field Values

DEFAULT_DATABASE_NAME

public static final String DEFAULT_DATABASE_NAME

See Also:

• Constant Field Values

DEFAULT_CATALOG_NAME

public static final String DEFAULT_CATALOG_NAME

See Also:

• Constant Field Values

BASE_NAMESPACE

public static final String BASE_NAMESPACE

See Also:

• Constant Field Values

Constructor Details

FlinkCatalogFactory

public FlinkCatalogFactory()

Method Details

factoryIdentifier

public String factoryIdentifier()

Specified by:

factoryIdentifier in interface org.apache.flink.table.factories.Factory

requiredOptions

public Set<org.apache.flink.configuration.ConfigOption<?>> requiredOptions()

Specified by:

requiredOptions in interface org.apache.flink.table.factories.Factory

optionalOptions

public Set<org.apache.flink.configuration.ConfigOption<?>> optionalOptions()

Specified by:

optionalOptions in interface org.apache.flink.table.factories.Factory

createCatalog

public org.apache.flink.table.catalog.Catalog createCatalog(org.apache.flink.table.factories.CatalogFactory.Context context)

Specified by:

createCatalog in interface org.apache.flink.table.factories.CatalogFactory

createCatalog

protected org.apache.flink.table.catalog.Catalog createCatalog(String name,
 Map<String,String> properties,
 org.apache.hadoop.conf.Configuration hadoopConf)

clusterHadoopConf

public static org.apache.hadoop.conf.Configuration clusterHadoopConf()