Package io.debezium.spi.topic

Interface TopicNamingStrategy<I extends DataCollectionId>

Type Parameters:

I -

@Incubating
public interface TopicNamingStrategy<I extends DataCollectionId>

An interface that defines the topic naming strategy, including DataChange, SchemaChange, Transaction, Heartbeat events etc.

Author:

Harvey Yue

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TopicNamingStrategy.TopicSchemaAugment<S>	An interface that augments the field to topic key/value schema.
static interface	TopicNamingStrategy.TopicValueAugment<I extends DataCollectionId,S,R>	An interface that augments the field's value to topic key/value.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME_LENGTH
static final TopicNamingStrategy.TopicSchemaAugment	NO_SCHEMA_OP
static final TopicNamingStrategy.TopicValueAugment	NO_VALUE_OP

Method Summary

Modifier and Type	Method	Description
void	configure(Properties props)
String	dataChangeTopic(I id)
String	heartbeatTopic()
default TopicNamingStrategy.TopicSchemaAugment	keySchemaAugment()
default TopicNamingStrategy.TopicValueAugment	keyValueAugment()
default String	recordSchemaPrefix(I id)
String	sanitizedTopicName(String topicName)	Sanitize the given character whether is a legal character of a Kafka topic name.
String	schemaChangeTopic()
String	transactionTopic()

Field Details

MAX_NAME_LENGTH

static final int MAX_NAME_LENGTH

See Also:

• Constant Field Values

NO_SCHEMA_OP

static final TopicNamingStrategy.TopicSchemaAugment NO_SCHEMA_OP

NO_VALUE_OP

static final TopicNamingStrategy.TopicValueAugment NO_VALUE_OP

Method Details

configure

void configure(Properties props)

dataChangeTopic

String dataChangeTopic(I id)

schemaChangeTopic

String schemaChangeTopic()

heartbeatTopic

String heartbeatTopic()

transactionTopic

String transactionTopic()

recordSchemaPrefix

default String recordSchemaPrefix(I id)

sanitizedTopicName

String sanitizedTopicName(String topicName)

Sanitize the given character whether is a legal character of a Kafka topic name. Legal characters are [a-zA-Z0-9._-].

keySchemaAugment

default TopicNamingStrategy.TopicSchemaAugment keySchemaAugment()

keyValueAugment

default TopicNamingStrategy.TopicValueAugment keyValueAugment()