You are viewing documentation for an outdated version of Debezium.
If you want to view the latest stable version of this page, please gohere.

Debezium Connector for Cassandra

这s connector is currently in incubating state, i.e. exact semantics, configuration options etc. may change in future revisions, based on the feedback we receive. Please let us know if you encounter any problems.

The Cassanadra connector can monitor a Cassandra cluster and record all row-level changes. The connector must be deployed locally on each node in the Cassandra cluster. The first time the connector connects to a Cassandra node, it performs a snapshot of all CDC-enabled tables in all keyspaces. The connector will also read the changes that are written to Cassandra commit logs and generates corresponding insert, update, and delete events. All events for each table are recorded in a separate kafka topic, where they can be consumed easily by applications and services.

Overview

Cassandra is an open-sourced NoSQL database. Similar to most databases, the write path of Cassandra starts with the immeidate logging of a change into its commit log. The commit log resides locally on each node, recording every write made to that node.

Since Cassandra 3.0, achange data capture (CDC) featureis introduced. The CDC feature can be enabled on the table level by setting the table propertycdc=true, after which any commit log containing data for a CDC-enabled table will be moved to the CDC directory specified incassandra.yamlon disgard.

The Cassandra connector resides on each Cassandra node and monitors thecdc_raw目录的变化。它处理所有当地的委员会t log segments as they are detected, produces a change event for every row-level insert, update, and delete operations in the commit log, publishes all change events for each table in a separate Kafka topic, and finally deletes the commit log from thecdc_rawdirectory. This last step is important because once CDC is enabled, Cassandra itself cannot purge the commit logs. If thecdc_free_space_in_mbfills up, writes to CDC-enabled tables will be rejected.

The connector is tolerant of failures. As the connector reads commit logs and produces events, it records each commit log segment’s filename and position along with each event. If the connector stops for any reason (including communication failures, network problems, or crashes), upon restart it simply continues reading the commit log where it last left off. This includes snapshots: if the snapshot was not completed when the connector is stopped, upon restart it will begin a new snapshot. We’ll talk later about how the connector behaveswhen things go wrong.

Cassandra is different from the other Debezium connectors since it is not implemented on top of the Kafka Connect framework. Instead it is a single JVM process that is intended to reside on each Cassandra node and publishes events to Kafka via a Kafka producer.

The following features are currently not supported by the Cassandra connector. Changes resulted from any of these features are ignored:

  • TTL on collection-type columns

  • Range deletes

  • Static columns

  • Triggers

  • Materialized views

  • Secondary indices

  • Light-weight transactions

Setting Up Cassandra

Before the Debezium Cassandra connector can be used to monitor the changes in a Cassandra cluster, CDC must be enabled on the node level and table level.

Enabling CDC on Node

To enable CDC, update the following CDC config incassandra.yaml:

cdc_enabled: true

Additional CDC configs are have the following default values:

cdc_raw_directory: $CASSANDRA_HOME/data/cdc_raw cdc_free_space_in_mb: 4096 cdc_free_space_check_interval_ms: 250

  • cdc_enabledenables or disables CDC operations node-wide

  • cdc_raw_directorydetermines the destination for commit log segments to be moved after all corresponding memtables are flushed

  • cdc_free_space_in_mbis the maximum capacity allocated to store commit log segments, and defaults to the minimum of 4096 MB and 1/8 of volume space.

  • cdc_free_space_check_interval_msis frequency with which we re-calculate the space taken up bycdc_raw_directoryto prevent burning CPU cycles unnecessarily when at capacity.

Enabling CDC on Table

Once CDC is enabled on the Cassandra node, each table must be be explicitly enabled for CDC as well via the CREATE TABLE or ALTER TABLE command. For example:

CREATE TABLE foo (a int, b text, PRIMARY KEY(a)) WITH cdc=true; ALTER TABLE foo WITH cdc=true;

How the Cassandra Connector Works

