| |
| |
| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.models.dagrun — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| <link rel="next" title="airflow.models.errors" href="../errors/index.html" /> |
| <link rel="prev" title="airflow.models.dagpickle" href="../dagpickle/index.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.5 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../index.html">Python API Reference</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../../index.html#operators">Operators</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../index.html#hooks">Hooks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../index.html#executors">Executors</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../../../index.html#models">Models</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.models</span></code></a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="../index.html#submodules">Submodules</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../index.html#package-contents">Package Contents</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../index.html#core-and-community-package">Core and community package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Python API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.models</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.models.dagrun</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../_sources/_api/airflow/models/dagrun/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-airflow.models.dagrun"> |
| <span id="airflow-models-dagrun"></span><h1><a class="reference internal" href="#module-airflow.models.dagrun" title="airflow.models.dagrun"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.models.dagrun</span></code></a><a class="headerlink" href="#module-airflow.models.dagrun" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="module-contents"> |
| <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> |
| <dl class="class"> |
| <dt id="airflow.models.dagrun.DagRun"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.models.dagrun.</code><code class="sig-name descname">DagRun</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../base/index.html#airflow.models.base.Base" title="airflow.models.base.Base"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.base.Base</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.utils.log.logging_mixin.LoggingMixin</span></code></p> |
| <p>DagRun describes an instance of a Dag. It can be created |
| by the scheduler (for regular runs) or by an external trigger</p> |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.__tablename__"> |
| <code class="sig-name descname">__tablename__</code><em class="property"> = dag_run</em><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.__tablename__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.__tablename__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.ID_PREFIX"> |
| <code class="sig-name descname">ID_PREFIX</code><em class="property"> = scheduled__</em><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.ID_PREFIX"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.ID_PREFIX" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.ID_FORMAT_PREFIX"> |
| <code class="sig-name descname">ID_FORMAT_PREFIX</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.ID_FORMAT_PREFIX"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.ID_FORMAT_PREFIX" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.id"> |
| <code class="sig-name descname">id</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.dag_id"> |
| <code class="sig-name descname">dag_id</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.dag_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.dag_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.execution_date"> |
| <code class="sig-name descname">execution_date</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.execution_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.execution_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.start_date"> |
| <code class="sig-name descname">start_date</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.start_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.start_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.end_date"> |
| <code class="sig-name descname">end_date</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.end_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.end_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun._state"> |
| <code class="sig-name descname">_state</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun._state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun._state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.run_id"> |
| <code class="sig-name descname">run_id</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.run_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.run_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.external_trigger"> |
| <code class="sig-name descname">external_trigger</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.external_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.external_trigger" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.conf"> |
| <code class="sig-name descname">conf</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.conf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.conf" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.dag"> |
| <code class="sig-name descname">dag</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.dag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.dag" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.__table_args__"> |
| <code class="sig-name descname">__table_args__</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.__table_args__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.__table_args__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.state"> |
| <code class="sig-name descname">state</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.dagrun.DagRun.is_backfill"> |
| <code class="sig-name descname">is_backfill</code><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.is_backfill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.is_backfill" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.__repr__"> |
| <code class="sig-name descname">__repr__</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.__repr__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.__repr__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_state"> |
| <code class="sig-name descname">get_state</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.set_state"> |
| <code class="sig-name descname">set_state</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">state</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.set_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.set_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.id_for_date"> |
| <em class="property">classmethod </em><code class="sig-name descname">id_for_date</code><span class="sig-paren">(</span><em class="sig-param">cls</em>, <em class="sig-param">date</em>, <em class="sig-param">prefix=ID_FORMAT_PREFIX</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.id_for_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.id_for_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.refresh_from_db"> |
| <code class="sig-name descname">refresh_from_db</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.refresh_from_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.refresh_from_db" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reloads the current dagrun from the database |
| :param session: database session</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.find"> |
| <em class="property">static </em><code class="sig-name descname">find</code><span class="sig-paren">(</span><em class="sig-param">dag_id=None</em>, <em class="sig-param">run_id=None</em>, <em class="sig-param">execution_date=None</em>, <em class="sig-param">state=None</em>, <em class="sig-param">external_trigger=None</em>, <em class="sig-param">no_backfills=False</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.find" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a set of dag runs for the given search criteria.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dag_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – the dag_id to find dag runs for</p></li> |
| <li><p><strong>run_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – defines the the run id for this dag run</p></li> |
| <li><p><strong>execution_date</strong> (<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.7)"><em>datetime.datetime</em></a>) – the execution date</p></li> |
| <li><p><strong>state</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the state of the dag run</p></li> |
| <li><p><strong>external_trigger</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – whether this dag run is externally triggered</p></li> |
| <li><p><strong>no_backfills</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – return no backfills (True), return all (False). |
| Defaults to False</p></li> |
| <li><p><strong>session</strong> (<a class="reference external" href="https://docs.sqlalchemy.org/en/13/orm/session_api.html#sqlalchemy.orm.session.Session" title="(in SQLAlchemy v1.3)"><em>sqlalchemy.orm.session.Session</em></a>) – database session</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_task_instances"> |
| <code class="sig-name descname">get_task_instances</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">state=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_task_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_task_instances" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the task instances for this dag run</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_task_instance"> |
| <code class="sig-name descname">get_task_instance</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">task_id</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_task_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_task_instance" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the task instance specified by task_id for this dag run</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>task_id</strong> – the task id</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_dag"> |
| <code class="sig-name descname">get_dag</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_dag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_dag" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the Dag associated with this DagRun.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>DAG</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_previous_dagrun"> |
| <code class="sig-name descname">get_previous_dagrun</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">state=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_previous_dagrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_previous_dagrun" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The previous DagRun, if there is one</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_previous_scheduled_dagrun"> |
| <code class="sig-name descname">get_previous_scheduled_dagrun</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_previous_scheduled_dagrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_previous_scheduled_dagrun" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The previous, SCHEDULED DagRun, if there is one</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.update_state"> |
| <code class="sig-name descname">update_state</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.update_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.update_state" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Determines the overall state of the DagRun based on the state |
| of its TaskInstances.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>State</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun._emit_duration_stats_for_finished_state"> |
| <code class="sig-name descname">_emit_duration_stats_for_finished_state</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun._emit_duration_stats_for_finished_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun._emit_duration_stats_for_finished_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.verify_integrity"> |
| <code class="sig-name descname">verify_integrity</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.verify_integrity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.verify_integrity" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_run"> |
| <em class="property">static </em><code class="sig-name descname">get_run</code><span class="sig-paren">(</span><em class="sig-param">session</em>, <em class="sig-param">dag_id</em>, <em class="sig-param">execution_date</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_run" title="Permalink to this definition">¶</a></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dag_id</strong> (<em>unicode</em>) – DAG ID</p></li> |
| <li><p><strong>execution_date</strong> (<em>datetime</em>) – execution date</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>DagRun corresponding to the given dag_id and execution date |
| if one exists. None otherwise.</p> |
| </dd> |
| <dt class="field-odd">Return type</dt> |
| <dd class="field-odd"><p><a class="reference internal" href="../index.html#airflow.models.DagRun" title="airflow.models.DagRun">airflow.models.DagRun</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.dagrun.DagRun.get_latest_runs"> |
| <em class="property">classmethod </em><code class="sig-name descname">get_latest_runs</code><span class="sig-paren">(</span><em class="sig-param">cls</em>, <em class="sig-param">session</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/dagrun.html#DagRun.get_latest_runs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.dagrun.DagRun.get_latest_runs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the latest DagRun for each DAG.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../errors/index.html" class="btn btn-neutral float-right" title="airflow.models.errors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../dagpickle/index.html" class="btn btn-neutral float-left" title="airflow.models.dagpickle" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |