connectors

No menu items for this category
Home/Connectors/Database/Iceberg/Yaml
Iceberg
Iceberg
BETA
Available In
Feature List
Metadata
Owners
Query Usage
Data Profiler
Data Quality
Lineage
Column-level Lineage
dbt
Tags
Stored Procedures

In this section, we provide guides and references to use the Iceberg connector.

Configure and schedule Greenplum metadata and profiler 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

The requirements actually depend on the Catalog and the FileSystem used. In a nutshell, the used credentials must have access to reading the Catalog and the Metadata File.

Glue Catalog

Must have glue:GetDatabases, and glue:GetTables permissions to be able to read the Catalog.

Must also have the s3:GetObject permission for the location of the Iceberg tables.

DynamoDB Catalog

Must have dynamodb:DescribeTable and dynamodb:GetItem permissions on the Iceberg Catalog table.

Must also have the s3:GetObject permission for the location of the Iceberg tables.

Hive / REST Catalog

It depends on where and how the Hive / Rest Catalog is setup and where the Iceberg files are stored.

Python Requirements

We have support for Python versions 3.8-3.11

To run the Iceberg ingestion, you will need to install:

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Greenplum.

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

This is a sample config for Iceberg using a Glue Catalog:

Source Configuration - Service Connection

  • name: Enter the catalog name of choice.
  • awsAccessKeyId: Enter your secure access key ID for your AWS connection.
  • awsSecretAccessKey: Enter the Secret Access Key (the passcode key pair to the key ID from above).
  • awsSessionToken (optional): Enter the Session Access Token (used if using short lived credentials).
  • awsRegion: Specify the AWS region used.
  • databaseName (optional): Enter the database name of choice. If not it will be set as 'default'.
  • ownershipProperty (optional): Property to use when searching for the owner. It defaults to 'owner'.

Source Configuration - Source Config

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.

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.

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

Sink Configuration

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

Workflow Configuration

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.

filename.yaml
This is a sample config for Iceberg using a DynamoDB Catalog:
Source Configuration - Service Connection
  • name: Enter the catalog name of choice.
  • tableName: Enter the name of the table where the Iceberg Catalog is stored.
  • awsAccessKeyId: Enter your secure access key ID for your AWS connection.
  • awsSecretAccessKey: Enter the Secret Access Key (the passcode key pair to the key ID from above).
  • awsSessionToken (optional): Enter the Session Access Token (used if using short lived credentials).
  • awsRegion: Specify the AWS region used.
  • databaseName (optional): Enter the database name of choice. If not it will be set as 'default'.
  • ownershipProperty (optional): Property to use when searching for the owner. It defaults to 'owner'.
Source Configuration - Source Config
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.
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.
incremental (beta): Incremental Extraction configuration. Currently implemented for:
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.
Workflow Configuration
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.
filename.yaml
This is a sample config for Iceberg using a Hive Catalog:
Source Configuration - Service Connection
  • name: Enter the catalog name of choice.
  • uri: Enter the uri to the Hive Metastore. Example: 'thrift://localhost:9083'.
  • fileSystem (Optional): Enter the specific configuration given the file system used to store the Iceberg files.
    • Local: No configuration needed
    • S3 (Or S3 Compatible):
      • awsAccessKeyId: Enter your secure access key ID for your AWS connection.
      • awsSecretAccessKey: Enter the Secret Access Key (the passcode key pair to the key ID from above).
      • awsSessionToken (optional): Enter the Session Access Token (used if using short lived credentials).
      • awsRegion: Specify the AWS region used.
      • endPointURL: EndPoint URL to use with AWS.
    • Azure:
      • clientId : Client ID of the data storage account
      • clientSecret : Client Secret of the account
      • tenantId : Tenant ID under which the data storage account falls
      • accountName : Account Name of the data Storage
  • databaseName (optional): Enter the database name of choice. If not it will be set as 'default'.
  • ownershipProperty (optional): Property to use when searching for the owner. It defaults to 'owner'.
Source Configuration - Source Config
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.
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.
incremental (beta): Incremental Extraction configuration. Currently implemented for:
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.
Workflow Configuration
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.
filename.yaml
This is a sample config for Iceberg using a REST Catalog:
Source Configuration - Service Connection
  • name: Enter the catalog name of choice.
  • uri: Enter the uri to the Rest Catalog. Example: 'http://localhost:8181'.
  • credential (Optional): OAuth2 Credential to use for Authentication flow.
    • clientId: OAuth2 Client ID.
    • clientSecret: OAuth2 Client Secret.
  • token (Optional): Enter the Bearer token for the 'Authorization' header.
  • ssl (Optional): Needed configuration for SSL.
    • caCertPath: CA Certificate Path.
    • clientCertPath: Client Certificate Path.
    • privateKeyPath: Private Key Path.
  • sigv4 (Optional): Used if signing requests using AWS SigV4 protocol.
    • signingRegion : AWS Region used when signing a request.
    • signingName : Name used to sign the request with.
  • fileSystem (Optional): Enter the specific configuration given the file system used to store the Iceberg files.
    • Local: No configuration needed
    • S3 (Or S3 Compatible):
      • awsAccessKeyId: Enter your secure access key ID for your AWS connection.
      • awsSecretAccessKey: Enter the Secret Access Key (the passcode key pair to the key ID from above).
      • awsSessionToken (optional): Enter the Session Access Token (used if using short lived credentials).
      • awsRegion: Specify the AWS region used.
      • endPointURL: EndPoint URL to use with AWS.
    • Azure:
      • clientId : Client ID of the data storage account
      • clientSecret : Client Secret of the account
      • tenantId : Tenant ID under which the data storage account falls
      • accountName : Account Name of the data Storage
  • databaseName (optional): Enter the database name of choice. If not it will be set as 'default'.
  • warehouseLocation (optional): Warehouse Location. Used to specify a custom warehouse location if needed.
Most Catalogs should have a working default warehouse location.
  • ownershipProperty (optional): Property to use when searching for the owner. It defaults to 'owner'.
Source Configuration - Source Config
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.
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.
incremental (beta): Incremental Extraction configuration. Currently implemented for:
Sink Configuration
To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.
Workflow Configuration
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.
filename.yaml
2. Run with the CLI
First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
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 Rest Catalog Connection with SSL in OpenMetadata
When using SSL to establish secure connections between OpenMetadata and Rest Catalog, you can specify the caCertificate to provide the CA certificate used for SSL validation. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: ssl_key, ssl_cert, and ssl_ca. In this case, ssl_cert is used for the client’s SSL certificate, ssl_key for the private key associated with the SSL certificate, and ssl_ca for the CA certificate to validate the server’s certificate.