Package 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, userClassLoader, username

Constructor Summary

Constructors

Constructor	Description
JdbcCatalog(ClassLoader userClassLoader, String catalogName, String defaultDatabase, String username, String pwd, String baseUrl)	Creates a JdbcCatalog.
JdbcCatalog(String catalogName, String defaultDatabase, String username, String pwd, String baseUrl)	Deprecated. please use JdbcCatalog(ClassLoader, String, String, String, String, String) instead.

Method Summary

Modifier and Type	Method	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, extractColumnValuesBySQL, fromJDBCType, functionExists, getBaseUrl, getFactory, getFunction, getPartition, getPartitionColumnStatistics, getPartitionStatistics, getPassword, getPrimaryKey, getSchemaName, getSchemaTableName, getTableColumnStatistics, getTableName, 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

alterTable, bulkGetPartitionColumnStatistics, bulkGetPartitionStatistics, dropDatabase, getFunctionDefinitionFactory, getTableFactory, supportsManagedTable

Constructor Detail

JdbcCatalog

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

Deprecated.

please use JdbcCatalog(ClassLoader, String, String, String, String, String) instead.

Creates a JdbcCatalog.

JdbcCatalog

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

Creates a JdbcCatalog.

Parameters:

userClassLoader - the classloader used to load JDBC driver

catalogName - the registered catalog name

defaultDatabase - the default database name

username - the username used to connect the database

pwd - the password used to connect the database

baseUrl - the base URL of the database, e.g. jdbc:mysql://localhost:3306

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

Specified by:

getDatabase in interface org.apache.flink.table.catalog.Catalog

Overrides:

getDatabase in class AbstractJdbcCatalog

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

Specified by:

getTable in interface org.apache.flink.table.catalog.Catalog

Overrides:

getTable in class AbstractJdbcCatalog

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
@Internal
public AbstractJdbcCatalog getInternal()