io.debezium.connector.mysql

Interface TopicSelector

@ThreadSafe
public interface TopicSelector

A function that determines the name of topics for data and metadata.

Author:

Randall Hauch

Method Summary

Modifier and Type	Method and Description
static TopicSelector	defaultSelector(String prefix, String heartbeatPrefix) Get the default topic selector logic, which uses a '.' delimiter character when needed.
static TopicSelector	defaultSelector(String prefix, String heartbeatPrefix, String delimiter) Get the default topic selector logic, which uses the supplied delimiter character when needed.
String	getHeartbeatTopic() Get the name of the heartbeat topic.
String	getPrimaryTopic() Get the name of the primary topic.
String	getTopic(String databaseName, String tableName) Get the name of the topic for the given server name.
default String	getTopic(TableId tableId) Get the name of the topic for the given server name.

Method Detail

defaultSelector

static TopicSelector defaultSelector(String prefix,
                                     String heartbeatPrefix)

Get the default topic selector logic, which uses a '.' delimiter character when needed.

Parameters:

prefix - the name of the prefix to be used for all topics; may not be null and must not terminate in the delimiter

heartbeatPrefix - the name of the prefix to be used for all heartbeat topics; may not be null and must not terminate in the delimiter

Returns:

the topic selector; never null

defaultSelector

static TopicSelector defaultSelector(String prefix,
                                     String heartbeatPrefix,
                                     String delimiter)

Get the default topic selector logic, which uses the supplied delimiter character when needed.

Parameters:

prefix - the name of the prefix to be used for all topics; may not be null and must not terminate in the delimiter

heartbeatPrefix - - a prefix that will be used for heartbeat topics. All heartbeat topics will start with this prefix and will use delimiter to separate the heartbeat prefix and the rest of the name

delimiter - the string delineating the server, database, and table names; may not be null

Returns:

the topic selector; never null

getTopic

default String getTopic(TableId tableId)

Get the name of the topic for the given server name.

Parameters:

tableId - the identifier of the table; may not be null

Returns:

the topic name; never null

getTopic

String getTopic(String databaseName,
                String tableName)

Get the name of the topic for the given server name.

Parameters:

databaseName - the name of the database; may not be null

tableName - the name of the table; may not be null

Returns:

the topic name; never null

getPrimaryTopic

String getPrimaryTopic()

Get the name of the primary topic.

Returns:

the topic name; never null

getHeartbeatTopic

String getHeartbeatTopic()

Get the name of the heartbeat topic.

Returns:

the topic name; never null