Databricks SDK for JavaScript
    Preparing search index...

    Interface DbtTask

    interface DbtTask {
        catalog?: string;
        commands?: string[];
        profilesDirectory?: string;
        projectDirectory?: string;
        schema?: string;
        source?: Source;
        warehouseId?: string;
    }
    Index

    Properties

    catalog? commands? profilesDirectory? projectDirectory? schema? source? warehouseId?

    Properties

    catalog?: string

    Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks >= 1.1.1.

    commands?: string[]

    A list of dbt commands to execute. All commands must start with dbt. This parameter must not be empty. A maximum of up to 10 commands can be provided.

    profilesDirectory?: string

    Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used.

    projectDirectory?: string

    Path to the project directory. Optional for Git sourced tasks, in which case if no value is provided, the root of the Git repository is used.

    schema?: string

    Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the default schema is used.

    source?: Source

    Optional location type of the project directory. When set to WORKSPACE, the project will be retrieved from the local workspace. When set to GIT, the project will be retrieved from a Git repository defined in git_source. If the value is empty, the task will use GIT if git_source is defined and WORKSPACE otherwise.

    • WORKSPACE: Project is located in workspace.
    • GIT: Project is located in cloud Git provider.
    warehouseId?: string

    ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the --profiles-dir command line argument.

    Settings

    Member Visibility

    On This Page

    Properties