org.apache.flink.table.factories

Class FactoryUtil.CatalogFactoryHelper

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.CatalogFactoryHelper

Enclosing class:

FactoryUtil

@PublicEvolving
public static class FactoryUtil.CatalogFactoryHelper
extends Object

Helper utility for catalog implementations to validate options provided by CatalogFactory.

Constructor Summary

Constructors

Constructor and Description
CatalogFactoryHelper(CatalogFactory catalogFactory, CatalogFactory.Context context)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.configuration.ReadableConfig	getOptions() Returns all options of the catalog.
void	validate() Validates the options of the CatalogFactory.
void	validateExcept(String... prefixesToSkip) Validates the options of the CatalogFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogFactoryHelper

public CatalogFactoryHelper(CatalogFactory catalogFactory,
                            CatalogFactory.Context context)

Method Detail

validate

public void validate()

Validates the options of the CatalogFactory. It checks for unconsumed option keys.

validateExcept

public void validateExcept(String... prefixesToSkip)

Validates the options of the CatalogFactory. It checks for unconsumed option keys while ignoring the options with given prefixes.

The option keys that have given prefix prefixToSkip would just be skipped for validation.

Parameters:

prefixesToSkip - Set of option key prefixes to skip validation

getOptions

public org.apache.flink.configuration.ReadableConfig getOptions()

Returns all options of the catalog.