这s section goes into detail about how the Cassandra connector performs snapshots, transforms commit log events into Debezium change events, handles commit log life cycle, records events into Kafka, manages schema evolution, and behaves when things go wrong.

Snapshots

When the Cassandra connector first starts on a Cassandra node, it will by default perform an initial snapshot of the cluster. This is the default mode, since most of the time CDC is enabled on non-empty tables and commit logs do not contain the complete history.

The snapshot reader issues a SELECT statement to query all the columns in a table. Cassandra allows consistency level to be set either globally or on the statement level. For snapshotting, the consistency level is set on the statement level toALL在默认情况下提供最高的一致性。这s implies if one node goes down during the snapshot, the snapshot would not be able to continue and a subsequent re-snapshot is required once the node has been brought back online. You can adjust the consistency level of the snapshot to a lower consistency level in order to increase availability, provided that you understand the tradeoff with consistency.

卡桑德拉3。阅读stric X,它是不可能的tly from the local Cassandra node. Starting in Cassandra 4.0, aNODE_LOCALconsistency level will be added. This will allow the Cassandra connector to read from the node it resides in only (which would be consistent with the way commit logs are processed).

Unlike relational databases, there is no read lock applied during a snapshot, so writes to Cassandra are not blocked during that snapshot. If the queried data has been modified by another client during the snapshot, those changes may be reflected in the snapshot result set.

If the connector fails or stops before the snapshot is completed, the connector will begin a new snapshot upon restarts. In the default snapshot mode (initial), once the connector completes its initial snapshot, it will no longer perform any additional snapshots. The only exception would be during a connector restart: if cdc is enabled on a table, and then the connector is restarted, that table would be snapshotted.

The second snapshot mode (always) allows the connetor to perform snapshot whenever necessary. it will check periodically for newly cdc-enabled tables, and snapshot them as soon as they are detected.

The third snapshot mode ('never') ensures the connector never performs snapshots. When a new connector is configured this way, it will only read the commit log in the CDC directory. This is not the default behavior because starting a new connector in this mode (without a snapshot) requires the commit logs to contain the entire history of all cdc-enabled tables, which is often not the case. Another use case for this mode is if there is one connector already doing the snapshotting, you can disable snapshot on others to avoid duplicated work.

Reading the Commit Log

The Cassandra connector will typically spend the vast majority of its time reading local commit logs on the Cassandra node.

Commit logs' binary data are deserialized with Cassandra’s CommitLogReader and CommitLogReadHandler. Each deserialized object is called amutationin Cassandra. Amutationcontains one or more change events.

As the Cassandra connector reads the commit log, it transform the log events into Debeziumcreate,update, ordelete甚至ts that include the position in the commit log where the event was found. The Cassandra connector encode these change events with Kafka Connect converters and publish them to the appropriate Kafka topics.

Limitations of Commit Logs

Cassandra’s commit logs come with a set of limitations, which are critical for interpreting CDC events correctly:

  • Commit logs only arrive incdc_rawdirectory when it is full, in which case it would be flushed/discarded. This implies there is a delay between when the event is logged and when the event is captured.

  • Commit logs on an individual Cassandra node do not reflect all writes to the cluster, they only reflect writes stored on that node. This is why it is necesssary to monitor changes on all nodes in a Cassandra cluster. However, due to replication factor, this also implies it is necessary for downstream consumers of these events to handle deduplication.

  • Writes to an individual Cassandra node are logged as they arrive. However, these events may arrive out-of-order from which they are issued. Downstream consumers of these events must understand and implement logic similar to Cassandra’s read path to get the correct output.

  • Schema changes of tables are not recorded in commit logs, only data changes are recorded. Therefore changes in schema are detected on a best-effort basis. To avoid data loss, it is recommended to pause writes to the table during schema change.

  • Cassandra does not perform read-before-write, as a result commit logs do not record the value of every column in the changed row, it only records the values of columns that have been modified (except for partition key columns, which are always recorded as they are required in Cassandra DML commands).

  • Due to the nature of CQL,insert摘要可能导致一行插入或更新;updateDMLs can result in a row insertion, update, or deletion;deleteDMLs can result in a row update or deletion. Since queries are not recorded in commit logs, CDC event type is classified based on the effect on the row in a relational database sense.

