| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | --- | 
					
						
							|  |  |  | title: Run the Stitch Connector Externally | 
					
						
							| 
									
										
										
										
											2025-07-17 11:40:52 +05:30
										 |  |  | description: Set up Stitch ingestion using YAML to automate metadata syncing from ELT sources to your central catalog. | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | slug: /connectors/pipeline/stitch/yaml | 
					
						
							|  |  |  | collate: true | 
					
						
							|  |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% connectorDetailsHeader | 
					
						
							|  |  |  | name="Stitch" | 
					
						
							|  |  |  | stage="PROD" | 
					
						
							|  |  |  | platform="Collate" | 
					
						
							|  |  |  | availableFeatures=["Pipelines", "Lineage"] | 
					
						
							|  |  |  | unavailableFeatures=["Owners", "Tags", "Pipeline Status"] | 
					
						
							|  |  |  | / %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | In this section, we provide guides and references to use the Stitch connector. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Configure and schedule Stitch metadata and profiler workflows from the OpenMetadata UI: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - [Requirements](#requirements) | 
					
						
							|  |  |  | - [Metadata Ingestion](#metadata-ingestion) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/stitch/yaml"} /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | ## Requirements
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | To extract metadata from Stitch, User first need to crate API crednetials: | 
					
						
							|  |  |  | - `Token`: Token to access Stitch metadata. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Python Requirements
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/python-requirements.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | To run the Stitch ingestion, you will need to install: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | pip3 install "openmetadata-ingestion[stitch]" | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Metadata Ingestion
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | All connectors are defined as JSON Schemas. | 
					
						
							|  |  |  | [Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/pipeline/stitchConnection.json) | 
					
						
							|  |  |  | you can find the structure to create a connection to Stitch. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 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](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### 1. Define the YAML Config
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | This is a sample config for Stitch: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codePreview %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeInfoContainer %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #### Source Configuration - Service Connection
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeInfo srNumber=1 %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | **hostPort**: The hostname or IP address with the REST API enabled eg.`https://api.stitchdata.com` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% /codeInfo %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeInfo srNumber=2 %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | **token**: Token to get access to Stitch metadata. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% /codeInfo %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/pipeline/source-config-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/ingestion-sink-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/workflow-config-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | {% /codeInfoContainer %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeBlock fileName="filename.yaml" %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml {% isCodeBlock=true %} | 
					
						
							|  |  |  | source: | 
					
						
							|  |  |  |   type: stitch | 
					
						
							|  |  |  |   serviceName: stitch_data | 
					
						
							|  |  |  |   serviceConnection: | 
					
						
							|  |  |  |     config: | 
					
						
							|  |  |  |       type: Stitch | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | ```yaml {% srNumber=1 %} | 
					
						
							|  |  |  |         hostPort: "https://api.stitchdata.com" | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | ```yaml {% srNumber=2 %} | 
					
						
							|  |  |  |         token: "token" | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/pipeline/source-config.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/ingestion-sink.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/workflow-config.md" /%} | 
					
						
							| 
									
										
										
										
											2024-11-22 19:03:13 +05:30
										 |  |  | 
 | 
					
						
							|  |  |  | {% /codeBlock %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% /codePreview %} | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-06-27 12:22:38 +05:30
										 |  |  | {% partial file="/v1.9/connectors/yaml/ingestion-cli.md" /%} |