Breadcrumbs

dbt Cloud - Check Run Status (Deprecated)

Overview

This Blueprint has been deprecated. Please use the vendor's "Trigger" Blueprint and set the "Wait for Completion" option to "True". Using this new option is free, more stable, and will complete faster. Read more about this change [here](https://www.shipyardapp.com/blog/orchestrate-data-tools-free). Check for the status of a single run on dbt Cloud. The Vessel's exit code and status will match the status of the dbt Cloud run. - If the run is not completed, the Vessel will return an exit code of 255, an error. - If the run has completed with an error, the Vessel will return an exit code of 1, an error. - If the run has completed, but was canceled, the Vessel will return an exit code of 2, an error. - If the run has completed successfully, the Vessel will return an exit code of 0, interpreted by Workflows as Successful. The response for this request will always be stored at _shipyard-artifacts/dbtcloud-blueprints/responses/run_RUNID_response.json_ **Recommended Setup:** 1. A Vessel built with this Blueprint should be paired with guardrail retries. This will allow the Vessel to continually check for status until a final result is found. 2. This Vessel should run immediately after a Vessel built with the _dbt Cloud - Execute Job_ Blueprint. With this setup, you can leave the Run ID field blank and this Vessel will check for the results of the recently created run.

Variables

Name

Reference

Type

Required

Default

Options

Description

Service Token

DBT_API_KEY

Password

None

-

Your unique service token for dbt Cloud. Instructions for how to get this token can be found in the authorization documentation.

Account ID

DBT_ACCOUNT_ID

Alphanumeric

None

-

Your unique Account ID, found in the URL of dbt Cloud. https://cloud.getdbt.com/#/accounts/ACCOUNT_ID/projects/PROJECT_ID/dashboard/

Run ID

DBT_RUN_ID

Alphanumeric

None

-

The ID of a specific job you want to run, found in the URL of dbt Cloud. https://cloud.getdbt.com/#/accounts/ACCOUNT_ID/projects/PROJECT_ID/runs/RUN_ID/. If left blank, will try to find the run ID from an "Execute Job" Vessel that ran upstream.

YAML

Below is the YAML template

YAML

source:
  template: dbt Cloud - Check Run Status (Deprecated)
  inputs:
    DBT_API_KEY:
    DBT_ACCOUNT_ID:
    DBT_RUN_ID:
  type: TEMPLATE
guardrails:
  retry_count: 10
  retry_wait: 0h5m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 211
    - 212