TODO: is there a way to determine event type which corresponds to the actual Cassandra DML statement? and if so, is that preferred over the semantic of these events?

In Cassandra 4.0 on every segment fsync, an index file will be updated to reflect latest offset. This will eliminate the processing delay in the CDC feature in Cassandra 3.X. This connector feature is to be added in the future with the Cassandra 4.0 release.

Managing Commit Log Lifecycle

By default, Cassandra connector will delete commit logs which have been processed. It is not recommended to start the connector while deletion of commit logs is disabled, as this could bloat up disk storage and prevent further writes to the Cassandra cluster. To manage the commit logs in a custom manner (i.e. upload it to a cloud provider), the CommitLogTransfer interface can be implemented.

Topics names

The Cassandra connector writes events for all insert, update, and delete uperations on a single table to a single Kafka topic. The name of the Kafka topics always take the formclusterName.keyspaceName.tableName, whereclusterNameis the logical name of the connector as specified with thekafka.topic.prefixconfiguraiton property,keyspaceNameis the name of the keyspace where the operation occurred, andtableNameis the name of the table on which the operation occurred.

For example, consider a Cassandra installation with aninventorykeyspace that contains four tables:products,products_on_hand,customers, andorders. If the connector monitoring this database were given a logical server name offulfillment, then the connector would produce events on these four Kafka topics:

  • fulfillment.inventory.products

  • fulfillment.inventory.products_on_hand

  • fulfillment.inventory.customers

  • fulfillment.inventory.orders

TODO: for topic name, isclusterName.keyspaceName.tableNameokay? or should it beconnectorName.keyspaceName.tableNameorconnectorName.clusterName.keyspaceName.tableName?

Schema Evolution

DDLs are not recorded in commit logs. When the schema of a table change, this change is issued from one of the Cassandra node and propagated to other nodes via Gossip Protocol. This implies detection of schema changes are achieved on a best-effort basis. This is done by periodically polling the schema of each cdc-enabled table in the cluster via a Cassandra driver, and then update the cached version of the schema. Because of this implementation, if a new column is added to a table and then writes are issued against that column immediately, it is possible that data from that column will not be reflected in the CDC event. This is why it is recommened to pause for some time (configured withschema.refresh.interval.ms) after issuing a schema change.

TODO: it may be possible to reactively refresh schema whenever an unexpect column appears in a mutation to improve schema change detection; worth looking into.

When sending a message to a topic, the Kafka Connect schema for the key and the value will be automatically registered in the Confluent Schema Registry under the subject t-key and t-value, respectively, if the compatibility test passes. Although it is possible to replay a history of all table schemas via the Schema Registry, only the latest schema of each table is used to generate CDC events.

TODO: look into whether it is possible to leverage schema history to rebuild schema that exist at the specific position in the commit log, rather than the current schema, when restarting the connector. I don’t think it is possible right now, because writes to Cassandra node are not received in order.

Events

All data change events produced by the Cassandra connector have a key and a value, although the structure of the key and value depends on the table from which the change events originated (seeTopic Names).

Change Event’s Key

For a given table, the change event’s key will have a structure that contains a field for each column in the primary key of the table at the time the event was created. Consider aninventorydatabase with acustomerstable defined as:

CREATE TABLE customers ( id bigint, registration_date timestamp, first_name text, last_name text, email text, PRIMARY KEY (id, registration_date) );

Every change event for thecustomerstable while it has this definition will feature the same key schema, which in JSON representation looks like this:

{ "type": "record", "name": "cassandra-cluster-1.inventory.customers.Key", "namespace": "io.debezium.connector.cassandra", "fields": [ { "name": "id", "type": "long" }, { "name": "registration_date", "type": "long", "logicalType": "timestamp-millis" } ] }

