Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

​
prefect_dbt.cloud.credentials

Module containing credentials for interacting with dbt Cloud

​
Classes

​
DbtCloudCredentials

Credentials block for credential use across dbt Cloud tasks and flows. Attributes:
  • api_key: API key to authenticate with the dbt Cloud administrative API. Refer to the Authentication docs for retrieving the API key.
  • account_id: ID of dbt Cloud account with which to interact.
  • domain: Domain at which the dbt Cloud API is hosted.
Examples: Load stored dbt Cloud credentials: 
from prefect_dbt.cloud import DbtCloudCredentials

dbt_cloud_credentials = DbtCloudCredentials.load("BLOCK_NAME")
Use DbtCloudCredentials instance to trigger a job run: 
from prefect_dbt.cloud import DbtCloudCredentials

credentials = DbtCloudCredentials(api_key="my_api_key", account_id=123456789)

async with dbt_cloud_credentials.get_administrative_client() as client:
    client.trigger_job_run(job_id=1)
Load saved dbt Cloud credentials within a flow: 
from prefect import flow

from prefect_dbt.cloud import DbtCloudCredentials
from prefect_dbt.cloud.jobs import trigger_dbt_cloud_job_run


@flow
def trigger_dbt_cloud_job_run_flow():
    credentials = DbtCloudCredentials.load("my-dbt-credentials")
    trigger_dbt_cloud_job_run(dbt_cloud_credentials=credentials, job_id=1)

trigger_dbt_cloud_job_run_flow()
Methods:

​
get_administrative_client 

get_administrative_client(self) -> DbtCloudAdministrativeClient
Returns a newly instantiated client for working with the dbt Cloud administrative API. Returns:
  • An authenticated dbt Cloud administrative API client.

​
get_client 

get_client(self, client_type: Literal['administrative', 'metadata']) -> Union[DbtCloudAdministrativeClient, DbtCloudMetadataClient]
Returns a newly instantiated client for working with the dbt Cloud API. Args:
  • client_type: Type of client to return. Accepts either ‘administrative’ or ‘metadata’.
Returns:
  • The authenticated client of the requested type.

​
get_metadata_client 

get_metadata_client(self) -> DbtCloudMetadataClient
Returns a newly instantiated client for working with the dbt Cloud metadata API. Returns:
  • An authenticated dbt Cloud metadata API client.