CassandraConnectorConfig (Debezium Connector for Cassandra 0.10.0.Beta3 API)

java.lang.Object
- io.debezium.connector.cassandra.CassandraConnectorConfig

public class CassandraConnectorConfig
extends Object

All configs used by a Cassandra connector agent.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CassandraConnectorConfig.SnapshotMode
The set of predefined SnapshotMode options.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CassandraConnectorConfig.SnapshotMode` The set of predefined SnapshotMode options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CASSANDRA_CONFIG` The absolute path of the YAML config file used by a Cassandra node.
`static String`	`CASSANDRA_HOSTS` One or more addresses of Cassandra nodes that driver uses to discover topology, separated by ","
`static String`	`CASSANDRA_PASSWORD` The password used when connecting to Cassandra hosts.
`static String`	`CASSANDRA_PORT` The port used to connect to Cassandra host(s).
`static String`	`CASSANDRA_SSL_CONFIG_PATH` The SSL config file path required for storage node.
`static String`	`CASSANDRA_SSL_ENABLED` If set to true, Cassandra connector agent will use SSL to connect to Cassandra node.
`static String`	`CASSANDRA_USERNAME` The username used when connecting to Cassandra hosts.
`static String`	`CDC_DIR_POLL_INTERVAL_MS` The maximum amount of time to wait on each poll before reattempt.
`static String`	`COMMIT_LOG_POST_PROCESSING_ENABLED` Determines whether or not the CommitLogPostProcessor should run.
`static String`	`COMMIT_LOG_RELOCATION_DIR` The local directory which commit logs get relocated to once processed.
`static String`	`COMMIT_LOG_TRANSFER_CLASS` The fully qualified `CommitLogTransfer` class used to transfer commit logs.
`static String`	`COMMIT_LOG_TRANSFER_CONFIG_PREFIX` The prefix for all `CommitLogTransfer` configurations.
`private Map<String,Object>`	`configs`
`static String`	`CONNECTOR_NAME` Logical name for the Cassandra connector.
`static String`	`DEFAULT_CASSANDRA_HOST`
`static int`	`DEFAULT_CASSANDRA_PORT`
`static boolean`	`DEFAULT_CASSANDRA_SSL_ENABLED`
`static int`	`DEFAULT_CDC_DIR_POLL_INTERVAL_MS`
`static boolean`	`DEFAULT_COMMIT_LOG_POST_PROCESSING_ENABLED`
`static String`	`DEFAULT_COMMIT_LOG_TRANSFER_CLASS`
`static int`	`DEFAULT_HTTP_PORT`
`static boolean`	`DEFAULT_LATEST_COMMIT_LOG_ONLY`
`static int`	`DEFAULT_MAX_BATCH_SIZE`
`static int`	`DEFAULT_MAX_OFFSET_FLUSH_SIZE`
`static int`	`DEFAULT_MAX_QUEUE_SIZE`
`static int`	`DEFAULT_OFFSET_FLUSH_INTERVAL_MS`
`static int`	`DEFAULT_POLL_INTERVAL_MS`
`static int`	`DEFAULT_SCHEMA_POLL_INTERVAL_MS`
`static String`	`DEFAULT_SNAPSHOT_CONSISTENCY`
`static String`	`DEFAULT_SNAPSHOT_MODE`
`static int`	`DEFAULT_SNAPSHOT_POLL_INTERVAL_MS`
`static boolean`	`DEFAULT_TOMBSTONES_ON_DELETE`
`static String`	`FIELD_BLACKLIST` A comma-separated list of fully-qualified names of fields that should be excluded from change event message values.
`static String`	`HTTP_PORT` The port used by the HTTP server for ping, health check, and build info
`static String`	`KAFKA_PRODUCER_CONFIG_PREFIX` The prefix prepended to all Kafka producer configurations, including schema registry
`static String`	`KAFKA_TOPIC_PREFIX` Logical name for the Cassandra cluster.
`static String`	`LATEST_COMMIT_LOG_ONLY` Instead of parsing commit logs from CDC directory, this will look for the commit log with the latest modified timestamp in the commit log directory and attempt to process this file only.
`static String`	`MAX_BATCH_SIZE` The maximum number of change events to dequeue each time.
`static String`	`MAX_OFFSET_FLUSH_SIZE` The maximum records that are allowed to be processed until it is required to flush offset to disk.
`static String`	`MAX_QUEUE_SIZE` 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.
`static String`	`OFFSET_BACKING_STORE_DIR` The directory to store offset tracking files.
`static String`	`OFFSET_FLUSH_INTERVAL_MS` The minimum amount of time to wait before committing the offset.
`static String`	`POLL_INTERVAL_MS` 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.
`static String`	`SCHEMA_POLL_INTERVAL_MS` Positive integer value that specifies the number of milliseconds the schema processor should wait before refreshing the cached Cassandra table schemas.
`static String`	`SNAPSHOT_CONSISTENCY` Specify the `ConsistencyLevel` used for the snapshot query.
`static String`	`SNAPSHOT_MODE` Specifies the criteria for running a snapshot (eg.
`static String`	`SNAPSHOT_POLL_INTERVAL_MS` 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.
`static String`	`TOMBSTONES_ON_DELETE` Whether deletion events should have a subsequent tombstone event (true) or not (false).

Constructor Summary

Constructors
Constructor and Description

CassandraConnectorConfig(Map<String,Object> configs)

Constructors
Constructor and Description
`CassandraConnectorConfig(Map<String,Object> configs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`cassandraConfig()`
`String[]`	`cassandraHosts()`
`String`	`cassandraPassword()`
`int`	`cassandraPort()`
`String`	`cassandraSslConfigPath()`
`boolean`	`cassandraSslEnabled()`
`String`	`cassandraUsername()`
`Duration`	`cdcDirPollIntervalMs()`
`String`	`commitLogRelocationDir()`
`Properties`	`commitLogTransferConfigs()`
`String`	`connectorName()`
`String[]`	`fieldBlacklist()`
`CommitLogTransfer`	`getCommitLogTransfer()`
`Properties`	`getKafkaConfigs()`
`int`	`httpPort()`
`String`	`kafkaTopicPrefix()`
`boolean`	`latestCommitLogOnly()`
`int`	`maxBatchSize()`
`long`	`maxOffsetFlushSize()`
`int`	`maxQueueSize()`
`String`	`offsetBackingStoreDir()`
`Duration`	`offsetFlushIntervalMs()`
`Duration`	`pollIntervalMs()`
`boolean`	`postProcessEnabled()`
`Duration`	`schemaPollIntervalMs()`
`com.datastax.driver.core.ConsistencyLevel`	`snapshotConsistencyLevel()`
`CassandraConnectorConfig.SnapshotMode`	`snapshotMode()`
`Duration`	`snapshotPollIntervalMs()`
`boolean`	`tombstonesOnDelete()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONNECTOR_NAME
```
public static final String CONNECTOR_NAME
```
    Logical name for the Cassandra connector. This name should uniquely identify the connector from those that reside in other Cassandra nodes.
    
    See Also:
    
    Constant Field Values
  - KAFKA_TOPIC_PREFIX
```
public static final String KAFKA_TOPIC_PREFIX
```
    Logical name for the Cassandra cluster. This name should be identical across all Cassandra connectors in a Cassandra cluster
    
    See Also:
    
    Constant Field Values
  - KAFKA_PRODUCER_CONFIG_PREFIX
```
public static final String KAFKA_PRODUCER_CONFIG_PREFIX
```
    The prefix prepended to all Kafka producer configurations, including schema registry
    
    See Also:
    
    Constant Field Values
  - SNAPSHOT_MODE
```
public static final String SNAPSHOT_MODE
```
    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'. See for details.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SNAPSHOT_MODE
```
public static final String DEFAULT_SNAPSHOT_MODE
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT_CONSISTENCY
```
public static final String SNAPSHOT_CONSISTENCY
```
    Specify the ConsistencyLevel used for the snapshot query.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SNAPSHOT_CONSISTENCY
```
public static final String DEFAULT_SNAPSHOT_CONSISTENCY
```
    See Also:
    
    Constant Field Values
  - HTTP_PORT
```
public static final String HTTP_PORT
```
    The port used by the HTTP server for ping, health check, and build info
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTP_PORT
```
public static final int DEFAULT_HTTP_PORT
```
    See Also:
    
    Constant Field Values
  - CASSANDRA_CONFIG
```
public static final String CASSANDRA_CONFIG
```
    The absolute path of the YAML config file used by a Cassandra node.
    
    See Also:
    
    Constant Field Values
  - CASSANDRA_HOSTS
```
public static final String CASSANDRA_HOSTS
```
    One or more addresses of Cassandra nodes that driver uses to discover topology, separated by ","
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CASSANDRA_HOST
```
public static final String DEFAULT_CASSANDRA_HOST
```
    See Also:
    
    Constant Field Values
  - CASSANDRA_PORT
```
public static final String CASSANDRA_PORT
```
    The port used to connect to Cassandra host(s).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CASSANDRA_PORT
```
public static final int DEFAULT_CASSANDRA_PORT
```
    See Also:
    
    Constant Field Values
  - CASSANDRA_USERNAME
```
public static final String CASSANDRA_USERNAME
```
    The username used when connecting to Cassandra hosts.
    
    See Also:
    
    Constant Field Values
  - CASSANDRA_PASSWORD
```
public static final String CASSANDRA_PASSWORD
```
    The password used when connecting to Cassandra hosts.
    
    See Also:
    
    Constant Field Values
  - CASSANDRA_SSL_ENABLED
```
public static final String CASSANDRA_SSL_ENABLED
```
    If set to true, Cassandra connector agent will use SSL to connect to Cassandra node.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CASSANDRA_SSL_ENABLED
```
public static final boolean DEFAULT_CASSANDRA_SSL_ENABLED
```
    See Also:
    
    Constant Field Values
  - CASSANDRA_SSL_CONFIG_PATH
```
public static final String CASSANDRA_SSL_CONFIG_PATH
```
    The SSL config file path required for storage node.
    
    See Also:
    
    Constant Field Values
  - COMMIT_LOG_RELOCATION_DIR
```
public static final String COMMIT_LOG_RELOCATION_DIR
```
    The local directory which commit logs get relocated to once processed.
    
    See Also:
    
    Constant Field Values
  - COMMIT_LOG_POST_PROCESSING_ENABLED
```
public static final String COMMIT_LOG_POST_PROCESSING_ENABLED
```
    Determines whether or not the CommitLogPostProcessor should run. If disabled, commit logs would not be deleted post-process, and this could lead to disk storage
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMMIT_LOG_POST_PROCESSING_ENABLED
```
public static final boolean DEFAULT_COMMIT_LOG_POST_PROCESSING_ENABLED
```
    See Also:
    
    Constant Field Values
  - COMMIT_LOG_TRANSFER_CLASS
```
public static final String COMMIT_LOG_TRANSFER_CLASS
```
    The fully qualified CommitLogTransfer class used to transfer commit logs. The default option will delete all commit log files after processing (successful or otherwise). You can extend a custom implementation.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMMIT_LOG_TRANSFER_CLASS
```
public static final String DEFAULT_COMMIT_LOG_TRANSFER_CLASS
```
    See Also:
    
    Constant Field Values
  - COMMIT_LOG_TRANSFER_CONFIG_PREFIX
```
public static final String COMMIT_LOG_TRANSFER_CONFIG_PREFIX
```
    The prefix for all CommitLogTransfer configurations.
    
    See Also:
    
    Constant Field Values
  - OFFSET_BACKING_STORE_DIR
```
public static final String OFFSET_BACKING_STORE_DIR
```
    The directory to store offset tracking files.
    
    See Also:
    
    Constant Field Values
  - OFFSET_FLUSH_INTERVAL_MS
```
public static final String OFFSET_FLUSH_INTERVAL_MS
```
    The minimum amount of time to wait before committing the offset. The default value of 0 implies the offset will be flushed every time.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OFFSET_FLUSH_INTERVAL_MS
```
public static final int DEFAULT_OFFSET_FLUSH_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - MAX_OFFSET_FLUSH_SIZE
```
public static final String MAX_OFFSET_FLUSH_SIZE
```
    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
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_OFFSET_FLUSH_SIZE
```
public static final int DEFAULT_MAX_OFFSET_FLUSH_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_QUEUE_SIZE
```
public static final String MAX_QUEUE_SIZE
```
    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 Record before they are converted to Avro Records and emitted to Kafka.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_QUEUE_SIZE
```
public static final int DEFAULT_MAX_QUEUE_SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_BATCH_SIZE
```
public static final String MAX_BATCH_SIZE
```
    The maximum number of change events to dequeue each time.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_BATCH_SIZE
```
public static final int DEFAULT_MAX_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - POLL_INTERVAL_MS
```
public static final String POLL_INTERVAL_MS
```
    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.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_POLL_INTERVAL_MS
```
public static final int DEFAULT_POLL_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - SCHEMA_POLL_INTERVAL_MS
```
public static final String SCHEMA_POLL_INTERVAL_MS
```
    Positive integer value that specifies the number of milliseconds the schema processor should wait before refreshing the cached Cassandra table schemas.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCHEMA_POLL_INTERVAL_MS
```
public static final int DEFAULT_SCHEMA_POLL_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - CDC_DIR_POLL_INTERVAL_MS
```
public static final String CDC_DIR_POLL_INTERVAL_MS
```
    The maximum amount of time to wait on each poll before reattempt.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CDC_DIR_POLL_INTERVAL_MS
```
public static final int DEFAULT_CDC_DIR_POLL_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT_POLL_INTERVAL_MS
```
public static final String SNAPSHOT_POLL_INTERVAL_MS
```
    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.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SNAPSHOT_POLL_INTERVAL_MS
```
public static final int DEFAULT_SNAPSHOT_POLL_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
  - TOMBSTONES_ON_DELETE
```
public static final String TOMBSTONES_ON_DELETE
```
    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 haven't been consumed by the consumer yet. In other words, do NOT set this to true if you have kafka compaction turned on.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TOMBSTONES_ON_DELETE
```
public static final boolean DEFAULT_TOMBSTONES_ON_DELETE
```
    See Also:
    
    Constant Field Values
  - FIELD_BLACKLIST
```
public static final String FIELD_BLACKLIST
```
    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>.<field_name>.<nested_field_name>.
    
    See Also:
    
    Constant Field Values
  - LATEST_COMMIT_LOG_ONLY
```
public static final String LATEST_COMMIT_LOG_ONLY
```
    Instead of parsing commit logs from CDC directory, this will look for the commit log with the latest modified timestamp in the commit log directory and attempt to process this file only. Only used for Testing!
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LATEST_COMMIT_LOG_ONLY
```
public static final boolean DEFAULT_LATEST_COMMIT_LOG_ONLY
```
    See Also:
    
    Constant Field Values
  - configs
```
private Map<String,Object> configs
```
- Constructor Detail
  - CassandraConnectorConfig
```
public CassandraConnectorConfig(Map<String,Object> configs)
```
- Method Detail
  - connectorName
```
public String connectorName()
```
  - kafkaTopicPrefix
```
public String kafkaTopicPrefix()
```
  - getKafkaConfigs
```
public Properties getKafkaConfigs()
```
  - commitLogTransferConfigs
```
public Properties commitLogTransferConfigs()
```
  - latestCommitLogOnly
```
public boolean latestCommitLogOnly()
```
  - snapshotMode
```
public CassandraConnectorConfig.SnapshotMode snapshotMode()
```
  - snapshotConsistencyLevel
```
public com.datastax.driver.core.ConsistencyLevel snapshotConsistencyLevel()
```
  - httpPort
```
public int httpPort()
```
  - cassandraConfig
```
public String cassandraConfig()
```
  - cassandraHosts
```
public String[] cassandraHosts()
```
  - cassandraPort
```
public int cassandraPort()
```
  - cassandraSslEnabled
```
public boolean cassandraSslEnabled()
```
  - cassandraSslConfigPath
```
public String cassandraSslConfigPath()
```
  - cassandraUsername
```
public String cassandraUsername()
```
  - cassandraPassword
```
public String cassandraPassword()
```
  - commitLogRelocationDir
```
public String commitLogRelocationDir()
```
  - postProcessEnabled
```
public boolean postProcessEnabled()
```
  - getCommitLogTransfer
```
public CommitLogTransfer getCommitLogTransfer()
```
  - offsetBackingStoreDir
```
public String offsetBackingStoreDir()
```
  - offsetFlushIntervalMs
```
public Duration offsetFlushIntervalMs()
```
  - maxOffsetFlushSize
```
public long maxOffsetFlushSize()
```
  - maxQueueSize
```
public int maxQueueSize()
```
  - maxBatchSize
```
public int maxBatchSize()
```
  - pollIntervalMs
```
public Duration pollIntervalMs()
```
  - schemaPollIntervalMs
```
public Duration schemaPollIntervalMs()
```
  - cdcDirPollIntervalMs
```
public Duration cdcDirPollIntervalMs()
```
  - snapshotPollIntervalMs
```
public Duration snapshotPollIntervalMs()
```
  - fieldBlacklist
```
public String[] fieldBlacklist()
```
  - tombstonesOnDelete
```
public boolean tombstonesOnDelete()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CassandraConnectorConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECTOR_NAME

KAFKA_TOPIC_PREFIX

KAFKA_PRODUCER_CONFIG_PREFIX

SNAPSHOT_MODE

DEFAULT_SNAPSHOT_MODE

SNAPSHOT_CONSISTENCY

DEFAULT_SNAPSHOT_CONSISTENCY

HTTP_PORT

DEFAULT_HTTP_PORT

CASSANDRA_CONFIG

CASSANDRA_HOSTS

DEFAULT_CASSANDRA_HOST

CASSANDRA_PORT

DEFAULT_CASSANDRA_PORT

CASSANDRA_USERNAME

CASSANDRA_PASSWORD

CASSANDRA_SSL_ENABLED

DEFAULT_CASSANDRA_SSL_ENABLED

CASSANDRA_SSL_CONFIG_PATH

COMMIT_LOG_RELOCATION_DIR

COMMIT_LOG_POST_PROCESSING_ENABLED

DEFAULT_COMMIT_LOG_POST_PROCESSING_ENABLED

COMMIT_LOG_TRANSFER_CLASS

DEFAULT_COMMIT_LOG_TRANSFER_CLASS

COMMIT_LOG_TRANSFER_CONFIG_PREFIX

OFFSET_BACKING_STORE_DIR

OFFSET_FLUSH_INTERVAL_MS

DEFAULT_OFFSET_FLUSH_INTERVAL_MS

MAX_OFFSET_FLUSH_SIZE

DEFAULT_MAX_OFFSET_FLUSH_SIZE

MAX_QUEUE_SIZE

DEFAULT_MAX_QUEUE_SIZE

MAX_BATCH_SIZE

DEFAULT_MAX_BATCH_SIZE

POLL_INTERVAL_MS

DEFAULT_POLL_INTERVAL_MS

SCHEMA_POLL_INTERVAL_MS

DEFAULT_SCHEMA_POLL_INTERVAL_MS

CDC_DIR_POLL_INTERVAL_MS

DEFAULT_CDC_DIR_POLL_INTERVAL_MS

SNAPSHOT_POLL_INTERVAL_MS

DEFAULT_SNAPSHOT_POLL_INTERVAL_MS

TOMBSTONES_ON_DELETE

DEFAULT_TOMBSTONES_ON_DELETE

FIELD_BLACKLIST

LATEST_COMMIT_LOG_ONLY

DEFAULT_LATEST_COMMIT_LOG_ONLY

configs

Constructor Detail

CassandraConnectorConfig

Method Detail

connectorName

kafkaTopicPrefix

getKafkaConfigs

commitLogTransferConfigs

latestCommitLogOnly

snapshotMode

snapshotConsistencyLevel

httpPort

cassandraConfig

cassandraHosts

cassandraPort

cassandraSslEnabled

cassandraSslConfigPath

cassandraUsername

cassandraPassword

commitLogRelocationDir

postProcessEnabled

getCommitLogTransfer

offsetBackingStoreDir

offsetFlushIntervalMs

maxOffsetFlushSize

maxQueueSize