Package org.apache.cassandra.cdc.sidecar
Interface SidecarCdcOptions
-
- All Superinterfaces:
org.apache.cassandra.cdc.kafka.KafkaOptions
public interface SidecarCdcOptions extends org.apache.cassandra.cdc.kafka.KafkaOptions
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classSidecarCdcOptions.TopicFormatType
-
Field Summary
Fields Modifier and Type Field Description static SidecarCdcOptionsDEFAULTstatic java.lang.StringDEFAULT_JOB_IDstatic intDEFAULT_MAX_WATERMARKER_SIZE
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.util.Map<java.lang.String,java.lang.Object>cdcConfigs()default booleancdcEnabled()default java.lang.Stringcompression()default java.lang.Stringdc()default booleanfailOnKafkaError()default booleanfailOnRecordTooLargeError()default booleanisConfigReady()Initialization of tables and loading config takes some time, returns if the config is ready to be loaded or not.default java.lang.StringjobId()default java.util.Map<java.lang.String,java.lang.Object>kafkaConfigs()default java.lang.StringkafkaTopic()default booleanlogOnly()default intmaxCommitLogsPerInstance()default intmaxRecordSizeBytes()default intmaxWatermarkerSize()default java.time.DurationminDelayBetweenMicroBatches()default java.time.DurationpersistDelay()default booleanpersistEnabled()default SidecarCdcOptions.TopicFormatTypetopicFormat()default java.time.DurationwatermarkWindow()
-
-
-
Field Detail
-
DEFAULT_JOB_ID
static final java.lang.String DEFAULT_JOB_ID
- See Also:
- Constant Field Values
-
DEFAULT_MAX_WATERMARKER_SIZE
static final int DEFAULT_MAX_WATERMARKER_SIZE
- See Also:
- Constant Field Values
-
DEFAULT
static final SidecarCdcOptions DEFAULT
-
-
Method Detail
-
kafkaTopic
@Nullable default java.lang.String kafkaTopic()
-
topicFormat
@NotNull default SidecarCdcOptions.TopicFormatType topicFormat()
-
cdcEnabled
default boolean cdcEnabled()
-
jobId
default java.lang.String jobId()
-
kafkaConfigs
default java.util.Map<java.lang.String,java.lang.Object> kafkaConfigs()
- Specified by:
kafkaConfigsin interfaceorg.apache.cassandra.cdc.kafka.KafkaOptions
-
cdcConfigs
default java.util.Map<java.lang.String,java.lang.Object> cdcConfigs()
-
logOnly
default boolean logOnly()
-
dc
default java.lang.String dc()
-
watermarkWindow
default java.time.Duration watermarkWindow()
-
maxRecordSizeBytes
default int maxRecordSizeBytes()
- Returns:
- max Kafka record size in bytes. If value is non-negative then the KafkaPublisher will chunk larger records into multiple messages.
-
compression
@Nullable default java.lang.String compression()
- Returns:
- "zstd" to enable compression on large blobs, or null or empty string if disabled.
-
failOnRecordTooLargeError
default boolean failOnRecordTooLargeError()
- Returns:
- true if Kafka publisher should fail if Kafka client returns "record too large" error.
-
failOnKafkaError
default boolean failOnKafkaError()
- Returns:
- true if Kafka publisher should fail if Kafka client returns any other error.
-
isConfigReady
default boolean isConfigReady()
Initialization of tables and loading config takes some time, returns if the config is ready to be loaded or not.- Returns:
- true if config is ready to be read.
-
minDelayBetweenMicroBatches
default java.time.Duration minDelayBetweenMicroBatches()
-
maxCommitLogsPerInstance
default int maxCommitLogsPerInstance()
-
maxWatermarkerSize
default int maxWatermarkerSize()
- Returns:
- the maximum number of entries to hold in the watermarker state for mutations that are have not achieved the consistency level. Each entry is an MD5 with a byte integer, approximately 30-60 bytes per entry before compression.
-
persistEnabled
default boolean persistEnabled()
- Returns:
- true if CDC state should be persisted to Cassandra.
-
persistDelay
default java.time.Duration persistDelay()
- Returns:
- the delay in millis between persist calls.
-
-