Databricks SDK for JavaScript
    Preparing search index...

    Interface SqlTask

    interface SqlTask {
        parameters?: Record<string, string>;
        sqlTaskType?:
            | { $case: "query"; query: SqlTaskQuery }
            | { $case: "dashboard"; dashboard: SqlTaskDashboard }
            | { $case: "alert"; alert: SqlTaskAlert }
            | { $case: "file"; file: SqlTaskFile };
        warehouseId?: string;
    }
    Index

    Properties

    parameters? sqlTaskType? warehouseId?

    Properties

    parameters?: Record<string, string>

    Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.

    sqlTaskType?:
        | { $case: "query"; query: SqlTaskQuery }
        | { $case: "dashboard"; dashboard: SqlTaskDashboard }
        | { $case: "alert"; alert: SqlTaskAlert }
        | { $case: "file"; file: SqlTaskFile }

    Type Declaration

    • { $case: "query"; query: SqlTaskQuery }
      • $case: "query"
      • query: SqlTaskQuery

        If query, indicates that this job must execute a SQL query.

    • { $case: "dashboard"; dashboard: SqlTaskDashboard }
      • $case: "dashboard"
      • dashboard: SqlTaskDashboard

        If dashboard, indicates that this job must refresh a SQL dashboard.

    • { $case: "alert"; alert: SqlTaskAlert }
      • $case: "alert"
      • alert: SqlTaskAlert

        If alert, indicates that this job must refresh a SQL alert.

    • { $case: "file"; file: SqlTaskFile }
      • $case: "file"
      • file: SqlTaskFile

        If file, indicates that this job runs a SQL file in a remote Git repository.

    warehouseId?: string

    The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs.

    Settings

    Member Visibility

    On This Page

    Properties