Sync

Description

This job triggers a connector using this endpoint.

Use Cases

We recommend creating a Stitch Sync Task for every "source" within Stitch, which should itself have a single connector in Stitch.

This way, you can use Orchestra to trigger your data ingestion on a manual or event based schedule. This has a number of advantages vs. using Stitch's in-built scheduler:

• You can co-ordinate tasks outside of Stitch, like other ingestion tools for connectors Stitch doesn't support, using Orchestra

• When Stitch replication jobs run, Data Warehouse cost is incurred. Running these operations on a schedule you set explicitly ensures these costs do not go out of hand

• We aggregate metadata from the Stitch Task in the same place as the metadata from other operations in your Pipeline

Parameters

These parameters are required to run the Sync Task

Name	Data type	Restrictions	Example
Source ID	Number	N.A.	123456

Error handling

API Requests

If we receive the following error codes from Stitch, we'll raise an error and the task will move to a failed state.

Code	Description	Handling
401	Unauthorised	We will raise an error and parse the raw error message from the Stitch response as the Orchestra message
404	Not Found	We will raise an error with the HTTP Reason as the Orchestra message
Other error code		We will raise an error with the HTTP Reason as the Orchestra message

Job failure

Stitch is built on the open-source Singer Project, which has the concepts of Taps and Targets. Taps extract data, and a Replication Job is a combination of a Tap, a Discovery and an Exit.

From the Stitch docs:

The first phase in the replication process is called Extraction. The start of every extraction is called discovery, and at this time, Stitch detects the tables and columns available in the source. These are the same tables and columns that the Stitch database user - or the database user in the integration’s Integration Details page - has access to.

The Exit Status is only populated as a failure in the event:

"Stitch encounters critical issues during the Extraction phase of the replication process." - Source

Orchestra will fail the job if either of the Tap Status, the Discovery Status or the Exit Status is equal to 1 (i.e., failure).