Apache Cassandra Tool
Apache Cassandra NoSQL database operations via the DataStax Java Driver v4.
Tool ID
cassandra
Credential Required
Yes — Cassandra cluster connection.
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
contactPoints |
string | — | Required. Comma-separated node addresses (e.g., node1,node2,node3) |
port |
integer | 9042 |
CQL native transport port |
datacenter |
string | datacenter1 |
Local datacenter for token-aware routing |
login |
string | — | Username (blank = no auth) |
password |
string | — | Password |
ssl |
boolean | false |
Enable SSL/TLS |
truststorePath |
string | — | Path to Java truststore (.jks) |
truststorePassword |
string | — | Truststore password |
consistencyLevel |
string | LOCAL_QUORUM |
Default consistency: ANY, ONE, TWO, THREE, QUORUM, ALL, LOCAL_QUORUM, EACH_QUORUM, SERIAL, LOCAL_SERIAL, LOCAL_ONE |
Operations
1. execute — Run CQL statement
Executes any CQL statement (DDL, DML, or query).
| Property | Type | Default | Description |
|---|---|---|---|
statement |
string | — | Required. CQL statement |
Published: rowCount (for queries) or applied (for mutations)
2. export — Query results to file
| Property | Type | Default | Description |
|---|---|---|---|
statement |
string | — | Required. CQL SELECT statement |
outputFile |
string | — | Required. Output file path |
delimiter |
string | comma |
Delimiter: comma, tab, pipe, other |
customDelimiter |
string | — | Custom delimiter |
hasHeader |
boolean | true |
Include column header |
maxRows |
integer | 0 |
Max rows (0 = all) |
nullFormat |
string | — | String for null values |
Published: rowCount, outputFile
3. import — Load file into table
| Property | Type | Default | Description |
|---|---|---|---|
inputFile |
string | — | Required. Input file path |
keyspace |
string | — | Required. Target keyspace |
table |
string | — | Required. Target table |
delimiter |
string | comma |
Delimiter |
hasHeader |
boolean | true |
File has header row |
batchSize |
integer | 50 |
Rows per unlogged batch |
maxErrors |
integer | 0 |
Max errors before stopping (0 = unlimited) |
skipRows |
integer | 0 |
Data rows to skip |
maxRows |
integer | 0 |
Max rows to import (0 = all) |
nullFormat |
string | — | String that represents null |
timestampFormat |
string | yyyy-MM-dd HH:mm:ss.SSSZ |
Timestamp parsing format |
Published: rowCount, errors, inputFile
Behavior: Auto-detects column types from table metadata. Uses unlogged batches for performance. Supports all CQL data types: text, int, bigint, float, double, boolean, uuid, timeuuid, decimal, varint, inet, smallint, tinyint, blob (Base64).
4. list-keyspaces — List all keyspaces
Published: keyspaces (comma-separated), count
5. list-tables — List tables in a keyspace
| Property | Type | Default | Description |
|---|---|---|---|
keyspace |
string | — | Required. Keyspace name |
Published: keyspace, tables (comma-separated), count
6. describe — Get table schema
| Property | Type | Default | Description |
|---|---|---|---|
keyspace |
string | — | Required. Keyspace name |
table |
string | — | Required. Table name |
Published: keyspace, table, partitionKeys, clusteringKeys, columnCount
Killable
Yes — closes the CQL session.
Technology
DataStax Java Driver v4.17 — production-grade, async-capable, automatic node discovery, token-aware routing.
Chaining Patterns
- Cassandra export → Email — export data, email the file
- SQL export → Cassandra import — migrate relational data to Cassandra
- Cassandra export → SQL import — migrate Cassandra data to relational DB
- list-keyspaces → list-tables → describe — schema discovery chain
Error Handling
- Import: configurable
maxErrorsthreshold before stopping - Import: per-row error messages logged in debug mode
- Import: type mismatches reported with column index and expected type
- Export: progress logged every 10,000 rows
operation
Which action the step performs against the keyspace. Required, and there is no default: it decides what every other field on the step means, so a step that omits it has no verb rather than a missing argument.
Call describe(cassandra) for the exact values this build accepts — reflected from the bean at
runtime, so it cannot drift from what the executor will take.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
appliedclusteringKeyscolumnCountcolumnscounterrorsinputFilekeyspacekeyspacesoperationoutputFilepartitionKeysrowCountrowsrowsPublishedtabletablestruncated
Fields not documented above
Generated from this tool's own schema and published outputs on 2026-09-03. A field the README omits is discoverable only by reading the source, and a published key nothing documents is a capability nobody can reference.
Also published: columns, rowsPublished, truncated