OpenMetadata Ingestion is a Python framework designed to build connectors and ingest metadata from various external systems into an OpenMetadata instance via its APIs. It is commonly used within orchestration frameworks like Apache Airflow to automate metadata extraction and is actively maintained with frequent releases, often tied to OpenMetadata server versions. The current version is 1.12.5.1.
pip install "openmetadata-ingestion==1.12.5.1"Verified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates a basic metadata ingestion workflow using the `MetadataWorkflow` class. It shows how to define a minimal workflow configuration in YAML, including the OpenMetadata server connection details and using an environment variable for the JWT token for authentication. Replace `sample-data` with your actual connector configuration (e.g., `mysql`, `snowflake`). Ensure your OpenMetadata server is running and accessible.
Ensure that `openmetadata-ingestion` is installed with a version compatible with your OpenMetadata server version, typically using a tilde-equals `~=` version specifier (e.g., `pip install "openmetadata-ingestion~=1.12.5"`).
Always upgrade the `openmetadata-ingestion` package to match your OpenMetadata server version, especially after server upgrades, to ensure schema compatibility.
Update your OpenLineage Kinesis connector configurations to use the new `brokerConfig` object structure.
Refer to the official documentation for the updated REST connector connection structure and adjust your YAML configurations accordingly.
Ensure your Python environment is running a supported version (3.9, 3.10, or 3.11). It's recommended to use a virtual environment.