Skip to main content
Cassandra

Cassandra

BETA
In this section, we provide guides and references to use the Cassandra connector. Configure and schedule Cassandra metadata workflows from the OpenMetadata UI:

​
How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

To extract metadata using the Cassandra connector, ensure the user in the connection has the following permissions:
  • Read Permissions: The ability to query tables and perform data extraction.
  • Schema Operations: Access to list and describe keyspaces and tables.

​
Python Requirements

We have support for Python versions 3.9-3.11
To run the Cassandra ingestion, you will need to install: 
pip3 install "openmetadata-ingestion[cassandra]"

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Cassandra. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is modeled around the following JSON Schema

​
1. Define the YAML Config

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.

​
Securing Cassandra Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata and a Cassandra database, you can use any SSL mode provided by Cassandra, except disable. Under Advanced Config, after selecting the SSL mode, provide the CA certificate, SSL certificate and SSL key. 
      sslMode: allow
      sslConfig:
            caCertificate: "/path/to/ca/certificate"
            sslCertificate: "/path/to/ssl/certificate"
            sslKey: "/path/to/ssl/key"