For id = 1001 and registration_date = 1562202942545, the key payload in JSON representation would look like this:

{ "id": 1001, "registration_date": 1562202942545 }

Although thecolumn.exclude.listconfiguration property allows you to remove columns from the event values, all columns in a primary key are always included in the event’s key.

Change event’s value

The value of the change event message is a bit more complicated. Every change event value produced by Cassandra connector has an envelope structure with the following fields:

  • opis a mandatory field that contains a string value describing the type of operation. Values for the Cassandra connector areifor insert,ufor update, anddfor delete.

  • afteris an optional field that if present contains the state of the rowafter事件发生。圣ructure will be described by thecassandra-cluster-1.inventory.customers.ValueKafka Connect schema, which represent the cluster, keyspace, and table the event is referring to.

  • sourceis a mandatory field that contains a structure describing the source metadata for the event, which in the case of Cassandra contains several fields: the Debezium version, the connector name, the Cassandra cluster name, the name of the commit log file where the event was recorded, the position in that commit log file where the event appeared, whether this event was part of a snapshot, name of the affected keyspace and table, and the maximum timestamp of the partition update in microseconds.

  • ts_msis optional and if present contains the time (using the system clock in the JVM running the Cassandra connector) at which the connector processed the event.

Note that there is nobeforefield. This is because Cassandra does not perform a read-before-write, therefore the commit log does not contain row values before the change is applied.

The following is a JSON representation of a value schema for acreate甚至t for ourcustomerstable:

{ "type": "record", "name": "cassandra-cluster-1.inventory.customers.Value", "namespace": "io.debezium.connector.cassandra", "fields": [ { "name": "op", "type": "string" }, { "name": "ts_ms", "type": "long", "logicalType": "timestamp-millis" }, { "name": "after", "type": "record", "fields": [ { "name": "id", "type": [ "null", { "name": "id", "type": "record", "fields": [ { "name":"value", "type": "string" }, { "name":"deletion_ts", "type": ["null", "long"], "default" : "null" }, { "name":"set", "type": "boolean" } ] } ] }, { "name": "registration_date", "type": [ "null", { "name": "registration_date", "type": "record", "fields": [ { "name":"value", "type": "long", "logical_type": "timestamp-millis" }, { "name":"deletion_ts", "type": ["null", "long"], "default" : "null" }, { "name":"set", "type": "boolean" } ] } ] }, { "name": "first_name", "type": [ "null", { "name": "first_name", "type": "record", "fields": [ { "name":"value", "type": "string" }, { "name":"deletion_ts", "type": ["null", "long"], "default" : "null" }, { "name":"set", "type": "boolean" } ] } ] }, { "name": "last_name", "type": [ "null", { "name": "last_name", "type": "record", "fields": [ { "name":"value", "type": "string" }, { "name":"deletion_ts", "type": ["null", "long"], "default" : "null" }, { "name":"set", "type": "boolean" } ] } ] }, { "name": "last_name", "type": [ "null", { "name": "email", "type": "record", "fields": [ { "name":"value", "type": "string" }, { "name":"deletion_ts", "type": ["null", "long"], "default" : "null" }, { "name":"set", "type": "boolean" } ] } ] } ] }, { "name": "source", "type": "record", "fields": [ { "name": "version", "type": "string" }, { "name": "connector", "type": "string" }, { "name": "cluster", "type": "string" }, { "name": "snapshot", "type": "boolean" }, { "name": "keyspace", "type": "string" }, { "name": "table", "type": "string" }, { "name": "file", "type": "string" }, { "name": "position", "type": "int" }, { "name": "ts_micro", "type": "long", "logicalType": "timestamp-micros" } ] } ] }

TODO: verify max timestamp != deletion timestamp in case of deletion DDLs

Given the followinginsertDML:

插入客户(id、registration_date冷杉st_name, last_name, email) VALUES ( 1001, now(), "Anne", "Kretchmar", "annek@noanswer.org" );

