Package org.apache.flink.table.catalog

Class CatalogDescriptor

java.lang.Object

org.apache.flink.table.catalog.CatalogDescriptor

@PublicEvolving
public class CatalogDescriptor
extends Object

Describes a Catalog with the catalog name and configuration.

A CatalogDescriptor is a template for creating a Catalog instance. It closely resembles the "CREATE CATALOG" SQL DDL statement, containing catalog name and catalog configuration. A CatalogDescriptor could be stored to CatalogStore.

This can be used to register a catalog in the Table API, see TableEnvironment#createCatalog(String, CatalogDescriptor).

Method Summary

Modifier and Type	Method	Description
String	getCatalogName()
Optional<String>	getComment()
org.apache.flink.configuration.Configuration	getConfiguration()
static CatalogDescriptor	of(String catalogName, org.apache.flink.configuration.Configuration configuration)
static CatalogDescriptor	of(String catalogName, org.apache.flink.configuration.Configuration configuration, String comment)	Creates an instance of this interface.
CatalogDescriptor	setComment(String comment)

Methods inherited from class java.lang.Object

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

Method Detail

getCatalogName

public String getCatalogName()

getConfiguration

public org.apache.flink.configuration.Configuration getConfiguration()

getComment

public Optional<String> getComment()

setComment

public CatalogDescriptor setComment(@Nonnull
                                    String comment)

of

public static CatalogDescriptor of(String catalogName,
                                   org.apache.flink.configuration.Configuration configuration,
                                   String comment)

Creates an instance of this interface.

Parameters:

catalogName - the name of the catalog

configuration - the configuration of the catalog

comment - the comment of the catalog

of

public static CatalogDescriptor of(String catalogName,
                                   org.apache.flink.configuration.Configuration configuration)