Apache Cassandra

marmotdata/cassandra

Discover keyspaces, tables and materialized views from Apache Cassandra clusters

Databases Assets Lineage Experimental

The Cassandra plugin discovers keyspaces, tables and materialized views from Apache Cassandra clusters. It reads the system_schema tables over CQL with the pure-Go gocql driver, so it works with Cassandra 3.0 and later and needs no cgo.

Tables and views are named keyspace.table, the same identity the OpenMetadata plugin projects for a Cassandra service, so the two routes land on one asset.

Required Permissions

The user needs to read the schema tables, plus the keyspaces it should preview sample data from:

CREATE ROLE marmot_reader WITH PASSWORD = 'your-password' AND LOGIN = true;
GRANT SELECT ON KEYSPACE system_schema TO marmot_reader;
GRANT SELECT ON KEYSPACE your_keyspace TO marmot_reader;

Statistics

Column and index counts are reported per table. A row count is not: Cassandra keeps no row estimate and COUNT(*) is a full cluster scan.

Known Gaps

DataStax Astra secure connect bundles are not supported. Connect with hosts and ssl instead.

In the UI

Point-and-click, no config file needed.

1 Open Runs Create pipeline
2 Pick Apache Cassandra from the plugin list.
3 Fill in the wizard, set a schedule, save.

Read the UI guide

With the CLI

Save a YAML config, then run marmot ingest.

ingest.yaml yaml

name: my-cassandra-pipeline
runs:
  - cassandra:
      hosts: []

$ marmot ingest -c ingest.yaml

Read the CLI guide

Not using plugins? Other ways to populate Marmot

Terraform Declare assets as infrastructure-as-code. Pulumi Native TypeScript, Python, or Go resources. Kubernetes Operator Sync assets from Kubernetes custom resources.

Configuration

18 top-level fields. * marks required fields.

tags multiselect

Tags to apply to discovered assets

external_links object[]

External links to show on all assets

name string

Display name for the link

icon string

Icon identifier for the link

url string

URL to the external resource

filter object

Filter discovered assets by name (regex)

include multiselect

Include patterns for resource names (regex)

exclude multiselect

Exclude patterns for resource names (regex)

hosts multiselect

Contact points, as host or host:port

port int

Port for contact points given without one

default: 9042

username string

Username for password authentication

password password

Password for password authentication

datacenter string

Local datacenter; only its nodes are queried when set

ssl bool

Connect over TLS

default: false

ssl_ca_cert string

Path to the CA certificate that signed the server certificate

ssl_skip_verify bool

Skip verification of the server certificate

default: false

connect_timeout_seconds int

Seconds to wait for a connection

default: 10

keyspaces multiselect

Keyspaces to discover; all non-system keyspaces when empty

exclude_system_keyspaces bool

Whether to skip Cassandra's own keyspaces (system, system_schema, system_auth, ...)

default: true

include_columns bool

Whether to include column information in table metadata

default: true

include_views bool

Whether to include materialized views

default: true

include_indexes bool

Whether to include secondary index information

default: true

include_statistics bool

Whether to include column and index counts

default: true

Assets emitted

Metadata this plugin attaches to each discovered asset.

Keyspace

CassandraKeyspaceFields

11 fields

The metadata fields the Cassandra plugin emits for keyspace assets.

keyspace string

Keyspace name

replication_class string

Replication strategy (SimpleStrategy, NetworkTopologyStrategy)

replication_factor int

Replication factor when one applies to the whole keyspace

replication_factors object

Replication factor per datacenter

durable_writes bool

Whether writes go through the commit log

table_count int

Number of tables in the keyspace

view_count int

Number of materialized views in the keyspace

user_types string[]

User-defined types declared in the keyspace

cluster_name string

Cluster name

cassandra_version string

Cassandra release version of the node queried

datacenter string

Datacenter of the node queried

Table

CassandraTableFields

21 fields

The metadata fields emitted for table and materialized view assets.

keyspace string

Keyspace the table belongs to

table_name string

Table or view name

object_type string

Object type (table, view)

id string

Table id

comment string

Table comment

compaction_class string

Compaction strategy

compression_class string

Compressor

default_ttl int

Default time to live in seconds, 0 for none

gc_grace_seconds int

Seconds tombstones are kept before collection

bloom_filter_fp_chance float

Bloom filter false positive chance

caching object

Key and row cache settings

flags string[]

Table flags (compound, counter, dense, super)

is_counter bool

Whether the table holds counter columns

partition_key string[]

Partition key columns in key order

clustering_columns string[]

Clustering columns in key order

clustering_order object

Sort direction (asc, desc) per clustering column

indexes string[]

Secondary index names

index_count int

Number of secondary indexes

base_table string

Table a materialized view is built from

where_clause string

Filter a materialized view applies to its base table

include_all_columns bool

Whether a materialized view selects every base table column

Column

CassandraColumnFields

7 fields

The per-column fields embedded in an asset's schema.

column_name string

Column name

data_type string

CQL type as stored, for example map<text, int> or frozen<address>

is_nullable bool

Whether the column can be null (false for key columns)

is_primary_key bool

Whether the column is part of the partition or clustering key

kind string

Column kind (partition_key, clustering, regular, static)

position int

Index within the partition or clustering key, -1 otherwise

clustering_order string

Sort direction (asc, desc) for clustering columns