Apache Cassandra Connector Guide

The Apache Cassandra connector package for apache-cassandra-1.0.0 is currently a legacy-compatible stub. All runtime operations are intentionally non-functional because this connector does not yet implement a Cassandra native driver in backend-next.

Current behavior

Supported operation names:

• query
• insert
• update
• delete
• test

Behavior details:

• query, insert, update, and delete always return a driver-required error because CQL execution is not implemented.
• test first validates host and keyspace with legacy-compatible validation behavior, then returns the same driver limitation error.

Configuration

Configuration parameters are read from integration config (not call payload):

• host (required for test validation): Cassandra cluster host.
• port (optional, default 9042): native protocol port.
• username (optional): cluster username when authentication is enabled.
• password (optional, sensitive): cluster password when authentication is enabled.
• keyspace (required for test validation): default keyspace name.
• timeout_seconds (optional, default 30): connection timeout reserved for future real driver calls.

Example request and current response

curl -X POST "https://api.example.com/api/v1/integrations/<ENTITY_ID>/execute" \
  -H "X-API-Key: <API_KEY>" \
  -H "X-Tenant-ID: <TENANT_ID>" \
  -H "Content-Type: application/json" \
  -d '{
    "operation": "query"
  }'

{
  "success": false,
  "error": {
    "code": "UNKNOWN",
    "message": "Cassandra requires native PHP driver. Use DataStax PHP driver for full implementation.",
    "retriable": false
  },
  "metadata": {
    "processing_time_ms": 2
  }
}

test with missing host or keyspace:

{
  "success": false,
  "error": {
    "code": "VALIDATION",
    "message": "Configuration validation failed",
    "retriable": false
  },
  "metadata": {
    "processing_time_ms": 1
  }
}

Intended future CQL operations

When a native driver is implemented, these operation names are expected to map to CQL execution semantics:

• query: execute read CQL statements.
• insert: execute insert CQL statements.
• update: execute update CQL statements.
• delete: execute delete CQL statements.

Until then, keep credentials in integration configuration rather than step payloads so they stay centralized and protected.

Migration note

This mirrors legacy connector behavior where operation names exist, but execution paths are placeholders that return a native-driver limitation error. If you need real Cassandra integration, implement a connector variant that uses a supported Cassandra client library.

Additional resources

• Apache Cassandra documentation