The value payload in JSON representation would look like this:

{ "op": "c", "ts_ms": 1562202942832, "after": { "id": { "value": 1001, "deletion_ts": null, "set": true }, "registration_date": { "value": 1562202942545, "deletion_ts": null, "set": true }, "first_name": { "value": "Anne", "deletion_ts": null, "set": true }, "last_name": { "value": "Kretchmar", "deletion_ts": null, "set": true }, "email": { "value": "annek@noanswer.org", "deletion_ts": null, "set": true } }, "source": { "version": "0.9.5.Final", "connector": "cassandra", "cluster": "cassandra-cluster-1", "snapshot": false, "keyspace": "inventory", "table": "customers", "file": "commitlog-6-123456.log", "pos": 54, "ts_micro": 1562202942666382 } }

Given the followingupdateDML:

UPDATE customers SET email = "annek_new@noanswer.org" WHERE id = 1001 AND registration_date = 1562202942545

The value payload in JSON representation would look like this:

{ "op": "u", "ts_ms": 1562202942912, "after": { "id": { "value": 1001, "deletion_ts": null, "set": true }, "registration_date": { "value": 1562202942545, "deletion_ts": null, "set": true }, "first_name": null, "last_name": null, "email": { "value": "annek_new@noanswer.org", "deletion_ts": null, "set": true } }, "source": { "version": "0.9.5.Final", "connector": "cassandra", "cluster": "cassandra-cluster-1", "snapshot": false, "keyspace": "inventory", "table": "customers", "file": "commitlog-6-123456.log", "pos": 102, "ts_micro": 1562202942666490 } }

When we compare this to the value in theinsert甚至t, we see a couple differences:

  • Theopfield value is nowu, signifying that this row changed because of an update.

  • Theafterfield now has the updated state of the row, and here we can see that the email value is nowannek_new@noanswer.org. Notice thatfirst_nameandlast_nameare null, this is because these fields did not change during this update. However,idandregistration_dateare still included, because these are the primary keys of this table.

  • Thesourcefield structure has the same fields as before, but the values are different since this event is from a different position in the commit log.

  • Thets_msshows the timestamp milliseconds which the connector processed this event.

Finally, given the followingdeleteDML:

DELETE FROM customers WHERE id = 1001 AND registration_date = 1562202942545;

The value payload in JSON representation would look like this:

{ "op": "d", "ts_ms": 1562202942912, "after": { "id": { "value": 1001, "deletion_ts": 1562202972545, "set": true }, "registration_date": { "value": 1562202942545, "deletion_ts": 1562202972545, "set": true }, "first_name": null, "last_name": null, "email": null }, "source": { "version": "0.9.5.Final", "connector": "cassandra", "cluster": "cassandra-cluster-1", "snapshot": false, "keyspace": "inventory", "table": "customers", "file": "commitlog-6-123456.log", "pos": 102, "ts_micro": 1562202942666490 } }

When we compare this to the value in theinsertandupdate甚至t, we see a couple differences:

  • Theopfield value is nowd, signifying that this row changed because of a deletion.

  • Theafterfield only contains values foridandregistration_datebecause this is a deletion by primary keys.

  • Thesourcefield structure has the same fields as before, but the values are different since this event is from a different position in the commit log.

  • Thets_msshows the timestamp milliseconds which the connector processed this event.

TODO:鉴于TTL目前不支持,会better to remove delete_ts? would it also be okay to derive whether a field is set or not by looking at the each column to see if it is null?

TODO: discuss tombstone events in Cassandra connector

Data Types

As described above, the Cassandra connector represents the changes to rows with events that are structured like the table in which the row exist. The event contains a field for each column value, and how that value is represented in the event depends on the Cassandra data type of the column. This section describes this mapping.

The following table describes how the connector maps each of the Cassandra data types to an Kafka Connect data type.

Cassandra Data Type

Literal Type (Schema Type)

Semantic Type (Schema Name)

ascii

string

n/a

