astronomer.providers.dbt.cloud.hooks.dbt

Module Contents

Classes

DbtCloudHookAsync

Interact with dbt Cloud using the V2 API.

Functions

provide_account_id(func)

Decorator which provides a fallback value for account_id. If the account_id is None or not passed

Attributes

T

astronomer.providers.dbt.cloud.hooks.dbt.T
astronomer.providers.dbt.cloud.hooks.dbt.provide_account_id(func)[source]

Decorator which provides a fallback value for account_id. If the account_id is None or not passed to the decorated function, the value will be taken from the configured dbt Cloud Airflow Connection.

class astronomer.providers.dbt.cloud.hooks.dbt.DbtCloudHookAsync(dbt_cloud_conn_id)[source]

Bases: airflow.hooks.base.BaseHook

Interact with dbt Cloud using the V2 API.

Parameters:

dbt_cloud_conn_id (str) – The ID of the dbt Cloud connection.

conn_name_attr = 'dbt_cloud_conn_id'
default_conn_name = 'dbt_cloud_default'
conn_type = 'dbt_cloud'
hook_name = 'dbt Cloud'
async get_headers_tenants_from_connection()[source]

Get Headers, tenants from the connection details

static get_request_url_params(tenant, endpoint, include_related=None)[source]

Form URL from base url and endpoint url

Parameters:

  • tenant (str) – The tenant domain name which is need to be replaced in base url.

  • endpoint (str) – Endpoint url to be requested.

  • include_related (Optional[List[str]]) – Optional. List of related fields to pull with the run. Valid values are “trigger”, “job”, “repository”, and “environment”.

async get_job_details(run_id, account_id=None, include_related=None)[source]

Uses Http async call to retrieve metadata for a specific run of a dbt Cloud job.

Parameters:

  • run_id (int) – The ID of a dbt Cloud job run.

  • account_id (Optional[int]) – Optional. The ID of a dbt Cloud account.

  • include_related (Optional[List[str]]) – Optional. List of related fields to pull with the run. Valid values are “trigger”, “job”, “repository”, and “environment”.

async get_job_status(run_id, account_id=None, include_related=None)[source]

Retrieves the status for a specific run of a dbt Cloud job.

Parameters:

  • run_id (int) – The ID of a dbt Cloud job run.

  • account_id (Optional[int]) – Optional. The ID of a dbt Cloud account.

  • include_related (Optional[List[str]]) – Optional. List of related fields to pull with the run. Valid values are “trigger”, “job”, “repository”, and “environment”.