Fivetran - Trigger Sync

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

Overview

Immediately execute a sync of a Fivetran connector. The connector must already be set up within the Fivetran interface.

If a sync is already running for the specified connector, it will be stopped and restarted.

This Blueprint will create and store the connector ID used and the time of execution to shipyard-artifacts/fivetran-blueprints/variables/{log_id}_force_sync.pickle

The response for this request will always be stored at shipyard-artifacts/fivetran-blueprints/responses/sync_{connector_id}_response.json

Variables

Name	Reference	Type	Required	Default	Options	Description
API Key	FIVETRAN_API_KEY	Password	✅	-	-	Your account's unique API Key for Fivetran.
API Secret	FIVETRAN_API_SECRET	Password	✅	-	-	Your account's unique API Secret for Fivetran.
Connector ID	FIVETRAN_CONNECTOR_ID	Alphanumeric	✅	-	-	The unique ID associated with a connector. Typically two words separated by an underscore.
Force Sync	FIVETRAN_FORCE	Select	✅	TRUE	Enabled: TRUE Disabled: FALSE	Enabling this feature will interrupt any current running jobs
Wait For Completion	FIVETRAN_WAIT	Boolean	➖	TRUE	Enabled: TRUE Disabled: FALSE	Enable if you want the vessel to wait until the sync job is successfully completed. Otherwise, the vessel will only initiate the sync job without waiting

YAML

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

source:
  blueprint: Fivetran - Trigger Sync
  inputs:
    FIVETRAN_API_KEY: null  ## REQUIRED
    FIVETRAN_API_SECRET: null ## REQUIRED
    FIVETRAN_CONNECTOR_ID: null ## REQUIRED
    FIVETRAN_FORCE: 'TRUE' ## REQUIRED
    FIVETRAN_WAIT: 'TRUE'
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '200'
    - '201'
    - '204'
    - '299'