bigint

int64

n/a

blob

bytes

n/a

boolean

boolean

n/a

counter

int64

n/a

date

int32

io.debezium.time.Date

decimal

float64

n/a

double

float64

n/a

float

float32

n/a

frozen

bytes

n/a

inet

string

n/a

int

int32

n/a

list

array

n/a

map

map

n/a

set

array

n/a

smallint

int16

n/a

text

string

n/a

time

int64

n/a

timestamp

int64

io.debezium.time.Timestamp

timeuuid

string

io.debezium.data.Uuid

tinyint

int8

n/a

tuple

map

n/a

uuid

string

io.debezium.data.Uuid

varchar

string

n/a

varint

int64

n/a

duration

int64

io.debezium.time.NanoDuration(an approximate representation of the duration value in nano-seconds)

TODO: add logical types

When Things Go Wrong

Configuration And Startup Errors

The Cassandra connector will fail upon startup, report error or exception in the log, and stop running if the configurations are invalid or if the connector cannot successfully connector to Cassandra using the specified connectivity parameters. In this case, the error will have more details about the problem and possibly suggest a work around. The connector can be restarted when the configuration has been corrected.

Cassandra Becomes Unavailable

Once the connector is running, if the Cassandra node becomes unavailable for any reason, the connector will fail and stop. In this case, restart the connector once the server becomes available. If this happened during snapshot, it will rebootstrap the entire table from the beginning of the table.

Cassandra Connector Stops Gracefully

If the Cassandra connector is gracefully shut down, prior to stopping the process it will make sure to flush all events in the ChangeEventQueue to Kafka. The Cassandra connector keeps track of the filename and offset each time a streamed record is send to Kafka. So when the connector is restarted, it will resume from where it left off. It does this by searching for the oldest commit log in the directory, start processing that commitlog, skipping the already-read records, until it finds the most recent record that hasn’t been processed. If the Cassandra connector is stopped during snapshot, it will pick up from that table, but will rebootstrap the entire table.

Cassandra Connector Crashes

If the Cassandra connector crashes unexpected, then the Cassandra connector would likely have terminated without recording the most-recently processed offset. In this case, when the connector is restarted, it will resume from the most recent recorded offset. This means duplicates is likely (which is trivial since we already be get duplicates from RF). Note that since the offset is only updated when a record has been successfully send to Kafka, it is okay to lose the un-emitted data in the ChangeEventQueue during a crash, as these events will be recreated.

Kafka Becomes Unavailable

As the connector generate change event, it will publish those events to Kafka using Kafka producer API. If Kafka broker becomes unavailable (producer encounters TimeoutException), the Cassandra connector will repeatedly attempt to reconnect to the broker once per second until a successful retry.

Cassandra connector is Stopped for a Duration

Depending on the write load of a table, when a Cassandra connector is stopped for a long time, it risks into hitting the cdc_total_space_in_mb capacity. Once this upper limit is reached, Cassandra will stop accepting writes for this table; which means it is important to monitor this space while running the Cassandra connector. In the worst case scenario when this happens, the best thing to do is to (1) turn off Cassandra connector (2) disable cdc for the table so it stops generating additional writes (although writes to other cdc-enabled tables on the same node could still affect the commitlog file generation given the commit logs are not filtered) (3) remove the recorded offset from the offset file (4) once the capacity is increased or the directory used space is under control, restart the connector so it will rebootstrap the table.

Cassandra Table CDC is Enabled, Then Temporarily Disabled, And Then Enabled Again

If a Cassandra table temporarily disables CDC and then re-enables it again after some time, it must be re-bootstrapped. To re-bootstrap an individual table, you can manually remove the recorded offset line corresponding to that table from snapshot_offset.properties file.

Deploying A Connector

The Cassandra connector should be deployed each Cassandra node in a Cassandra cluster. The Cassandra connector Jar file takes in a cdc configuration (.properties) file. Seesee example configurationsfor reference.

Example configuration

