Skip to main content

Fivetran - Execute Sync and Check Status

Overview​

First time using this Blueprint? Make sure you follow our Fivetran authorization guide.​

This is considered an "all-in-one" Blueprint that Executes a Sync and checks the status of the sync until it's is finished. By using this Blueprint, you will accumulate runtime as the Vessel continuously waits for the job to be completed. The tradeoff is that results may be quicker and the setup/complexity is less.

If you want to reduce the overall runtime you're billed for, you will need to instead set up a Fleet with Vessels built with these Blueprints in this order: Execute Sync -> Check Sync Status

A Vessel built with this Blueprint will sync a connector in Fivetran and check for the status every 30 seconds. Once the status is confirmed to be completed, the script will stop. The final status of this Vessel in Shipyard will reflect the status of the run in Fivetran.

Recommended Setup:

Before using this Blueprint on a connector, we strongly recommend first setting your connector to a manual schedule, using the Update Connector Blueprint. This setting cannot be updated in the Fivetran UI. This will ensure that Fivetran only syncs the connector when Shipyard kicks it off. Without this setting in place, it is possible to have conflicting syncs.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
API KeyFIVETRAN_API_KEYPassword✅--Your account's unique API Key for Fivetran.
API SecretFIVETRAN_API_SECRETPassword✅--Your account's unique API Secret for Fivetran.
Connector IDFIVETRAN_CONNECTOR_IDAlphanumeric✅--The unique ID associated with a connector. Typically two words separated by an underscore.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: Fivetran - Execute Sync and Check Status
  inputs:
    FIVETRAN_API_KEY: null ## REQUIRED
    FIVETRAN_API_SECRET: null ## REQUIRED
    FIVETRAN_CONNECTOR_ID: null ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0s
  runtime_cutoff: 4h0m0s
  exclude_exit_code_ranges:
    - "0"