org.apache.flink.table.catalog

Class ObjectIdentifier

java.lang.Object

org.apache.flink.table.catalog.ObjectIdentifier

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class ObjectIdentifier
extends Object
implements Serializable

Identifies an object in a catalog. It allows to identify objects such as tables, views, function, or types in a catalog. An identifier must be fully qualified. It is the responsibility of the catalog manager to resolve an identifier to an object.

While ObjectPath is used within the same catalog, instances of this class can be used across catalogs.

Two objects are considered equal if they share the same object identifier in a stable session context.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	asSerializableString() Returns a string that fully serializes this instance.
String	asSummaryString() Returns a string that summarizes this instance for printing to a console or log.
boolean	equals(Object o)
String	getCatalogName()
String	getDatabaseName()
String	getObjectName()
int	hashCode()
static ObjectIdentifier	of(String catalogName, String databaseName, String objectName)
List<String>	toList() List of the component names of this object identifier.
ObjectPath	toObjectPath() Convert this ObjectIdentifier to ObjectPath.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ObjectIdentifier of(String catalogName,
                                  String databaseName,
                                  String objectName)

getCatalogName

public String getCatalogName()

getDatabaseName

public String getDatabaseName()

getObjectName

public String getObjectName()

toObjectPath

public ObjectPath toObjectPath()
                        throws TableException

Convert this ObjectIdentifier to ObjectPath.

Throws:

TableException - if the identifier cannot be converted

toList

public List<String> toList()

List of the component names of this object identifier.

asSerializableString

public String asSerializableString()
                            throws TableException

Returns a string that fully serializes this instance. The serialized string can be used for transmitting or persisting an object identifier.

Throws:

TableException - if the identifier cannot be serialized

asSummaryString

public String asSummaryString()

Returns a string that summarizes this instance for printing to a console or log.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object