ContextQMD
Back to Prefect

snowflake

docs/integrations/prefect-dbt/api-ref/prefect_dbt-cli-configs-snowflake.mdx

3.6.30.dev32.1 KB
Original Source

prefect_dbt.cli.configs.snowflake

Module containing models for Snowflake configs

Classes

SnowflakeTargetConfigs <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py#L21" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Target configs contain credentials and settings, specific to Snowflake. To find valid keys, head to the Snowflake Profile page.

Attributes:

  • connector: The connector to use.

Examples:

Load stored SnowflakeTargetConfigs:

python
from prefect_dbt.cli.configs import SnowflakeTargetConfigs

snowflake_target_configs = SnowflakeTargetConfigs.load("BLOCK_NAME")

Instantiate SnowflakeTargetConfigs.

python
from prefect_dbt.cli.configs import SnowflakeTargetConfigs
from prefect_snowflake.credentials import SnowflakeCredentials
from prefect_snowflake.database import SnowflakeConnector

credentials = SnowflakeCredentials(
    user="user",
    password="password",
    account="account.region.aws",
    role="role",
)
connector = SnowflakeConnector(
    schema="public",
    database="database",
    warehouse="warehouse",
    credentials=credentials,
)
target_configs = SnowflakeTargetConfigs(
    connector=connector,
    extras={"retry_on_database_errors": True},
)

Methods:

get_configs <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-dbt/prefect_dbt/cli/configs/snowflake.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
get_configs(self) -> Dict[str, Any]

Returns the dbt configs specific to Snowflake profile.

Returns:

  • A configs JSON.

handle_target_configs <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-dbt/prefect_dbt/cli/configs/base.py#L128" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
handle_target_configs(cls, v: Any) -> Any

Handle target configs field aliasing during validation