org.apache.flink.connector.jdbc.catalog

Class JdbcCatalog

java.lang.Object

org.apache.flink.table.catalog.AbstractCatalog

org.apache.flink.connector.jdbc.catalog.AbstractJdbcCatalog

org.apache.flink.connector.jdbc.catalog.JdbcCatalog

All Implemented Interfaces:

org.apache.flink.table.catalog.Catalog

@PublicEvolving
public class JdbcCatalog
extends AbstractJdbcCatalog

Catalogs for relational databases via JDBC.

Field Summary

Fields inherited from class org.apache.flink.connector.jdbc.catalog.AbstractJdbcCatalog

baseUrl, defaultUrl, pwd, username

Constructor Summary

Constructors

Constructor and Description
JdbcCatalog(String catalogName, String defaultDatabase, String username, String pwd, String baseUrl)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.table.catalog.CatalogDatabase	getDatabase(String databaseName)
AbstractJdbcCatalog	getInternal()
org.apache.flink.table.catalog.CatalogBaseTable	getTable(org.apache.flink.table.catalog.ObjectPath tablePath)
List<String>	listDatabases()
List<String>	listTables(String databaseName)
boolean	tableExists(org.apache.flink.table.catalog.ObjectPath tablePath)

Methods inherited from class org.apache.flink.connector.jdbc.catalog.AbstractJdbcCatalog

alterDatabase, alterFunction, alterPartition, alterPartitionColumnStatistics, alterPartitionStatistics, alterTable, alterTableColumnStatistics, alterTableStatistics, close, createDatabase, createFunction, createPartition, createTable, databaseExists, dropDatabase, dropFunction, dropPartition, dropTable, functionExists, getBaseUrl, getFactory, getFunction, getPartition, getPartitionColumnStatistics, getPartitionStatistics, getPassword, getPrimaryKey, getTableColumnStatistics, getTableStatistics, getUsername, listFunctions, listPartitions, listPartitions, listPartitionsByFilter, listViews, open, partitionExists, renameTable

Methods inherited from class org.apache.flink.table.catalog.AbstractCatalog

getDefaultDatabase, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

dropDatabase, getFunctionDefinitionFactory, getTableFactory

Constructor Detail

JdbcCatalog

public JdbcCatalog(String catalogName,
                   String defaultDatabase,
                   String username,
                   String pwd,
                   String baseUrl)

Method Detail

listDatabases

public List<String> listDatabases()
                           throws org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

getDatabase

public org.apache.flink.table.catalog.CatalogDatabase getDatabase(String databaseName)
                                                           throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                                                                  org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException

listTables

public List<String> listTables(String databaseName)
                        throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                               org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException

getTable

public org.apache.flink.table.catalog.CatalogBaseTable getTable(org.apache.flink.table.catalog.ObjectPath tablePath)
                                                         throws org.apache.flink.table.catalog.exceptions.TableNotExistException,
                                                                org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.TableNotExistException

org.apache.flink.table.catalog.exceptions.CatalogException

tableExists

public boolean tableExists(org.apache.flink.table.catalog.ObjectPath tablePath)
                    throws org.apache.flink.table.catalog.exceptions.CatalogException

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException

getInternal

@VisibleForTesting
public AbstractJdbcCatalog getInternal()