providers/databricks/docs/operators/run_now.rst
.. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Use the :class:~airflow.providers.databricks.operators.DatabricksRunNowOperator to trigger a run of an existing Databricks job
via api/2.2/jobs/run-now <https://docs.databricks.com/dev-tools/api/latest/jobs.html#operation/JobsRunNow>_ API endpoint.
Using the Operator ^^^^^^^^^^^^^^^^^^
There are two ways to instantiate this operator. In the first way, you can take the JSON payload that you typically use
to call the api/2.2/jobs/run-now endpoint and pass it directly to our DatabricksRunNowOperator through the json parameter.
Another way to accomplish the same thing is to use the named parameters of the DatabricksRunNowOperator directly.
Note that there is exactly one named parameter for each top level parameter in the jobs/run-now endpoint.
The only required parameters are either:
job_id - to specify ID of the existing Databricks jobjob_name - Name of the existing Databricks job. It will throw exception if job isn't found, of if there are multiple jobs with the same name.All other parameters are optional and described in documentation for DatabricksRunNowOperator. For example, you can pass additional parameters to a job using one of the following parameters, depending on the type of tasks in the job:
notebook_paramspython_paramspython_named_paramsjar_paramsspark_submit_paramsidempotency_tokenrepair_runcancel_previous_runsDeferrable version of the :class:~airflow.providers.databricks.operators.DatabricksRunNowOperator operator.
It allows to utilize Airflow workers more effectively using new functionality introduced in Airflow 2.2.0 <https://airflow.apache.org/docs/apache-airflow/2.2.0/concepts/deferring.html#triggering-deferral>_