Package org.apache.flink.table.catalog

Class CatalogPropertiesUtil

java.lang.Object

org.apache.flink.table.catalog.CatalogPropertiesUtil

@Internal
public final class CatalogPropertiesUtil
extends Object

Utilities for de/serializing Catalog objects into a map of string properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLINK_PROPERTY_PREFIX	Globally reserved prefix for catalog properties.
static final String	IS_GENERIC	Flag to distinguish if a meta-object is a generic Flink object or not.

Method Summary

Modifier and Type	Method	Description
static CatalogMaterializedTable	deserializeCatalogMaterializedTable(Map<String,String> properties)	Deserializes the given map of string properties into an unresolved CatalogMaterializedTable.
static CatalogModel	deserializeCatalogModel(Map<String,String> properties)
static CatalogTable	deserializeCatalogTable(Map<String,String> properties)	Deserializes the given map of string properties into an unresolved CatalogTable.
static CatalogTable	deserializeCatalogTable(Map<String,String> properties, String fallbackKey)	Deserializes the given map of string properties into an unresolved CatalogTable.
static Map<String,String>	serializeCatalogMaterializedTable(ResolvedCatalogMaterializedTable resolvedMaterializedTable)	Serializes the given ResolvedCatalogMaterializedTable into a map of string properties.
static Map<String,String>	serializeCatalogTable(ResolvedCatalogTable resolvedTable)	Serializes the given ResolvedCatalogTable into a map of string properties.
static Map<String,String>	serializeCatalogView(ResolvedCatalogView resolvedView)	Serializes the given ResolvedCatalogView into a map of string properties.
static Map<String,String>	serializeResolvedCatalogModel(ResolvedCatalogModel resolvedModel)	Serializes the given ResolvedCatalogModel into a map of string properties.

Methods inherited from class java.lang.Object

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

Field Details

IS_GENERIC

public static final String IS_GENERIC

Flag to distinguish if a meta-object is a generic Flink object or not.

It is used to distinguish between Flink's generic connector discovery logic or specialized catalog connectors.

See Also:

• Constant Field Values

FLINK_PROPERTY_PREFIX

public static final String FLINK_PROPERTY_PREFIX

Globally reserved prefix for catalog properties. User-defined properties should not use this prefix. E.g. it is used to distinguish properties created by Hive and Flink, as Hive metastore has its own properties created upon table creation and migration between different versions of metastore.

See Also:

• Constant Field Values

Method Details

serializeCatalogTable

public static Map<String,String> serializeCatalogTable(ResolvedCatalogTable resolvedTable)

Serializes the given ResolvedCatalogTable into a map of string properties.

serializeCatalogView

public static Map<String,String> serializeCatalogView(ResolvedCatalogView resolvedView)

Serializes the given ResolvedCatalogView into a map of string properties.

serializeCatalogMaterializedTable

public static Map<String,String> serializeCatalogMaterializedTable(ResolvedCatalogMaterializedTable resolvedMaterializedTable)

Serializes the given ResolvedCatalogMaterializedTable into a map of string properties.

serializeResolvedCatalogModel

public static Map<String,String> serializeResolvedCatalogModel(ResolvedCatalogModel resolvedModel)

Serializes the given ResolvedCatalogModel into a map of string properties.

deserializeCatalogTable

public static CatalogTable deserializeCatalogTable(Map<String,String> properties)

Deserializes the given map of string properties into an unresolved CatalogTable.

deserializeCatalogTable

public static CatalogTable deserializeCatalogTable(Map<String,String> properties,
 @Nullable
 String fallbackKey)

Deserializes the given map of string properties into an unresolved CatalogTable.

Parameters:

properties - The properties to deserialize from

fallbackKey - The fallback key to get the schema properties. This is meant to support the old table (1.10) deserialization

Returns:

a catalog table instance.

deserializeCatalogMaterializedTable

public static CatalogMaterializedTable deserializeCatalogMaterializedTable(Map<String,String> properties)

Deserializes the given map of string properties into an unresolved CatalogMaterializedTable.

deserializeCatalogModel

public static CatalogModel deserializeCatalogModel(Map<String,String> properties)