xtdb-kafka/xtdb.api.log/Kafka/Factory

Factory

@Serializable

@SerialName(value = "!Kafka")

data class Factory(val bootstrapServers: String, val topicName: String, var autoCreateTopic: Boolean = true, var replicationFactor: Int = 1, var pollDuration: Duration = Duration.ofSeconds(1), var topicConfig: Map<String, String> = emptyMap(), var propertiesMap: Map<String, String> = emptyMap(), var propertiesFile: Path? = null) : Log.Factory

Used to set configuration options for Kafka as an XTDB Transaction Log.

For more info on setting up the necessary infrastructure to be able to use Kafka as an XTDB Transaction Log, see the section on infrastructure within our Kafka Module Reference.

Example usage, as part of a node config:

Xtdb.openNode {
   txLog = KafkaLogFactory(
             bootstrapServers = "localhost:9092",
             topicName = "xtdb_topic",
             autoCreateTopic = true,
             replicationFactor = 1,
             pollDuration = Duration.ofSeconds(1)
           ),
   ...
}

Constructors

constructor(bootstrapServers: String, topicName: String, autoCreateTopic: Boolean = true, replicationFactor: Int = 1, pollDuration: Duration = Duration.ofSeconds(1), topicConfig: Map<String, String> = emptyMap(), propertiesMap: Map<String, String> = emptyMap(), propertiesFile: Path? = null)

Properties

autoCreateTopic

var autoCreateTopic: Boolean

Whether to automatically create the topic, if it does not already exist.

bootstrapServers

@Serializable(with = StringWithEnvVarSerde::class)

val bootstrapServers: String

A comma-separated list of host:port pairs to use for establishing the initial connection to the Kafka cluster.

var pollDuration: Duration

The maximum amount of time to block waiting for records to be returned by the Kafka consumer.

@Serializable(with = PathWithEnvVarSerde::class)

var propertiesFile: Path?

Path to a Java properties file containing Kafka connection properties, supplied directly to the Kafka client.

var propertiesMap: Map<String, String>

A map of Kafka connection properties, supplied directly to the Kafka client.

replicationFactor

var replicationFactor: Int

The replication factor of the transaction log topic (if it is automatically created by XTDB).

var topicConfig: Map<String, String>

A map of topic configuration options to use when creating the transaction log topic (if it is automatically created by XTDB).

@Serializable(with = StringWithEnvVarSerde::class)

val topicName: String

Name of the Kafka topic to use for the transaction log.

Functions

autoCreateTopic

fun autoCreateTopic(autoCreateTopic: Boolean): Kafka.Factory

open override fun openLog(): Log

fun pollDuration(pollDuration: Duration): Kafka.Factory

fun propertiesFile(propertiesFile: Path): Kafka.Factory

fun propertiesMap(propertiesMap: Map<String, String>): Kafka.Factory

replicationFactor

fun replicationFactor(replicationFactor: Int): Kafka.Factory

fun topicConfig(topicConfig: Map<String, String>): Kafka.Factory