package
Version:
v0.13.0
Opens a new window with list of versions in this module.
Published: Apr 19, 2026
License: Apache-2.0
Opens a new window with license information.
Imports: 9
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
Apache Cassandra
Extract table metadata from a Cassandra server.
Usage
source:
name: cassandra
config:
user_id: admin
password: "1234"
host: localhost
port: 9042
exclude:
keyspaces: [mykeyspace]
tables: [mykeyspace_2.tableName_1]
Configuration
| Key |
Type |
Required |
Description |
user_id |
string |
Yes |
User ID to access the Cassandra server. |
password |
string |
Yes |
Password for the Cassandra server. |
host |
string |
Yes |
Host address of the Cassandra server. |
port |
int |
Yes |
Port number of the Cassandra server. |
exclude.keyspaces |
[]string |
No |
List of keyspaces to exclude. System keyspaces are excluded by default. |
exclude.tables |
[]string |
No |
List of tables to exclude, in keyspace.table format. |
Entities
- Entity type:
table
- URN format:
urn:cassandra:{scope}:table:{keyspace}.{table}
| Property |
Type |
Description |
properties.columns |
[]object |
List of column objects. |
properties.columns[].name |
string |
Column name. |
properties.columns[].data_type |
string |
Column data type. |
Edges
This extractor does not emit edges.
Contributing
Refer to the contribution guidelines for information on contributing to this module.
Documentation
¶
type Config struct {
UserID string `json:"user_id" yaml:"user_id" mapstructure:"user_id" validate:"required"`
Password string `json:"password" yaml:"password" mapstructure:"password" validate:"required"`
Host string `json:"host" yaml:"host" mapstructure:"host" validate:"required"`
Port int `json:"port" yaml:"port" mapstructure:"port" validate:"required,gte=1,lte=65535"`
Exclude Exclude `json:"exclude" yaml:"exclude" mapstructure:"exclude"`
}
Config holds the set of configuration for the cassandra extractor
type Exclude struct {
Keyspaces []string `json:"keyspaces" yaml:"keyspaces" mapstructure:"keyspaces"`
Tables []string `json:"tables" yaml:"tables" mapstructure:"tables"`
}
type Extractor struct {
}
Extractor manages the extraction of data from cassandra
New returns a pointer to an initialized Extractor Object
Extract checks if the extractor is configured and
if the connection to the DB is successful
and then starts the extraction process
Init initializes the extractor
Source Files
¶
Click to show internal directories.
Click to hide internal directories.