Package org.apache.flink.table.catalog
Interface CatalogDatabase
-
- All Known Implementing Classes:
CatalogDatabaseImpl
@PublicEvolving public interface CatalogDatabase
Interface of a database in a catalog.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CatalogDatabase
copy()
Get a deep copy of the CatalogDatabase instance.CatalogDatabase
copy(Map<String,String> properties)
Returns a copy of thisCatalogDatabase
with the given properties.String
getComment()
Get comment of the database.Optional<String>
getDescription()
Get a brief description of the database.Optional<String>
getDetailedDescription()
Get a detailed description of the database.Map<String,String>
getProperties()
Get a map of properties associated with the database.
-
-
-
Method Detail
-
getProperties
Map<String,String> getProperties()
Get a map of properties associated with the database.
-
getComment
String getComment()
Get comment of the database.- Returns:
- comment of the database
-
copy
CatalogDatabase copy()
Get a deep copy of the CatalogDatabase instance.- Returns:
- a copy of CatalogDatabase instance
-
copy
CatalogDatabase copy(Map<String,String> properties)
Returns a copy of thisCatalogDatabase
with the given properties.- Returns:
- a new copy of this database with replaced properties
-
getDescription
Optional<String> getDescription()
Get a brief description of the database.- Returns:
- an optional short description of the database
-
-