username: Username to connect to Cassandra. This user must have the necessary permissions to perform metadata extraction and table queries.

hostPort: When using the cassandra connecion schema, the hostPort parameter specifies the host and port of the Cassandra. This should be specified as a string in the format hostname:port. E.g., localhost:9042.

databaseName: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.

Auth Type: Following authentication types are supported:

1. Basic Authentication: We'll use the user credentials to connect to Cassandra

• password: Password of the user.

2. DataStax Astra DB Configuration: Configuration for connecting to DataStax Astra DB in the cloud.

• secureConnectBundle: File path to the Secure Connect Bundle (.zip) used for a secure connection to DataStax Astra DB.
• token: The Astra DB application token used for authentication.
• connectTimeout: Timeout in seconds for establishing new connections to Cassandra.
• requestTimeout: Timeout in seconds for individual Cassandra requests.

The sourceConfig is defined here:

markDeletedTables: To flag tables as soft-deleted if they are not present anymore in the source system.

markDeletedStoredProcedures: Optional configuration to soft delete stored procedures in OpenMetadata if the source stored procedures are deleted. Also, if the stored procedures is deleted, all the associated entities like lineage, etc., with that stored procedures will be deleted.

includeTables: true or false, to ingest table data. Default is true.

includeViews: true or false, to ingest views definitions.

includeTags: Optional configuration to toggle the tags ingestion.

includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.

includeStoredProcedures: Optional configuration to toggle the Stored Procedures ingestion.

includeDDL: Optional configuration to toggle the DDL Statements ingestion.

overrideMetadata (boolean): Set the 'Override Metadata' toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner and displayName.

queryLogDuration: Configuration to tune how far we want to look back in query logs to process Stored Procedures results.

queryParsingTimeoutLimit: Configuration to set the timeout for parsing the query in seconds.

useFqnForFiltering: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).

databaseFilterPattern, schemaFilterPattern, tableFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here

threads (beta): The number of threads to use when extracting the metadata using multithreading. Please take a look here before configuring this.

databaseMetadataConfigType (string): Database Source Config Metadata Pipeline type.

incremental (beta): Incremental Extraction configuration. Currently implemented for:

• BigQuery
• Redshift
• Snowflake

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.caCertificate with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

ingestionPipelineFQN

Fully qualified name of ingestion pipeline, used to identify the current ingestion pipeline.

Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.

The sslConfig and sslMode are used to configure the SSL (Secure Sockets Layer) connection between your application and the PostgreSQL server.

• caCertificate: Provide the path to ssl ca file.

• sslCertificate: Provide the path to ssl client certificate file (ssl_cert).

• sslKey: Provide the path to ssl client certificate file (ssl_key).

sslMode: This field controls whether a secure SSL/TLS connection will be negotiated with the server. There are several modes you can choose:

disable: No SSL/TLS encryption will be used; the data sent over the network is not encrypted. allow: The driver will try to negotiate a non-SSL connection but if the server insists on SSL, it will switch to SSL. prefer (the default): The driver will try to negotiate an SSL connection but if the server does not support SSL, it will switch to a non-SSL connection. require: The driver will try to negotiate an SSL connection. If the server does not support SSL, the driver will not fall back to a non-SSL connection. verify-ca: The driver will negotiate an SSL connection and verify that the server certificate is issued by a trusted certificate authority (CA). verify-full: The driver will negotiate an SSL connection, verify that the server certificate is issued by a trusted CA and check that the server host name matches the one in the certificate.