The following represents an example .properties configuration file for running and testing the Cassandra Connector locally:

connector.name=test_connector commit.log.relocation.dir=/Users/test_user/debezium-connector-cassandra/test_dir/relocation/ http.port=8000 cassandra.config=/usr/local/etc/cassandra/cassandra.yaml cassandra.hosts=127.0.0.1 cassandra.port=9042 kafka.producer.bootstrap.servers=127.0.0.1:9092 kafka.producer.retries=3 kafka.producer.retry.backoff.ms=1000 kafka.topic.prefix=test_prefix key.converter=io.confluent.connect.avro.AvroConverter key.converter.schema.registry.url: http://localhost:8081 value.converter=io.confluent.connect.avro.AvroConverter value.converter.schema.registry.url: http://localhost:8081 offset.backing.store.dir=/Users/test_user/debezium-connector-cassandra/test_dir/ snapshot.consistency=ONE snapshot.mode=ALWAYS latest.commit.log.only=true

监控

Cassandra connector has built-in support for JMX metrics. The Cassandra driver also publishes a number of metrics about the driver’s activities that can be monitored through JMX. The connector has two types of metrics. Snapshot metrics help you monitor the snapshot activity and are available when the connector is performing a snapshot. Binlog metrics help you monitor the progress and activity while the connector reads the Cassandra commit logs.

Snapshot Metrics

Attribute Name

Type

Description

total-table-count

int

The total number of tables that are being included in the snapshot.

remaining-table-count

int

The number of tables that the snapshot has yet to copy.

snapshot-running

boolean

Whether the snapshot was started.

snapshot-aborted

boolean

Whether the snapshot was aborted.

snapshot-completed

boolean

Whether the snapshot completed.

snapshot-during-in-seconds

long

The total number of seconds that the snapshot has taken so far, even if not complete.

rows-scanned

Map

Map containing the number of rows scanned for each table in the snapshot. Tables are incrementally added to the Map during processing. Updates every 10,000 rows scanned and upon completing a table.

Commitlog Metrics

Attribute Name

Type

Description

commitlog-filename

string

The name of the commit log filename that the connector has most recently read.

commitlog-position

long

The most recent position (in bytes) within the commit log that the connector has read.

number-of-processed-mutations

long

The number of mutations that have been processed.

number-of-unrecoverable-errors

long

The number of unrecoverable errors while processing commit logs.

Connector properties

Property

Default

Description

snapshot.mode

INITIAL

Specifies the criteria for running a snapshot (eg. initial sync) upon startup of the cassandra connector agent. Must be one of 'INITIAL', 'ALWAYS', or 'NEVER'. The default snapshot mode is 'INITIAL'.

snapshot.consistency

ALL

Specify the {@link ConsistencyLevel} used for the snapshot query.

http.port

8000

The port used by the HTTP server for ping, health check, and build info

cassandra.config

The absolute path of the YAML config file used by a Cassandra node.

cassandra.hosts

localhost

One or more addresses of Cassandra nodes that driver uses to discover topology, separated by ","

cassandra.port

9042

The port used to connect to Cassandra host(s).

cassandra.username

The username used when connecting to Cassandra hosts.

cassandra.password

The password used when connecting to Cassandra hosts.

cassandra.ssl.enabled

false

If set to true, Cassandra connector agent will use SSL to connect to Cassandra node.

cassandra.ssl.config.path

The SSL config file path required for storage node.

commit.log.relocation.dir

The local directory which commit logs get relocated to once processed.

commit.log.post.processing.enabled

true

Determines whether or not the CommitLogPostProcessor should run. If disabled, commit logs would not be deleted post-process.

commit.log.transfer.class

io.debezium.connector.cassandra.BlackHoleCommitLogTransfer

The fully qualified {@link CommitLogTransfer} class used to transfer commit logs. Built-in transfers areBlackHoleCommitLogTransferandGCSCommitLogTransfer.

remote.commit.log.relocation.dir

