Databricks SDK for JavaScript
    Preparing search index...

    Interface RunNowRequest

    interface RunNowRequest {
        dbtCommands?: string[];
        idempotencyToken?: string;
        jarParams?: string[];
        jobId?: bigint;
        jobParameters?: Record<string, string>;
        notebookParams?: Record<string, string>;
        only?: string[];
        performanceTarget?: PerformanceTarget_PerformanceTarget;
        pipelineParams?: PipelineParameters;
        pythonNamedParams?: Record<string, string>;
        pythonParams?: string[];
        queue?: QueueSettings;
        sparkSubmitParams?: string[];
        sqlParams?: Record<string, string>;
    }
    Index

    Properties

    dbtCommands? idempotencyToken? jarParams? jobId? jobParameters? notebookParams? only? performanceTarget? pipelineParams? pythonNamedParams? pythonParams? queue? sparkSubmitParams? sqlParams?

    Properties

    dbtCommands?: string[]

    An array of commands to execute for jobs with the dbt task, for example "dbt_commands": ["dbt deps", "dbt seed", "dbt deps", "dbt seed", "dbt run"]

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    idempotencyToken?: string

    An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists, the request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted, an error is returned.

    If you specify the idempotency token, upon failure you can retry until the request succeeds. guarantees that exactly one run is launched with that idempotency token.

    This token must have at most 64 characters.

    For more information, see How to ensure idempotency for jobs.

    jarParams?: string[]

    A list of parameters for jobs with Spark JAR tasks, for example "jar_params": ["john doe", "35"]. The parameters are used to invoke the main function of the main class specified in the Spark JAR task. If not specified upon run-now, it defaults to an empty list. jar_params cannot be specified in conjunction with notebook_params. The JSON representation of this field (for example {"jar_params":["john doe","35"]}) cannot exceed 10,000 bytes.

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    jobId?: bigint

    The ID of the job to be executed

    jobParameters?: Record<string, string>

    Job-level parameters used in the run. for example "param": "overriding_val"

    notebookParams?: Record<string, string>

    A map from keys to values for jobs with notebook task, for example "notebook_params": {"name": "john doe", "age": "35"}. The map is passed to the notebook and is accessible through the dbutils.widgets.get function.

    If not specified upon run-now, the triggered run uses the job’s base parameters.

    notebook_params cannot be specified in conjunction with jar_params.

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    The JSON representation of this field (for example {"notebook_params":{"name":"john doe","age":"35"}}) cannot exceed 10,000 bytes.

    only?: string[]

    A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.

    performanceTarget?: PerformanceTarget_PerformanceTarget

    The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.

    • STANDARD: Enables cost-efficient execution of serverless workloads.
    • PERFORMANCE_OPTIMIZED: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.
    pipelineParams?: PipelineParameters

    Controls whether the pipeline should perform a full refresh

    pythonNamedParams?: Record<string, string>
    pythonParams?: string[]

    A list of parameters for jobs with Python tasks, for example "python_params": ["john doe", "35"]. The parameters are passed to Python file as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field (for example {"python_params":["john doe","35"]}) cannot exceed 10,000 bytes.

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    Important

    These parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error. Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.

    queue?: QueueSettings

    The queue settings of the run.

    sparkSubmitParams?: string[]

    A list of parameters for jobs with spark submit task, for example "spark_submit_params": ["--class", "org.apache.spark.examples.SparkPi"]. The parameters are passed to spark-submit script as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field (for example {"python_params":["john doe","35"]}) cannot exceed 10,000 bytes.

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    Important

    These parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error. Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.

    sqlParams?: Record<string, string>

    A map from keys to values for jobs with SQL task, for example "sql_params": {"name": "john doe", "age": "35"}. The SQL alert task does not support custom parameters.

    ⚠ Deprecation note Use job parameters to pass information down to tasks.

    Settings

    Member Visibility

    On This Page

    Properties