Skip to main content
Last updated on

Configure job parameters

Configure job parameters in the Databricks workspace UI, or add them to the JSON and YAML definitions used with the REST API, CLI, and Declarative Automation Bundles. See Jobs API, Databricks CLI, and What are Declarative Automation Bundles?.

What are job parameters?​

Job parameters are key-value pairs that allow you to parameterize jobs with default static or dynamic values. You can optionally override parameters configured in a job when triggering a new run. See Run a job with different parameters.

Job parameter keys can only contain _ - . or alphanumeric characters. Parameter values are set as strings or dynamic value references. See Dynamic value references.

note

A job parameter value can be any valid JSON, including arrays. For how tasks consume JSON-array parameters, see Configure task parameters.

Add or edit job parameters​

Use the Job parameters dialog to add new parameters, edit existing parameter keys and values, or delete parameters.

To edit parameters with the workspace UI, select an existing job using the following steps:

  1. In your Databricks workspace's sidebar, click Jobs & Pipelines.
  2. Optionally, select the Jobs and Owned by me filters.
  3. Click your job's Name link.
  4. In the Job details sidebar, click Edit parameters. The Job parameters dialog appears.
  5. Add or edit parameters using Key and Value fields.
  6. Click the Trash to remove a parameter.
  7. Click Save to apply your changes.
note

Click { } to list available dynamic value references. Select an option from the list to insert it into the Value field.

Job parameter pushdown​

Job parameters are pushed to different task types in different ways. To understand how they are passed, and how to access them within the task, see Access parameter values from a task.

important

For tasks that take key-value parameters, job parameters are pushed down automatically, and if a job parameter and a task parameter share a key, the job parameter takes precedence. Tasks that take JSON-array parameters don't receive job parameters automatically; reference them explicitly with {{job.parameters.<name>}}. See Configure task parameters.

Run a job with different parameters​

You can override configured job parameters or add new ones when you run a job with different parameters. See Run a job with different settings.

You can also override job parameters when you repair a job run. See Re-run failed and skipped tasks.

On this page