• Home
• Python API Reference
• airflow.models
• airflow.models.dagrun

airflow.models.dagrun

Module Contents

Classes

TISchedulingDecision	Type of return for DagRun.task_instance_scheduling_decisions
DagRun	DagRun describes an instance of a Dag. It can be created

class airflow.models.dagrun.TISchedulingDecision

Bases: NamedTuple

Type of return for DagRun.task_instance_scheduling_decisions

tis :List[airflow.models.taskinstance.TaskInstance]

schedulable_tis :List[airflow.models.taskinstance.TaskInstance]

changed_tis :bool

unfinished_tis :List[airflow.models.taskinstance.TaskInstance]

finished_tis :List[airflow.models.taskinstance.TaskInstance]

class airflow.models.dagrun.DagRun(dag_id=None, run_id=None, queued_at=NOTSET, execution_date=None, start_date=None, external_trigger=None, conf=None, state=None, run_type=None, dag_hash=None, creating_job_id=None, data_interval=None)

Bases: airflow.models.base.Base, airflow.utils.log.logging_mixin.LoggingMixin

DagRun describes an instance of a Dag. It can be created by the scheduler (for regular runs) or by an external trigger

__tablename__ = dag_run

id

dag_id

queued_at

execution_date

start_date

end_date

run_id

creating_job_id

external_trigger

run_type

conf

data_interval_start

data_interval_end

last_scheduling_decision

dag_hash

log_template_id

__table_args__

task_instances

DEFAULT_DAGRUNS_TO_EXAMINE

__repr__(self)

Return repr(self).

property logical_date(self)

get_state(self)

set_state(self, state)

property state(self)

refresh_from_db(self, session=NEW_SESSION)

Reloads the current dagrun from the database

Parameters

session (sqlalchemy.orm.session.Session) -- database session

classmethod active_runs_of_dags(cls, dag_ids=None, only_running=False, session=None)

Get the number of active dag runs for each dag.

classmethod next_dagruns_to_examine(cls, state, session, max_number=None)

Return the next DagRuns that the scheduler should attempt to schedule.

This will return zero or more DagRun rows that are row-level-locked with a "SELECT ... FOR UPDATE" query, you should ensure that any scheduling decisions are made in a single transaction -- as soon as the transaction is committed it will be unlocked.

Return type

list[airflow.models.DagRun]

classmethod find(cls, dag_id=None, run_id=None, execution_date=None, state=None, external_trigger=None, no_backfills=False, run_type=None, session=NEW_SESSION, execution_start_date=None, execution_end_date=None)

Returns a set of dag runs for the given search criteria.

Parameters

• dag_id (Optional[Union[str, List[str]]]) -- the dag_id or list of dag_id to find dag runs for

• run_id (Optional[Iterable[str]]) -- defines the run id for this dag run

• run_type (Optional[airflow.utils.types.DagRunType]) -- type of DagRun

• execution_date (Optional[Union[datetime.datetime, Iterable[datetime.datetime]]]) -- the execution date

• state (Optional[airflow.utils.state.DagRunState]) -- the state of the dag run

• external_trigger (Optional[bool]) -- whether this dag run is externally triggered

• no_backfills (bool) -- return no backfills (True), return all (False). Defaults to False

• session (sqlalchemy.orm.session.Session) -- database session

• execution_start_date (Optional[datetime.datetime]) -- dag run that was executed from this date

• execution_end_date (Optional[datetime.datetime]) -- dag run that was executed until this date

classmethod find_duplicate(cls, dag_id, run_id, execution_date, session=NEW_SESSION)

Return an existing run for the DAG with a specific run_id or execution_date.

None is returned if no such DAG run is found.

Parameters

• dag_id (str) -- the dag_id to find duplicates for

• run_id (str) -- defines the run id for this dag run

• execution_date (datetime.datetime) -- the execution date

• session (sqlalchemy.orm.session.Session) -- database session

static generate_run_id(run_type, execution_date)

Generate Run ID based on Run Type and Execution Date

get_task_instances(self, state=None, session=NEW_SESSION)

Returns the task instances for this dag run

get_task_instance(self, task_id, session=NEW_SESSION, *, map_index=- 1)

Returns the task instance specified by task_id for this dag run

Parameters

• task_id (str) -- the task id

• session (sqlalchemy.orm.session.Session) -- Sqlalchemy ORM Session

get_dag(self)

Returns the Dag associated with this DagRun.

Returns

DAG

Return type

airflow.models.dag.DAG

get_previous_dagrun(self, state=None, session=NEW_SESSION)

The previous DagRun, if there is one

get_previous_scheduled_dagrun(self, session=NEW_SESSION)

The previous, SCHEDULED DagRun, if there is one

update_state(self, session=NEW_SESSION, execute_callbacks=True)

Determines the overall state of the DagRun based on the state of its TaskInstances.

Parameters

• session (sqlalchemy.orm.session.Session) -- Sqlalchemy ORM Session

• execute_callbacks (bool) -- Should dag callbacks (success/failure, SLA etc) be invoked directly (default: true) or recorded as a pending request in the callback property

Returns

Tuple containing tis that can be scheduled in the current loop & callback that needs to be executed

Return type

Tuple[List[airflow.models.taskinstance.TaskInstance], Optional[airflow.callbacks.callback_requests.DagCallbackRequest]]

task_instance_scheduling_decisions(self, session=NEW_SESSION)

verify_integrity(self, session=NEW_SESSION)

Verifies the DagRun by checking for removed tasks or tasks that are not in the database yet. It will set state to removed or add the task if required.

Parameters

session (sqlalchemy.orm.session.Session) -- Sqlalchemy ORM Session

static get_run(session, dag_id, execution_date)

Get a single DAG Run

Parameters

• session (sqlalchemy.orm.session.Session) -- Sqlalchemy ORM Session

• dag_id (str) -- DAG ID

• execution_date (datetime.datetime) -- execution date

Returns

DagRun corresponding to the given dag_id and execution date if one exists. None otherwise.

Return type

airflow.models.DagRun

property is_backfill(self)

classmethod get_latest_runs(cls, session=None)

Returns the latest DagRun for each DAG

schedule_tis(self, schedulable_tis, session=NEW_SESSION)

Set the given task instances in to the scheduled state.

Each element of schedulable_tis should have it's task attribute already set.

Any EmptyOperator without callbacks is instead set straight to the success state.

All the TIs should belong to this DagRun, but this code is in the hot-path, this is not checked -- it is the caller's responsibility to call this function only with TIs from a single dag run.

get_log_filename_template(self, *, session=NEW_SESSION)

Previous Next

Was this entry helpful?