Package org.apache.flink.cdc.common.source.discover

Class JdbcTableDiscoverer

java.lang.Object

org.apache.flink.cdc.common.source.discover.JdbcTableDiscoverer

All Implemented Interfaces:

Serializable, AutoCloseable, ObjectIdDiscoverer<TableId>, TableDiscoverer

public class JdbcTableDiscoverer
extends Object
implements TableDiscoverer

A TableDiscoverer that reads the list of subscribed tables from a JDBC database.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.cdc.common.source.discover.ObjectIdDiscoverer

ObjectIdDiscoverer.Context

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<String>	COLUMN_NAME
static ConfigOption<String>	JDBC_URL
static ConfigOption<String>	PASSWORD
static ConfigOption<String>	SUBSCRIBE_ID
static ConfigOption<String>	SUBSCRIBE_ID_COLUMN
static ConfigOption<String>	SUBSCRIBE_QUERY
static ConfigOption<String>	TABLE_NAME
static ConfigOption<String>	USERNAME

Constructor Summary

Constructors

Constructor	Description
JdbcTableDiscoverer()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this discoverer and releases any resources.
Set<TableId>	discover()	Discovers and returns the complete current set of object identifiers selected by the caller configuration.
void	open(ObjectIdDiscoverer.Context context)	Opens this discoverer and initializes any resources needed for discovery.

Methods inherited from class java.lang.Object

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

Field Detail

JDBC_URL

public static final ConfigOption<String> JDBC_URL

USERNAME

public static final ConfigOption<String> USERNAME

PASSWORD

public static final ConfigOption<String> PASSWORD

SUBSCRIBE_QUERY

public static final ConfigOption<String> SUBSCRIBE_QUERY

TABLE_NAME

public static final ConfigOption<String> TABLE_NAME

COLUMN_NAME

public static final ConfigOption<String> COLUMN_NAME

SUBSCRIBE_ID_COLUMN

public static final ConfigOption<String> SUBSCRIBE_ID_COLUMN

SUBSCRIBE_ID

public static final ConfigOption<String> SUBSCRIBE_ID

Constructor Detail

JdbcTableDiscoverer

public JdbcTableDiscoverer()

Method Detail

open

public void open(ObjectIdDiscoverer.Context context)
          throws Exception

Description copied from interface: ObjectIdDiscoverer

Opens this discoverer and initializes any resources needed for discovery.

Specified by:

open in interface ObjectIdDiscoverer<TableId>

Throws:

Exception

discover

public Set<TableId> discover()
                      throws Exception

Description copied from interface: ObjectIdDiscoverer

Discovers and returns the complete current set of object identifiers selected by the caller configuration.

A successful result is authoritative: identifiers absent from it are no longer selected, and an empty result selects no identifiers. A failed discovery does not describe a new set.

Specified by:

discover in interface ObjectIdDiscoverer<TableId>

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: ObjectIdDiscoverer

Closes this discoverer and releases any resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ObjectIdDiscoverer<TableId>

Throws:

Exception