org.apache.flink.table.catalog

Class ContextResolvedTable

java.lang.Object

org.apache.flink.table.catalog.ContextResolvedTable

@Internal
public final class ContextResolvedTable
extends Object

This class contains information about a table, its ResolvedSchema, its options and its relationship with a Catalog, if any.

There can be 3 kinds of ContextResolvedTable:

• A permanent table: a table which is stored in a Catalog and has an associated unique ObjectIdentifier.
• A temporary table: a table which is stored in the CatalogManager, has an associated unique ObjectIdentifier and is flagged as temporary.
• An anonymous/inline table: a table which is not stored in a catalog and doesn't have an associated unique ObjectIdentifier.

The different handling of temporary and permanent tables is Catalog and CatalogManager instance specific, hence for these two kind of tables, an instance of this object represents the relationship between the specific ResolvedCatalogBaseTable instance and the specific Catalog/CatalogManager instances. For example, the same ResolvedCatalogBaseTable can be temporary for one catalog, but permanent for another one.

Method Summary

Modifier and Type	Method and Description
static ContextResolvedTable	anonymous(ResolvedCatalogBaseTable<?> resolvedTable)
static ContextResolvedTable	anonymous(String hint, ResolvedCatalogBaseTable<?> resolvedTable)
ContextResolvedTable	copy(Map<String,String> newOptions) Copy the ContextResolvedTable, replacing the underlying CatalogTable options.
ContextResolvedTable	copy(ResolvedSchema newSchema) Copy the ContextResolvedTable, replacing the underlying ResolvedSchema.
boolean	equals(Object o)
Optional<Catalog>	getCatalog() Returns empty if isPermanent() is false.
ObjectIdentifier	getIdentifier()
ResolvedSchema	getResolvedSchema()
<T extends ResolvedCatalogBaseTable<?>> T	getResolvedTable() Returns a fully resolved catalog object.
<T extends CatalogBaseTable> T	getTable() Returns the original metadata object returned by the catalog.
int	hashCode()
boolean	isAnonymous()
boolean	isPermanent()
boolean	isTemporary()
static ContextResolvedTable	permanent(ObjectIdentifier identifier, Catalog catalog, ResolvedCatalogBaseTable<?> resolvedTable)
static ContextResolvedTable	temporary(ObjectIdentifier identifier, ResolvedCatalogBaseTable<?> resolvedTable)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

permanent

public static ContextResolvedTable permanent(ObjectIdentifier identifier,
                                             Catalog catalog,
                                             ResolvedCatalogBaseTable<?> resolvedTable)

temporary

public static ContextResolvedTable temporary(ObjectIdentifier identifier,
                                             ResolvedCatalogBaseTable<?> resolvedTable)

anonymous

public static ContextResolvedTable anonymous(ResolvedCatalogBaseTable<?> resolvedTable)

anonymous

public static ContextResolvedTable anonymous(String hint,
                                             ResolvedCatalogBaseTable<?> resolvedTable)

isAnonymous

public boolean isAnonymous()

isTemporary

public boolean isTemporary()

Returns:

true if the table is temporary. An anonymous table is always temporary.

isPermanent

public boolean isPermanent()

getIdentifier

public ObjectIdentifier getIdentifier()

getCatalog

public Optional<Catalog> getCatalog()

Returns empty if isPermanent() is false.

getResolvedTable

public <T extends ResolvedCatalogBaseTable<?>> T getResolvedTable()

Returns a fully resolved catalog object.

getResolvedSchema

public ResolvedSchema getResolvedSchema()

getTable

public <T extends CatalogBaseTable> T getTable()

Returns the original metadata object returned by the catalog.

copy

public ContextResolvedTable copy(Map<String,String> newOptions)

Copy the ContextResolvedTable, replacing the underlying CatalogTable options.

copy

public ContextResolvedTable copy(ResolvedSchema newSchema)

Copy the ContextResolvedTable, replacing the underlying ResolvedSchema.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object