.. _cassandra-sink-connector-config:

Configuration Properties
------------------------

To use this connector, specify the name of the connector class in the ``connector.class`` configuration property.

.. codewithvars:: properties

    connector.class=io.confluent.connect.cassandra.CassandraSinkConnector

Connector-specific configuration properties are described below.

Connection
^^^^^^^^^^


``cassandra.contact.points``
  The Cassandra hosts to connect to.

  * Type: List
  * Importance: High
  * Default Value: [localhost]


``cassandra.password``
  The password to connect to Cassandra with.

  * Type: Password
  * Importance: High
  * Default Value: [hidden]


``cassandra.security.enabled``
  Flag to determine if security is enabled.

  * Type: Boolean
  * Importance: High
  * Default Value: true


``cassandra.ssl.enabled``
  Flag to determine if SSL is enabled when connecting to Cassandra.

  * Type: Boolean
  * Importance: High
  * Default Value: false


``cassandra.username``
  The username to connect to Cassandra with.

  * Type: String
  * Importance: High
  * Default Value: cassandra


``cassandra.port``
  The port the Cassandra hosts are listening on.

  * Type: Int
  * Importance: Medium
  * Default Value: 9042
  * Valid Values: ValidPort{start=1025, end=65535}

``cassandra.compression``
  Compression algorithm to use when connecting to Cassandra.

  * Type: String
  * Importance: Low
  * Default Value: NONE
  * Valid Values: [NONE, SNAPPY, LZ4]

Keyspace
^^^^^^^^


``cassandra.keyspace``
  The keyspace to write to.

  * Type: String
  * Importance: High



``cassandra.keyspace.create.enabled``
  Flag to determine if the keyspace should be created if it does not exist.

  * Type: Boolean
  * Importance: High
  * Default Value: true


SSL
^^^


``cassandra.ssl.truststore.password``
  Password to open the Java Truststore with.

  * Type: Password
  * Importance: Medium
  * Default Value: [hidden]
  * Valid Values: Empty String or Absolute path to a file that exists.

``cassandra.ssl.truststore.path``
  Path to the Java Truststore.

  * Type: String
  * Importance: Medium

  * Valid Values: Empty String or Absolute path to a file that exists.

``cassandra.ssl.provider``
  The SSL Provider to use when connecting to Cassandra

  * Type: String
  * Importance: Low
  * Default Value: JDK
  * Valid Values: ``JDK``, ``OPENSSL``, ``OPENSSL_REFCNT``

Table
^^^^^


``cassandra.table.manage.enabled``
  Flag to determine if the connector should manage the table.

  * Type: Boolean
  * Importance: High
  * Default Value: true


``cassandra.table.create.caching``
  Caching setting to use.

  * Type: String
  * Importance: Medium
  * Default Value: NONE
  * Valid Values: ``ALL``, ``KEYS_ONLY``, ``ROWS_ONLY``, ``NONE``

``cassandra.table.create.compression.algorithm``
  Compression algorithm to use when the table is created.

  * Type: String
  * Importance: Medium
  * Default Value: NONE
  * Valid Values: [NONE, SNAPPY, LZ4, DEFLATE]

``cassandra.offset.storage.table``
  The table within the Cassandra keyspace to store the offsets that have been read from |ak-tm|. This is used to enable exactly once delivery to Cassandra.

  * Type: String
  * Importance: Low
  * Default: kafka_connect_offsets

Write
^^^^^


``cassandra.consistency.level``
  The requested consistency level to use when writing to Cassandra.

  * Type: String
  * Importance: High
  * Default Value: LOCAL_QUORUM
  * Valid Values: ``ANY``, ``ONE``, ``TWO``, ``THREE``, ``QUORUM``, ``ALL``, ``LOCAL_QUORUM``, ``EACH_QUORUM``, ``SERIAL``, ``LOCAL_SERIAL``, ``LOCAL_ONE``

``cassandra.deletes.enabled``
  Flag to determine if the connector should process deletes.

  * Type: Boolean
  * Importance: High
  * Default Value: true


``cassandra.write.mode``
  The type of statement to build when writing to Cassandra.

  * Type: String
  * Importance: High
  * Default Value: Insert

``cassandra.execute.timeout.ms``
  The timeout for executing a Cassandra statement.

  * Type: Long
  * Importance: Low
  * Default Value: 30000
  
.. _cassandra-sink-connector-license-config:
  
|cp| license
^^^^^^^^^^^^

``confluent.topic.bootstrap.servers``
A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form <code>host1:port1,host2:port2,...</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).

* Type: list
* Importance: high

``confluent.topic``
Name of the Kafka topic used for Confluent Platform configuration, including licensing information.

* Type: string
* Default: _confluent-command
* Importance: low

``confluent.topic.replication.factor``
The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1).

* Type: int
* Default: 3
* Importance: low

----------------------------
Confluent license properties
----------------------------

.. include:: ../includes/security-info.rst

.. include:: ../includes/platform-license.rst

.. include:: ../includes/security-configs.rst

.. _cassandra-sink-license-topic-configuration:

.. include:: ../includes/platform-license-detail.rst

.. include:: ../includes/overriding-default-config-properties.rst