cassandra sink Cassandra Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send data to an Apache Cassandra cluster.

This Kamelet expects JSON Array formatted data. The content of the JSON Array is used as input for the CQL Prepared Statement set in the query parameter.

Configuration Options

The following table summarizes the configuration options available for the cassandra-sink Kamelet:

Property Name Description Type Default Example

connectionHost

Connection Host

Required The hostname(s) for the Cassandra server(s). Use a comma to separate multiple hostnames.

string

localhost

connectionPort

Connection Port

Required The port number(s) of the cassandra server(s). Use a comma to separate multiple port numbers.

string

9042

keyspace

Keyspace

Required The keyspace to use.

string

customers

query

Query

Required The query to execute against the Cassandra cluster table.

string

consistencyLevel

Consistency Level

The consistency level to use.

Enum values:

* ANY * ONE * TWO * THREE * QUORUM * ALL * LOCAL_QUORUM * EACH_QUORUM * LOCAL_ONE

string

ANY

extraTypeCodecs

Extra Type Codecs

To use a specific comma separated list of Extra Type codecs.

Enum values:

* BLOB_TO_ARRAY * BOOLEAN_LIST_TO_ARRAY * BYTE_LIST_TO_ARRAY * SHORT_LIST_TO_ARRAY * INT_LIST_TO_ARRAY * LONG_LIST_TO_ARRAY * FLOAT_LIST_TO_ARRAY * DOUBLE_LIST_TO_ARRAY * TIMESTAMP_UTC * TIMESTAMP_MILLIS_SYSTEM * TIMESTAMP_MILLIS_UTC * ZONED_TIMESTAMP_SYSTEM * ZONED_TIMESTAMP_UTC * ZONED_TIMESTAMP_PERSISTED * LOCAL_TIMESTAMP_SYSTEM * LOCAL_TIMESTAMP_UTC

string

password

Password

The password for accessing a secured Cassandra cluster.

string

prepareStatements

Prepare Statements

If true, specifies to use PreparedStatements as the query. If false, specifies to use regular Statements as the query.

boolean

true

username

Username

The username for accessing a secured Cassandra cluster.

string

Dependencies

At runtime, the cassandra-sink Kamelet relies upon the presence of the following dependencies:

  • camel:jackson

  • camel:kamelet

  • camel:cassandraql

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the cassandra-sink.

Knative sink

You can use the cassandra-sink Kamelet as a Knative sink by binding it to a Knative object.

cassandra-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: cassandra-sink-pipe
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: cassandra-sink
    properties:
      connectionHost: localhost
      connectionPort: "9042"
      keyspace: customers
      query: The Query

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the cassandra-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f cassandra-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel -p "sink.connectionHost=localhost" -p "sink.connectionPort=9042" -p "sink.keyspace=customers" -p "sink.query=The Query" cassandra-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka sink

You can use the cassandra-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

cassandra-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: cassandra-sink-pipe
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: cassandra-sink
    properties:
      connectionHost: localhost
      connectionPort: "9042"
      keyspace: customers
      query: The Query

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the cassandra-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f cassandra-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "sink.connectionHost=localhost" -p "sink.connectionPort=9042" -p "sink.keyspace=customers" -p "sink.query=The Query" cassandra-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/cassandra-sink.kamelet.yaml

Back to top