The remote base directory to transfer commit log to. Required to be specified if GCSCommitLogTransfer is used as COMMIT_LOG_TRANSFER_CLASS. For example: "gcs://bucket-name/prefix-name".

storage.credential.key.file

The path of the storage key file used for setting up credential to access remote storage service. If {@link GCSCommitLogTransfer} is used and this config is not provided, then Application Default Credential would be used.

offset.backing.store.dir

The directory to store offset tracking files.

offset.flush.interval.ms

0

The minimum amount of time to wait before committing the offset. The default value of 0 implies the offset will be flushed every time.

max.offset.flush.size

100

The maximum records that are allowed to be processed until it is required to flush offset to disk. This config is effective only if offset_flush_interval_ms != 0.

max.queue.size

8192

Positive integer value that specifies the maximum size of the blocking queue into which change events read from the commit log are placed before they are written to Kafka. This queue can provide back pressure to the commit log reader when, for example, writes to Kafka are slower or if Kafka is not available. Events that appear in the queue are not included in the offsets periodically recorded by this connector. Defaults to 8192, and should always be larger than the maximum batch size specified in the max.batch.size property. The capacity of the queue to hold deserialized records before they are converted to Kafka Connect structs and emitted to Kafka.

max.batch.size

2048

The maximum number of change events to dequeue each time.

poll.interval.ms

1000

Positive integer value that specifies the number of milliseconds the commit log processor should wait during each iteration for new change events to appear in the queue. Defaults to 1000 milliseconds, or 1 second.

schema.refresh.interval.ms

10000

Positive integer value that specifies the number of milliseconds the schema processor should wait before refreshing the cached Cassandra table schemas.

cdc.dir.poll.interval.ms

10000

The maximum amount of time to wait on each poll before reattempt.

snapshot.scan.interval.ms

10000

Positive integer value that specifies the number of milliseconds the snapshot processor should wait before re-scanning tables to look for new cdc-enabled tables. Defaults to 10000 milliseconds, or 10 seconds.

tombstones.on.delete

false

Whether deletion events should have a subsequent tombstone event (true) or not (false). It’s important to note that in Cassandra, two events with the same key may be updating different columns of a given table. So this could potentially result in records being lost during compaction if they have not been consumed by the consumer yet. In other words, do NOT set this to true if you have Kafka compaction turned on.

A comma-separated list of fully-qualified names of fields that should be excluded from change event message values. Fully-qualified names for fields are in the form keyspace_name>...

sanitize.field.names

truewhen connector configuration explicitly specifies thekey.converterorvalue.converterparameters to use Avro, otherwise defaults tofalse.

字段名是否遵守消毒Avro naming requirements. SeeAvro namingfor more details.

The connector also supports pass-through configuration properties that are used when creating the Kafka producer. Specifically, all connector configuration properties that begin with thekafka.producer.prefix are used (without the prefix) when creating the Kafka producer that writes events to Kafka.

For example, the follwoing connector configuration properties can be used tosecure connections to the Kafka broker:

kafka.producer.security.protocol=SSL kafka.producer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks kafka.producer.ssl.keystore.password=test1234 kafka.producer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks kafka.producer.ssl.truststore.password=test1234 kafka.producer.ssl.key.password=test1234 kafka.consumer.security.protocol=SSL kafka.consumer.ssl.keystore.location=/var/private/ssl/kafka.server.keystore.jks kafka.consumer.ssl.keystore.password=test1234 kafka.consumer.ssl.truststore.location=/var/private/ssl/kafka.server.truststore.jks kafka.consumer.ssl.truststore.password=test1234 kafka.consumer.ssl.key.password=test1234

Be sure to consult theKafka documentationfor all of the configuration properties for Kafka producers.

The connector supports the following Kafka Connect converters for key/value serialization:

io.confluent.connect.avro.AvroConverter org.apache.kafka.connect.storage.StringConverter org.apache.kafka.connect.json.JsonConverter com.blueapron.connect.protobuf.ProtobufConverter