Package org.apache.flink.table.catalog

Interface ResolvedCatalogModel

All Superinterfaces:

CatalogModel

All Known Implementing Classes:

DefaultResolvedCatalogModel

@PublicEvolving
public interface ResolvedCatalogModel
extends CatalogModel

A validated CatalogModel that is backed by the original metadata coming from the Catalog but resolved by the framework.

Method Summary

Modifier and Type	Method	Description
static CatalogModel	fromProperties(Map<String,String> properties)	Creates an instance of CatalogModel from a map of string properties that were previously created with toProperties(SqlFactory).
CatalogModel	getOrigin()	Returns the original, unresolved metadata object from the Catalog.
ResolvedSchema	getResolvedInputSchema()	Returns a fully resolved and validated ResolvedSchema inputSchema.
ResolvedSchema	getResolvedOutputSchema()	Returns a fully resolved and validated ResolvedSchema outputSchema.
static ResolvedCatalogModel	of(CatalogModel origin, ResolvedSchema resolvedInputSchema, ResolvedSchema resolvedOutputSchema)	Creates a basic implementation of this interface.
default Map<String,String>	toProperties()	Serializes this instance into a map of string-based properties.
Map<String,String>	toProperties(SqlFactory sqlFactory)	Serializes this instance into a map of string-based properties.

Methods inherited from interface org.apache.flink.table.catalog.CatalogModel

copy, copy, getComment, getInputSchema, getOptions, getOutputSchema

Method Detail

getOrigin

CatalogModel getOrigin()

Returns the original, unresolved metadata object from the Catalog.

This method might be useful if catalog-specific object instances should be directly forwarded from the catalog to a factory.

getResolvedInputSchema

ResolvedSchema getResolvedInputSchema()

Returns a fully resolved and validated ResolvedSchema inputSchema.

getResolvedOutputSchema

ResolvedSchema getResolvedOutputSchema()

Returns a fully resolved and validated ResolvedSchema outputSchema.

toProperties

default Map<String,String> toProperties()

Serializes this instance into a map of string-based properties.

Compared to the pure table options in CatalogModel.getOptions(), the map includes input schema, output schema, comment and options.

toProperties

Map<String,String> toProperties(SqlFactory sqlFactory)

Serializes this instance into a map of string-based properties.

Compared to the pure table options in CatalogModel.getOptions(), the map includes input schema, output schema, comment and options.

fromProperties

static CatalogModel fromProperties(Map<String,String> properties)

Creates an instance of CatalogModel from a map of string properties that were previously created with toProperties(SqlFactory).

Parameters:

properties - serialized version of a ResolvedCatalogModel that includes input schema, output schema, comment and options.

of

static ResolvedCatalogModel of(CatalogModel origin,
                               ResolvedSchema resolvedInputSchema,
                               ResolvedSchema resolvedOutputSchema)

Creates a basic implementation of this interface.

Parameters:

origin - origin unresolved catalog model

resolvedInputSchema - resolved input schema

resolvedOutputSchema - resolved output schema