Package org.apache.flink.table.catalog

Interface Summary

Interface	Description
Catalog	This interface is responsible for reading and writing metadata such as database/table/views/UDFs from a registered catalog.
CatalogBaseTable	A common parent that describes the unresolved metadata of a table or view in a catalog.
CatalogChange	CatalogChange represents the modification of the catalog.
CatalogDatabase	Interface of a database in a catalog.
CatalogFunction	Interface for a function in a catalog.
CatalogLock	Deprecated. This interface will be removed soon.
CatalogLock.Factory	Deprecated. This interface will be removed soon.
CatalogMaterializedTable	Represents the unresolved metadata of a materialized table in a Catalog.
CatalogModel	Interface for a model in a catalog.
CatalogPartition	Represents a partition object in catalog.
CatalogRegistry	A catalog registry for dealing with catalogs.
CatalogStore	Represents the storage where persists all Catalogs.
CatalogTable	Represents the unresolved metadata of a table in a Catalog.
CatalogView	Represents the unresolved metadata of a view in a Catalog.
Constraint	Integrity constraints, generally referred to simply as constraints, define the valid states of SQL-data by constraining the values in the base tables.
DataTypeFactory	Factory for creating fully resolved data types that can be used for planning.
FunctionLookup	Catalog of functions that can resolve the name of a function to a ContextResolvedFunction.
ResolvedCatalogBaseTable<T extends CatalogBaseTable>	A common parent that describes the resolved metadata of a table or view in a catalog.
ResolvedCatalogModel	A validated CatalogModel that is backed by the original metadata coming from the Catalog but resolved by the framework.
SchemaResolver	Resolves a Schema to a validated ResolvedSchema.
StagedTable	The StagedTable is designed to implement Flink's atomic semantic for CTAS(CREATE TABLE AS SELECT) and RTAS([CREATE OR] REPLACE TABLE AS SELECT) statement using a two-phase commit protocol.
TableChange	TableChange represents the modification of the table.
TableChange.ColumnPosition	The position of the modified or added column.
TableChange.MaterializedTableChange	TableChange.MaterializedTableChange represents the modification of the materialized table.
TemporaryOperationListener	This interface is for a Catalog to listen on temporary object operations.

Class Summary

