| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!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.taskinstance — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <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/jira-links.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="stylesheet" href="../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/exampleinclude.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.taskreschedule" href="../taskreschedule/index.html" /> |
| <link rel="prev" title="airflow.models.taskfail" href="../taskfail/index.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </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.8 |
| </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> |
| <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="../../../../executor/index.html">Executor</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="../../../../errors.html">Error Tracking</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="../../../../dag-serialization.html">DAG Serialization</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="../../../../best-practices.html">Best Practices</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"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../index.html">Python API</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="../../../../configurations-ref.html">Configurations</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.taskinstance</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../_sources/_api/airflow/models/taskinstance/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.taskinstance"> |
| <span id="airflow-models-taskinstance"></span><h1><a class="reference internal" href="#module-airflow.models.taskinstance" title="airflow.models.taskinstance"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.models.taskinstance</span></code></a><a class="headerlink" href="#module-airflow.models.taskinstance" 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="function"> |
| <dt id="airflow.models.taskinstance.clear_task_instances"> |
| <code class="sig-prename descclassname">airflow.models.taskinstance.</code><code class="sig-name descname">clear_task_instances</code><span class="sig-paren">(</span><em class="sig-param">tis</em>, <em class="sig-param">session</em>, <em class="sig-param">activate_dag_runs=True</em>, <em class="sig-param">dag=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#clear_task_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.clear_task_instances" title="Permalink to this definition">¶</a></dt> |
| <dt> |
| <code class="sig-name descname">Clears a set of task instances, but makes sure the running ones</code></dt> |
| <dt> |
| <code class="sig-name descname">get killed.</code></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>tis</strong> – a list of task instances</p></li> |
| <li><p><strong>session</strong> – current session</p></li> |
| <li><p><strong>activate_dag_runs</strong> – flag to check for active dag run</p></li> |
| <li><p><strong>dag</strong> – DAG object</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.models.taskinstance.TaskInstance"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.models.taskinstance.</code><code class="sig-name descname">TaskInstance</code><span class="sig-paren">(</span><em class="sig-param">task</em>, <em class="sig-param">execution_date</em>, <em class="sig-param">state=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance" 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>Task instances store the state of a task instance. This table is the |
| authority and single source of truth around what tasks have run and the |
| state they are in.</p> |
| <p>The SqlAlchemy model doesn’t have a SqlAlchemy foreign key to the task or |
| dag model deliberately to have more control over transactions.</p> |
| <p>Database transactions on this table should insure double triggers and |
| any confusion around what task instances are or aren’t ready to run |
| even while multiple schedulers may be firing task instances.</p> |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.__tablename__"> |
| <code class="sig-name descname">__tablename__</code><em class="property"> = task_instance</em><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.__tablename__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.__tablename__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.task_id"> |
| <code class="sig-name descname">task_id</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.task_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.task_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.dag_id"> |
| <code class="sig-name descname">dag_id</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.dag_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.dag_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.execution_date"> |
| <code class="sig-name descname">execution_date</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.execution_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.execution_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.start_date"> |
| <code class="sig-name descname">start_date</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.start_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.start_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.end_date"> |
| <code class="sig-name descname">end_date</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.end_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.end_date" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.duration"> |
| <code class="sig-name descname">duration</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.duration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.duration" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.state"> |
| <code class="sig-name descname">state</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance._try_number"> |
| <code class="sig-name descname">_try_number</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance._try_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance._try_number" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.max_tries"> |
| <code class="sig-name descname">max_tries</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.max_tries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.max_tries" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.hostname"> |
| <code class="sig-name descname">hostname</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.hostname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.hostname" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.unixname"> |
| <code class="sig-name descname">unixname</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.unixname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.unixname" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.job_id"> |
| <code class="sig-name descname">job_id</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.job_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.job_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.pool"> |
| <code class="sig-name descname">pool</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.pool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.pool" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.queue"> |
| <code class="sig-name descname">queue</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.queue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.queue" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.priority_weight"> |
| <code class="sig-name descname">priority_weight</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.priority_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.priority_weight" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.operator"> |
| <code class="sig-name descname">operator</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.operator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.operator" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.queued_dttm"> |
| <code class="sig-name descname">queued_dttm</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.queued_dttm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.queued_dttm" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.pid"> |
| <code class="sig-name descname">pid</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.pid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.pid" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.executor_config"> |
| <code class="sig-name descname">executor_config</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.executor_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.executor_config" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.__table_args__"> |
| <code class="sig-name descname">__table_args__</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.__table_args__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.__table_args__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.try_number"> |
| <code class="sig-name descname">try_number</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.try_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.try_number" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the try number that this task number will be when it is actually |
| run.</p> |
| <p>If the TI is currently running, this will match the column in the |
| database, in all other cases this will be incremented.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.prev_attempted_tries"> |
| <code class="sig-name descname">prev_attempted_tries</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.prev_attempted_tries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.prev_attempted_tries" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Based on this instance’s try_number, this will calculate |
| the number of previously attempted tries, defaulting to 0.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.next_try_number"> |
| <code class="sig-name descname">next_try_number</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.next_try_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.next_try_number" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.log_filepath"> |
| <code class="sig-name descname">log_filepath</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.log_filepath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.log_filepath" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.log_url"> |
| <code class="sig-name descname">log_url</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.log_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.log_url" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.mark_success_url"> |
| <code class="sig-name descname">mark_success_url</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.mark_success_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.mark_success_url" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.key"> |
| <code class="sig-name descname">key</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.key" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a tuple that identifies the task instance uniquely</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.is_premature"> |
| <code class="sig-name descname">is_premature</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.is_premature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.is_premature" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns whether a task is in UP_FOR_RETRY state and its retry interval |
| has elapsed.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.previous_ti"> |
| <code class="sig-name descname">previous_ti</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.previous_ti"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.previous_ti" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The task instance for the task that ran before this task instance.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.previous_ti_success"> |
| <code class="sig-name descname">previous_ti_success</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.previous_ti_success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.previous_ti_success" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The ti from prior succesful dag run for this task, by execution date.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.previous_execution_date_success"> |
| <code class="sig-name descname">previous_execution_date_success</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.previous_execution_date_success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.previous_execution_date_success" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The execution date from property previous_ti_success.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.models.taskinstance.TaskInstance.previous_start_date_success"> |
| <code class="sig-name descname">previous_start_date_success</code><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.previous_start_date_success"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.previous_start_date_success" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The start date from property previous_ti_success.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.init_on_load"> |
| <code class="sig-name descname">init_on_load</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/taskinstance.html#TaskInstance.init_on_load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.init_on_load" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Initialize the attributes that aren’t stored in the DB.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.command"> |
| <code class="sig-name descname">command</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">ignore_all_deps=False</em>, <em class="sig-param">ignore_depends_on_past=False</em>, <em class="sig-param">ignore_task_deps=False</em>, <em class="sig-param">ignore_ti_state=False</em>, <em class="sig-param">local=False</em>, <em class="sig-param">pickle_id=None</em>, <em class="sig-param">raw=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">cfg_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.command" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a command that can be executed anywhere where airflow is |
| installed. This command is part of the message sent to executors by |
| the orchestrator.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.command_as_list"> |
| <code class="sig-name descname">command_as_list</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">ignore_all_deps=False</em>, <em class="sig-param">ignore_task_deps=False</em>, <em class="sig-param">ignore_depends_on_past=False</em>, <em class="sig-param">ignore_ti_state=False</em>, <em class="sig-param">local=False</em>, <em class="sig-param">pickle_id=None</em>, <em class="sig-param">raw=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">cfg_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.command_as_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.command_as_list" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a command that can be executed anywhere where airflow is |
| installed. This command is part of the message sent to executors by |
| the orchestrator.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.generate_command"> |
| <em class="property">static </em><code class="sig-name descname">generate_command</code><span class="sig-paren">(</span><em class="sig-param">dag_id</em>, <em class="sig-param">task_id</em>, <em class="sig-param">execution_date</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">ignore_all_deps=False</em>, <em class="sig-param">ignore_depends_on_past=False</em>, <em class="sig-param">ignore_task_deps=False</em>, <em class="sig-param">ignore_ti_state=False</em>, <em class="sig-param">local=False</em>, <em class="sig-param">pickle_id=None</em>, <em class="sig-param">file_path=None</em>, <em class="sig-param">raw=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">cfg_path=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.generate_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.generate_command" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Generates the shell command required to execute this task instance.</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> (<em>unicode</em>) – DAG ID</p></li> |
| <li><p><strong>task_id</strong> (<em>unicode</em>) – Task ID</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.8)"><em>datetime.datetime</em></a>) – Execution date for the task</p></li> |
| <li><p><strong>mark_success</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Whether to mark the task as successful</p></li> |
| <li><p><strong>ignore_all_deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore all ignorable dependencies. |
| Overrides the other ignore_* parameters.</p></li> |
| <li><p><strong>ignore_depends_on_past</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore depends_on_past parameter of DAGs |
| (e.g. for Backfills)</p></li> |
| <li><p><strong>ignore_task_deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore task-specific dependencies such as depends_on_past |
| and trigger rule</p></li> |
| <li><p><strong>ignore_ti_state</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore the task instance’s previous failure/success</p></li> |
| <li><p><strong>local</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Whether to run the task locally</p></li> |
| <li><p><strong>pickle_id</strong> (<em>unicode</em>) – If the DAG was serialized to the DB, the ID |
| associated with the pickled DAG</p></li> |
| <li><p><strong>file_path</strong> – path to the file containing the DAG definition</p></li> |
| <li><p><strong>raw</strong> – raw mode (needs more details)</p></li> |
| <li><p><strong>job_id</strong> – job ID (needs more details)</p></li> |
| <li><p><strong>pool</strong> (<em>unicode</em>) – the Airflow pool that the task should run in</p></li> |
| <li><p><strong>cfg_path</strong> (<em>basestring</em>) – the Path to the configuration file</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>shell command that can be used to run the task instance</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.current_state"> |
| <code class="sig-name descname">current_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/taskinstance.html#TaskInstance.current_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.current_state" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get the very latest state from the database, if a session is passed, |
| we use and looking up the state becomes part of the session, otherwise |
| a new session is used.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.error"> |
| <code class="sig-name descname">error</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/taskinstance.html#TaskInstance.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.error" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Forces the task instance’s state to FAILED in the database.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.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>, <em class="sig-param">lock_for_update=False</em>, <em class="sig-param">refresh_executor_config=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.refresh_from_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.refresh_from_db" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Refreshes the task instance from the database based on the primary key</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>refresh_executor_config</strong> – if True, revert executor config to |
| result from DB. Often, however, we will want to keep the newest |
| version</p></li> |
| <li><p><strong>lock_for_update</strong> – if True, indicates that the database should |
| lock the TaskInstance (issuing a FOR UPDATE clause) until the |
| session is committed.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.clear_xcom_data"> |
| <code class="sig-name descname">clear_xcom_data</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/taskinstance.html#TaskInstance.clear_xcom_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.clear_xcom_data" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Clears all XCom data from the database for the task instance</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.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>, <em class="sig-param">session=None</em>, <em class="sig-param">commit=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.set_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.set_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.are_dependents_done"> |
| <code class="sig-name descname">are_dependents_done</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/taskinstance.html#TaskInstance.are_dependents_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.are_dependents_done" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Checks whether the dependents of this task instance have all succeeded. |
| This is meant to be used by wait_for_downstream.</p> |
| <p>This is useful when you do not want to start processing the next |
| schedule of a task until the dependents are done. For instance, |
| if the task DROPs and recreates a table.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance._get_previous_ti"> |
| <code class="sig-name descname">_get_previous_ti</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/taskinstance.html#TaskInstance._get_previous_ti"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance._get_previous_ti" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.are_dependencies_met"> |
| <code class="sig-name descname">are_dependencies_met</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">dep_context=None</em>, <em class="sig-param">session=None</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.are_dependencies_met"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.are_dependencies_met" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns whether or not all the conditions are met for this task instance to be run |
| given the context for the dependencies (e.g. a task instance being force run from |
| the UI will ignore some dependencies).</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>dep_context</strong> (<em>DepContext</em>) – The execution context that determines the dependencies that |
| should be evaluated.</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> |
| <li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – whether log details on failed dependencies on |
| info or debug log level</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.get_failed_dep_statuses"> |
| <code class="sig-name descname">get_failed_dep_statuses</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">dep_context=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.get_failed_dep_statuses"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.get_failed_dep_statuses" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.__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/taskinstance.html#TaskInstance.__repr__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.__repr__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.next_retry_datetime"> |
| <code class="sig-name descname">next_retry_datetime</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/taskinstance.html#TaskInstance.next_retry_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.next_retry_datetime" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get datetime of the next retry if the task instance fails. For exponential |
| backoff, retry_delay is used as base and will be converted to seconds.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.ready_for_retry"> |
| <code class="sig-name descname">ready_for_retry</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/taskinstance.html#TaskInstance.ready_for_retry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.ready_for_retry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Checks on whether the task instance is in the right state and timeframe |
| to be retried.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.pool_full"> |
| <code class="sig-name descname">pool_full</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.pool_full"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.pool_full" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a boolean as to whether the slot pool has room for this |
| task to run</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.get_dagrun"> |
| <code class="sig-name descname">get_dagrun</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.get_dagrun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.get_dagrun" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the DagRun for this TaskInstance</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>session</strong> – </p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>DagRun</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance._check_and_change_state_before_execution"> |
| <code class="sig-name descname">_check_and_change_state_before_execution</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">verbose=True</em>, <em class="sig-param">ignore_all_deps=False</em>, <em class="sig-param">ignore_depends_on_past=False</em>, <em class="sig-param">ignore_task_deps=False</em>, <em class="sig-param">ignore_ti_state=False</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">test_mode=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance._check_and_change_state_before_execution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance._check_and_change_state_before_execution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Checks dependencies and then sets state to RUNNING if they are met. Returns |
| True if and only if state is set to RUNNING, which implies that task should be |
| executed, in preparation for _run_raw_task</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – whether to turn on more verbose logging</p></li> |
| <li><p><strong>ignore_all_deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore all of the non-critical dependencies, just runs</p></li> |
| <li><p><strong>ignore_depends_on_past</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Ignore depends_on_past DAG attribute</p></li> |
| <li><p><strong>ignore_task_deps</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Don’t check the dependencies of this TI’s task</p></li> |
| <li><p><strong>ignore_ti_state</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Disregards previous task instance state</p></li> |
| <li><p><strong>mark_success</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Don’t run the task, mark its state as success</p></li> |
| <li><p><strong>test_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Doesn’t record success or failure in the DB</p></li> |
| <li><p><strong>pool</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – specifies the pool to use to run the task instance</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>whether the state was changed to running or not</p> |
| </dd> |
| <dt class="field-odd">Return type</dt> |
| <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)">bool</a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance._run_raw_task"> |
| <code class="sig-name descname">_run_raw_task</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">test_mode=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance._run_raw_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance._run_raw_task" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Immediately runs the task (without checking or changing db state |
| before execution) and then sets the appropriate final state after |
| completion and runs any post-execute callbacks. Meant to be called |
| only after another function changes the state to running.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>mark_success</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Don’t run the task, mark its state as success</p></li> |
| <li><p><strong>test_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – Doesn’t record success or failure in the DB</p></li> |
| <li><p><strong>pool</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – specifies the pool to use to run the task instance</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.run"> |
| <code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">verbose=True</em>, <em class="sig-param">ignore_all_deps=False</em>, <em class="sig-param">ignore_depends_on_past=False</em>, <em class="sig-param">ignore_task_deps=False</em>, <em class="sig-param">ignore_ti_state=False</em>, <em class="sig-param">mark_success=False</em>, <em class="sig-param">test_mode=False</em>, <em class="sig-param">job_id=None</em>, <em class="sig-param">pool=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.run" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.dry_run"> |
| <code class="sig-name descname">dry_run</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/taskinstance.html#TaskInstance.dry_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.dry_run" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance._handle_reschedule"> |
| <code class="sig-name descname">_handle_reschedule</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">actual_start_date</em>, <em class="sig-param">reschedule_exception</em>, <em class="sig-param">test_mode=False</em>, <em class="sig-param">context=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance._handle_reschedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance._handle_reschedule" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.handle_failure"> |
| <code class="sig-name descname">handle_failure</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">error</em>, <em class="sig-param">test_mode=None</em>, <em class="sig-param">context=None</em>, <em class="sig-param">session=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.handle_failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.handle_failure" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.is_eligible_to_retry"> |
| <code class="sig-name descname">is_eligible_to_retry</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/taskinstance.html#TaskInstance.is_eligible_to_retry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.is_eligible_to_retry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Is task instance is eligible for retry</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.get_template_context"> |
| <code class="sig-name descname">get_template_context</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/taskinstance.html#TaskInstance.get_template_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.get_template_context" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.overwrite_params_with_dag_run_conf"> |
| <code class="sig-name descname">overwrite_params_with_dag_run_conf</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">params</em>, <em class="sig-param">dag_run</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.overwrite_params_with_dag_run_conf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.overwrite_params_with_dag_run_conf" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.render_templates"> |
| <code class="sig-name descname">render_templates</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.render_templates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.render_templates" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Render templates in the operator fields.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.email_alert"> |
| <code class="sig-name descname">email_alert</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">exception</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.email_alert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.email_alert" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.set_duration"> |
| <code class="sig-name descname">set_duration</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/taskinstance.html#TaskInstance.set_duration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.set_duration" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.xcom_push"> |
| <code class="sig-name descname">xcom_push</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">key</em>, <em class="sig-param">value</em>, <em class="sig-param">execution_date=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.xcom_push"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.xcom_push" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Make an XCom available for tasks to pull.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – A key for the XCom</p></li> |
| <li><p><strong>value</strong> (<em>any pickleable object</em>) – A value for the XCom. The value is pickled and stored |
| in the database.</p></li> |
| <li><p><strong>execution_date</strong> (<em>datetime</em>) – if provided, the XCom will not be visible until |
| this date. This can be used, for example, to send a message to a |
| task on a future date without it being immediately visible.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.xcom_pull"> |
| <code class="sig-name descname">xcom_pull</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">task_ids=None</em>, <em class="sig-param">dag_id=None</em>, <em class="sig-param">key=XCOM_RETURN_KEY</em>, <em class="sig-param">include_prior_dates=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.xcom_pull"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.xcom_pull" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Pull XComs that optionally meet certain criteria.</p> |
| <p>The default value for <cite>key</cite> limits the search to XComs |
| that were returned by other tasks (as opposed to those that were pushed |
| manually). To remove this filter, pass key=None (or any desired value).</p> |
| <p>If a single task_id string is provided, the result is the value of the |
| most recent matching XCom from that task_id. If multiple task_ids are |
| provided, a tuple of matching values is returned. None is returned |
| whenever no matches are found.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – A key for the XCom. If provided, only XComs with matching |
| keys will be returned. The default key is ‘return_value’, also |
| available as a constant XCOM_RETURN_KEY. This key is automatically |
| given to XComs returned by tasks (as opposed to being pushed |
| manually). To remove the filter, pass key=None.</p></li> |
| <li><p><strong>task_ids</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a><em> or </em><em>iterable of strings</em><em> (</em><em>representing task_ids</em><em>)</em>) – Only XComs from tasks with matching ids will be |
| pulled. Can pass None to remove the filter.</p></li> |
| <li><p><strong>dag_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – If provided, only pulls XComs from this DAG. |
| If None (default), the DAG of the calling task is used.</p></li> |
| <li><p><strong>include_prior_dates</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)"><em>bool</em></a>) – If False, only XComs from the current |
| execution_date are returned. If True, XComs from previous dates |
| are returned as well.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.get_num_running_task_instances"> |
| <code class="sig-name descname">get_num_running_task_instances</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">session</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.get_num_running_task_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.get_num_running_task_instances" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.models.taskinstance.TaskInstance.init_run_context"> |
| <code class="sig-name descname">init_run_context</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">raw=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/airflow/models/taskinstance.html#TaskInstance.init_run_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.models.taskinstance.TaskInstance.init_run_context" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets the log context.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../taskreschedule/index.html" class="btn btn-neutral float-right" title="airflow.models.taskreschedule" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../taskfail/index.html" class="btn btn-neutral float-left" title="airflow.models.taskfail" 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. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |