mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-07 00:58:46 +00:00
96c65e7ebd
* remove spaCy dependencies from setup.py * Spacy, PII and Processor dependencies removed Co-authored-by: Ayush Shah <ayush@getcollate.io>
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
---
|
|
description: This design doc will walk through developing a connector for OpenMetadata
|
|
---
|
|
|
|
# Build a Connector
|
|
|
|
Ingestion is a simple python framework to ingest the metadata from various sources.
|
|
|
|
Please look at our framework [APIs](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/api)
|
|
|
|
## Workflow
|
|
|
|
[workflow](https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/src/metadata/ingestion/api/workflow.py) is a simple orchestration job that runs the components in an Order.
|
|
|
|
A workflow consists of [Source](source.md) and [Sink](sink.md). It also provides support for [Stage](stage.md) and [BulkSink](bulksink.md).
|
|
|
|
Workflow execution happens in a serial fashion.
|
|
|
|
1. The **Workflow** runs the **source** component first. The **source** retrieves a record from external sources and emits the record downstream.
|
|
2. If the **processor** component is configured, the **workflow** sends the record to the **processor** next.
|
|
3. There can be multiple **processor** components attached to the **workflow**. The **workflow** passes a record to each **processor** in the order they are configured.
|
|
4. Once a **processor** is finished, it sends the modified record to the **sink**.
|
|
5. The above steps are repeated for each record emitted from the **source**.
|
|
|
|
In the cases where we need aggregation over the records, we can use the **stage** to write to a file or other store. Use the file written to in **stage** and pass it to **bulk sink** to publish to external services such as **openmetadata** or **elasticsearch**.
|
|
|
|
{% content-ref url="setup.md" %}
|
|
[setup.md](setup.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="source.md" %}
|
|
[source.md](source.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="sink.md" %}
|
|
[sink.md](sink.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="stage.md" %}
|
|
[stage.md](stage.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="bulksink.md" %}
|
|
[bulksink.md](bulksink.md)
|
|
{% endcontent-ref %}
|