Class	Description
AbstractCatalog	Abstract class for catalogs.
AbstractCatalogStore	The AbstractCatalogStore class is an abstract base class for implementing a catalog store.
AbstractCatalogTable	An abstract catalog table.
AbstractCatalogView	An abstract catalog view.
CatalogChange.CatalogCommentChange	A catalog change to modify the comment.
CatalogChange.CatalogConfigurationChange	A catalog change to modify the catalog configuration.
CatalogDatabaseImpl	A implementation of CatalogDatabase.
CatalogDescriptor	Describes a Catalog with the catalog name and configuration.
CatalogFunctionImpl	A catalog function implementation.
CatalogManager	A manager for dealing with catalog objects such as tables, views, functions, and types.
CatalogManager.Builder	Builder for a fluent definition of a CatalogManager.
CatalogMaterializedTable.Builder	Builder for configuring and creating instances of CatalogMaterializedTable.
CatalogPartitionImpl	A catalog partition implementation.
CatalogPartitionSpec	Represents a partition spec object in catalog.
CatalogPropertiesUtil	Utilities for de/serializing Catalog objects into a map of string properties.
CatalogStoreHolder	A holder for a CatalogStore instance and the necessary information for creating and initializing Catalog instances, including a CatalogStoreFactory, a ReadableConfig instance, and a ClassLoader instance.
CatalogStoreHolder.Builder	Builder for a fluent definition of a CatalogStoreHolder.
CatalogTable.Builder	Builder for configuring and creating instances of CatalogTable.
CatalogTableImpl	Deprecated. Use CatalogTable.of(Schema, String, List, Map) or a custom implementation instead.
CatalogViewImpl	Deprecated. Use CatalogView.of(Schema, String, String, String, Map) or a custom implementation instead.
Column	Representation of a column in a ResolvedSchema.
Column.ComputedColumn	Representation of a computed column.
Column.MetadataColumn	Representation of a metadata column.
Column.PhysicalColumn	Representation of a physical column.
CommonCatalogOptions	A collection of ConfigOption which are consistently used in multiple catalogs.
ConnectorCatalogTable<T1,T2>	A CatalogTable that wraps a TableSource and/or TableSink.
ContextResolvedFunction	This class contains information about a function and its relationship with a Catalog, if any.
ContextResolvedModel	This class contains information about a model and its relationship with a Catalog, if any.
ContextResolvedProcedure	This class contains information about a procedure and its relationship with a Catalog.
ContextResolvedTable	This class contains information about a table, its ResolvedSchema, its options and its relationship with a Catalog, if any.
DefaultCatalogMaterializedTable	Default implementation of a CatalogMaterializedTable.
DefaultCatalogModel	A catalog model implementation.
DefaultCatalogTable	Default implementation of a CatalogTable.
DefaultResolvedCatalogModel	A validated CatalogModel that is backed by the original metadata coming from the Catalog but resolved by the framework.
ExternalCatalogTable	Helper CatalogTable for representing a table that is backed by some inline connector (i.e.
FileCatalogStore	A CatalogStore that stores all catalog configuration to a directory.
FileCatalogStoreFactory	Catalog store factory for FileCatalogStore.
FileCatalogStoreFactoryOptions	ConfigOptions for FileCatalogStoreFactory.
FunctionCatalog	Simple function catalog to store FunctionDefinitions in catalogs.
FunctionCatalog.InlineCatalogFunction	The CatalogFunction which holds an instantiated UDF.
GenericInMemoryCatalog	A generic catalog implementation that holds all meta objects in memory.
GenericInMemoryCatalogFactory	Catalog factory for GenericInMemoryCatalog.
GenericInMemoryCatalogFactoryOptions	ConfigOptions for GenericInMemoryCatalog.
GenericInMemoryCatalogStore	A generic catalog store implementation that store all catalog configuration in memory.
GenericInMemoryCatalogStoreFactory	Catalog store factory for GenericInMemoryCatalogStore.
GenericInMemoryCatalogStoreFactoryOptions	ConfigOptions for GenericInMemoryCatalogStore.
IntervalFreshness	The IntervalFreshness represents freshness definition of CatalogMaterializedTable.
ManagedTableListener	Deprecated. This interface will be removed soon.
ObjectIdentifier	Identifies an object in a catalog.
ObjectPath	A database name and object (table/view/function) name combo in a catalog.
QueryOperationCatalogView	A view created from a QueryOperation via operations on Table.
ResolvedCatalogMaterializedTable	A validated CatalogMaterializedTable that is backed by the original metadata coming from the Catalog but resolved by the framework.
ResolvedCatalogTable	A validated CatalogTable that is backed by the original metadata coming from the Catalog but resolved by the framework.
ResolvedCatalogView	A validated CatalogView that is backed by the original metadata coming from the Catalog but resolved by the framework.
ResolvedSchema	Schema of a table or view consisting of columns, constraints, and watermark specifications.
SchemaTranslator	Utility to derive a physical DataType, Schema, and projections for sinks and sources.
SchemaTranslator.ConsumingResult	Result of SchemaTranslator.createConsumingResult(DataTypeFactory, TypeInformation, Schema).
SchemaTranslator.ProducingResult	Result of SchemaTranslator.createConsumingResult(DataTypeFactory, TypeInformation, Schema).
TableChange.AddColumn	A table change to add a column.
TableChange.AddDistribution	A table change to add a distribution.
TableChange.AddUniqueConstraint	A table change to add a unique constraint.
TableChange.AddWatermark	A table change to add a watermark.
TableChange.After	Column position AFTER means the specified column should be put after the given `column`.
TableChange.DropColumn	A table change to drop the column.
TableChange.DropConstraint	A table change to drop the constraints.
TableChange.DropDistribution	A table change to drop a table's distribution.
TableChange.DropWatermark	A table change to drop the watermark.
TableChange.First	Column position FIRST means the specified column should be the first column.
TableChange.ModifyColumn	A base schema change to modify a column.
TableChange.ModifyColumnComment	A table change to modify the column comment.
TableChange.ModifyColumnName	A table change to modify the column name.
TableChange.ModifyColumnPosition	A table change to modify the column position.
TableChange.ModifyDistribution	A table change to modify a distribution.
TableChange.ModifyPhysicalColumnType	A table change that modify the physical column data type.
TableChange.ModifyRefreshHandler	A table change to modify materialized table refresh handler.
TableChange.ModifyRefreshStatus	A table change to modify materialized table refresh status.
TableChange.ModifyUniqueConstraint	A table change to modify a unique constraint.
TableChange.ModifyWatermark	A table change to modify the watermark.
TableChange.ResetOption	A table change to reset the table option.
TableChange.SetOption	A table change to set the table option.
TableDistribution	Defines whether the given table is distributed across buckets using a specified algorithm and given columns.
UniqueConstraint	A unique key constraint.
UnresolvedIdentifier	Identifier of an object, such as table, view, function or type in a catalog.
WatermarkSpec	Representation of a watermark specification in a ResolvedSchema.

Enum Summary

Enum	Description
CatalogBaseTable.TableKind	The kind of CatalogBaseTable.
CatalogMaterializedTable.LogicalRefreshMode	The logical refresh mode of materialized table.
CatalogMaterializedTable.RefreshMode	The physical refresh mode of materialized table.
CatalogMaterializedTable.RefreshStatus	Background refresh pipeline status of materialized table.
Constraint.ConstraintType	Type of the constraint.
FunctionLanguage	Categorizes the language semantics of a CatalogFunction.
IntervalFreshness.TimeUnit	An enumeration of time unit representing the unit of interval freshness.
TableDistribution.Kind	Distribution kind.