Cassandra

Cassandra source connector

Description

Read data from Apache Cassandra.

Key features

• batch
• stream
• exactly-once
• column projection
• parallelism
• support user-defined split

Options

name	type	required	default value
host	String	Yes	-
keyspace	String	Yes	-
cql	String	No *	-
tables_configs	List\<Map>	No *	-
username	String	No	-
password	String	No	-
datacenter	String	No	datacenter1
consistency_level	String	No	LOCAL_ONE

* Exactly one of cql or tables_configs must be provided.

host [string]

Cassandra cluster address, the format is host:port , allowing multiple hosts to be specified. Such as "cassandra1:9042,cassandra2:9042".

keyspace [string]

The Cassandra keyspace.

cql [String]

The query CQL used to read data from Cassandra. Use this for single-table reads. Mutually exclusive with tables_configs.

tables_configs [List\<Map>]

Multi-table read configuration. Each entry must contain a cql field with the query for that table. Mutually exclusive with cql.

Example entry:

{
  cql = "SELECT id, name FROM keyspace.table1"
}

username [string]

Cassandra user username.

password [string]

Cassandra user password.

datacenter [String]

The Cassandra datacenter, default is datacenter1.

consistency_level [String]

The Cassandra read consistency level, default is LOCAL_ONE.

Examples

Single-table mode

source {
  Cassandra {
    host = "localhost:9042"
    username = "cassandra"
    password = "cassandra"
    datacenter = "datacenter1"
    keyspace = "test"
    cql = "SELECT * FROM test.source_table"
    plugin_output = "source_table"
  }
}

Multi-table mode

source {
  Cassandra {
    host = "localhost:9042"
    username = "cassandra"
    password = "cassandra"
    datacenter = "datacenter1"
    keyspace = "test"
    tables_configs = [
      {
        cql = "SELECT id, name FROM test.table1"
      },
      {
        cql = "SELECT id, value FROM test.table2"
      }
    ]
  }
}

Changelog

Change Log

Change	Commit	Version
[improve] cassandra connector options (#8608)	https://github.com/apache/seatunnel/commit/d9201108cf	2.3.10
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)	https://github.com/apache/seatunnel/commit/6b7c53d03c	2.3.9
[Improve] Improve some connectors prepare check error message (#7465)	https://github.com/apache/seatunnel/commit/6930a25edd	2.3.8
[Improve][Common] Introduce new error define rule (#5793)	https://github.com/apache/seatunnel/commit/9d1b2582b2	2.3.4
[Improve] Remove use SeaTunnelSink::getConsumedType method and mark it as deprecated (#5755)	https://github.com/apache/seatunnel/commit/8de7408100	2.3.4
[Feature][Connector V2] expose configurable options in Cassandra (#3681)	https://github.com/apache/seatunnel/commit/73f63a5044	2.3.2
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd601051	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab166561	2.3.1
[Feature][API & Connector & Doc] add parallelism and column projection interface (#3829)	https://github.com/apache/seatunnel/commit/b9164b8ba1	2.3.1
[Improve][Connector-V2] The log outputs detailed exception stack information (#3805)	https://github.com/apache/seatunnel/commit/d0c6217f27	2.3.1
[Improve][Connector-V2][Cassandra] Unified exception for cassandra source & sink connector (#3435)	https://github.com/apache/seatunnel/commit/28868797b7	2.3.0
[Feature][Connector-V2][Cassandra] Add Cassandra Source And Sink Connector (#3229)	https://github.com/apache/seatunnel/commit/12268a6f4b	2.3.0