| |
| |
| |
| |
| <!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.executors — 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.executors.base_executor" href="base_executor/index.html" /> |
| <link rel="prev" title="airflow.contrib.hooks.winrm_hook" href="../contrib/hooks/winrm_hook/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> |
| <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.3 |
| </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</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">Experimental Rest API</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">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 current"><a class="reference internal" href="../../index.html#executors">Executors</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../index.html#executors-packages">Executors packages</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../contrib/executors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.executors</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../index.html#models">Models</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../index.html#core-and-community-package">Core and community package</a></li> |
| </ul> |
| </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">API Reference</a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../_sources/_api/airflow/executors/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.executors"> |
| <span id="airflow-executors"></span><h1><a class="reference internal" href="#module-airflow.executors" title="airflow.executors"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors</span></code></a><a class="headerlink" href="#module-airflow.executors" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="submodules"> |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="base_executor/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors.base_executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="celery_executor/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors.celery_executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="dask_executor/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors.dask_executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="local_executor/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors.local_executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="sequential_executor/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.executors.sequential_executor</span></code></a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="package-contents"> |
| <h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this headline">¶</a></h2> |
| <dl class="class"> |
| <dt id="airflow.executors.LoggingMixin"> |
| <em class="property">class </em><code class="descclassname">airflow.executors.</code><code class="descname">LoggingMixin</code><span class="sig-paren">(</span><em>context=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/utils/log/logging_mixin.html#LoggingMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.LoggingMixin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Convenience super-class to have a logger configured with the class name</p> |
| <dl class="attribute"> |
| <dt id="airflow.executors.LoggingMixin.logger"> |
| <code class="descname">logger</code><a class="headerlink" href="#airflow.executors.LoggingMixin.logger" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.LoggingMixin.log"> |
| <code class="descname">log</code><a class="headerlink" href="#airflow.executors.LoggingMixin.log" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LoggingMixin._set_context"> |
| <code class="descname">_set_context</code><span class="sig-paren">(</span><em>self</em>, <em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LoggingMixin._set_context" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="exception"> |
| <dt id="airflow.executors.AirflowException"> |
| <em class="property">exception </em><code class="descclassname">airflow.executors.</code><code class="descname">AirflowException</code><a class="reference internal" href="../../../_modules/airflow/exceptions.html#AirflowException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.AirflowException" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> |
| <p>Base class for all Airflow’s errors. |
| Each custom exception should be derived from this class</p> |
| <dl class="attribute"> |
| <dt id="airflow.executors.AirflowException.status_code"> |
| <code class="descname">status_code</code><em class="property"> = 500</em><a class="headerlink" href="#airflow.executors.AirflowException.status_code" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.executors.BaseExecutor"> |
| <em class="property">class </em><code class="descclassname">airflow.executors.</code><code class="descname">BaseExecutor</code><span class="sig-paren">(</span><em>parallelism=PARALLELISM</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/executors/base_executor.html#BaseExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.BaseExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.utils.log.logging_mixin.LoggingMixin</span></code></p> |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.start"> |
| <code class="descname">start</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.start" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Executors may need to get things started. For example LocalExecutor |
| starts N workers.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.queue_command"> |
| <code class="descname">queue_command</code><span class="sig-paren">(</span><em>self</em>, <em>simple_task_instance</em>, <em>command</em>, <em>priority=1</em>, <em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.queue_command" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.queue_task_instance"> |
| <code class="descname">queue_task_instance</code><span class="sig-paren">(</span><em>self</em>, <em>task_instance</em>, <em>mark_success=False</em>, <em>pickle_id=None</em>, <em>ignore_all_deps=False</em>, <em>ignore_depends_on_past=False</em>, <em>ignore_task_deps=False</em>, <em>ignore_ti_state=False</em>, <em>pool=None</em>, <em>cfg_path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.queue_task_instance" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.has_task"> |
| <code class="descname">has_task</code><span class="sig-paren">(</span><em>self</em>, <em>task_instance</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.has_task" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Checks if a task is either queued or running in this executor</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>task_instance</strong> – TaskInstance</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>True if the task is known to this executor</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.sync"> |
| <code class="descname">sync</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.sync" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sync will get called periodically by the heartbeat method. |
| Executors should override this to perform gather statuses.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.heartbeat"> |
| <code class="descname">heartbeat</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.heartbeat" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.change_state"> |
| <code class="descname">change_state</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.change_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.fail"> |
| <code class="descname">fail</code><span class="sig-paren">(</span><em>self</em>, <em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.fail" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.success"> |
| <code class="descname">success</code><span class="sig-paren">(</span><em>self</em>, <em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.success" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.get_event_buffer"> |
| <code class="descname">get_event_buffer</code><span class="sig-paren">(</span><em>self</em>, <em>dag_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.get_event_buffer" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns and flush the event buffer. In case dag_ids is specified |
| it will only return and flush events for the given dag_ids. Otherwise |
| it returns and flushes all</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>dag_ids</strong> – to dag_ids to return events for, if None returns all</p> |
| </dd> |
| <dt class="field-even">Returns</dt> |
| <dd class="field-even"><p>a dict of events</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.execute_async"> |
| <code class="descname">execute_async</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>command</em>, <em>queue=None</em>, <em>executor_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.execute_async" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This method will execute the command asynchronously.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.end"> |
| <code class="descname">end</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.end" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This method is called when the caller is done submitting job and is |
| wants to wait synchronously for the job submitted previously to be |
| all done.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.BaseExecutor.terminate"> |
| <code class="descname">terminate</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.BaseExecutor.terminate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This method is called when the daemon receives a SIGTERM</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.executors.LocalExecutor"> |
| <em class="property">class </em><code class="descclassname">airflow.executors.</code><code class="descname">LocalExecutor</code><a class="reference internal" href="../../../_modules/airflow/executors/local_executor.html#LocalExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.LocalExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference internal" href="base_executor/index.html#airflow.executors.base_executor.BaseExecutor" title="airflow.executors.base_executor.BaseExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.executors.base_executor.BaseExecutor</span></code></a></p> |
| <p>LocalExecutor executes tasks locally in parallel. It uses the |
| multiprocessing Python library and queues to parallelize the execution |
| of tasks.</p> |
| <dl class="class"> |
| <dt id="airflow.executors.LocalExecutor._UnlimitedParallelism"> |
| <em class="property">class </em><code class="descname">_UnlimitedParallelism</code><span class="sig-paren">(</span><em>executor</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._UnlimitedParallelism" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Implements LocalExecutor with unlimited parallelism, starting one process |
| per each command to execute.</p> |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._UnlimitedParallelism.start"> |
| <code class="descname">start</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._UnlimitedParallelism.start" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._UnlimitedParallelism.execute_async"> |
| <code class="descname">execute_async</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._UnlimitedParallelism.execute_async" 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>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a><em>(</em><em>dag_id</em><em>, </em><em>task_id</em><em>, </em><em>execution_date</em><em>)</em>) – the key to identify the TI</p></li> |
| <li><p><strong>command</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 command to execute</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._UnlimitedParallelism.sync"> |
| <code class="descname">sync</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._UnlimitedParallelism.sync" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._UnlimitedParallelism.end"> |
| <code class="descname">end</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._UnlimitedParallelism.end" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.executors.LocalExecutor._LimitedParallelism"> |
| <em class="property">class </em><code class="descname">_LimitedParallelism</code><span class="sig-paren">(</span><em>executor</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._LimitedParallelism" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Implements LocalExecutor with limited parallelism using a task queue to |
| coordinate work distribution.</p> |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._LimitedParallelism.start"> |
| <code class="descname">start</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._LimitedParallelism.start" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._LimitedParallelism.execute_async"> |
| <code class="descname">execute_async</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>command</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._LimitedParallelism.execute_async" 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>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a><em>(</em><em>dag_id</em><em>, </em><em>task_id</em><em>, </em><em>execution_date</em><em>)</em>) – the key to identify the TI</p></li> |
| <li><p><strong>command</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 command to execute</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._LimitedParallelism.sync"> |
| <code class="descname">sync</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._LimitedParallelism.sync" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor._LimitedParallelism.end"> |
| <code class="descname">end</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor._LimitedParallelism.end" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor.start"> |
| <code class="descname">start</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor.start" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor.execute_async"> |
| <code class="descname">execute_async</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>command</em>, <em>queue=None</em>, <em>executor_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor.execute_async" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor.sync"> |
| <code class="descname">sync</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor.sync" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.LocalExecutor.end"> |
| <code class="descname">end</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.LocalExecutor.end" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.executors.SequentialExecutor"> |
| <em class="property">class </em><code class="descclassname">airflow.executors.</code><code class="descname">SequentialExecutor</code><a class="reference internal" href="../../../_modules/airflow/executors/sequential_executor.html#SequentialExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.SequentialExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference internal" href="base_executor/index.html#airflow.executors.base_executor.BaseExecutor" title="airflow.executors.base_executor.BaseExecutor"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.executors.base_executor.BaseExecutor</span></code></a></p> |
| <p>This executor will only run one task instance at a time, can be used |
| for debugging. It is also the only executor that can be used with sqlite |
| since sqlite doesn’t support multiple connections.</p> |
| <p>Since we want airflow to work out of the box, it defaults to this |
| SequentialExecutor alongside sqlite as you first install it.</p> |
| <dl class="method"> |
| <dt id="airflow.executors.SequentialExecutor.execute_async"> |
| <code class="descname">execute_async</code><span class="sig-paren">(</span><em>self</em>, <em>key</em>, <em>command</em>, <em>queue=None</em>, <em>executor_config=None</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.SequentialExecutor.execute_async" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.SequentialExecutor.sync"> |
| <code class="descname">sync</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.SequentialExecutor.sync" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.executors.SequentialExecutor.end"> |
| <code class="descname">end</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#airflow.executors.SequentialExecutor.end" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="data"> |
| <dt id="airflow.executors.DEFAULT_EXECUTOR"> |
| <code class="descclassname">airflow.executors.</code><code class="descname">DEFAULT_EXECUTOR</code><a class="reference internal" href="../../../_modules/airflow/executors.html#DEFAULT_EXECUTOR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.DEFAULT_EXECUTOR" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="airflow.executors._integrate_plugins"> |
| <code class="descclassname">airflow.executors.</code><code class="descname">_integrate_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/executors.html#_integrate_plugins"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors._integrate_plugins" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Integrate plugins to the context.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="airflow.executors.GetDefaultExecutor"> |
| <code class="descclassname">airflow.executors.</code><code class="descname">GetDefaultExecutor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/executors.html#GetDefaultExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.GetDefaultExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new instance of the configured executor if none exists and returns it</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.executors.Executors"> |
| <em class="property">class </em><code class="descclassname">airflow.executors.</code><code class="descname">Executors</code><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors" title="Permalink to this definition">¶</a></dt> |
| <dd><dl class="attribute"> |
| <dt id="airflow.executors.Executors.LocalExecutor"> |
| <code class="descname">LocalExecutor</code><em class="property"> = LocalExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.LocalExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.LocalExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.Executors.SequentialExecutor"> |
| <code class="descname">SequentialExecutor</code><em class="property"> = SequentialExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.SequentialExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.SequentialExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.Executors.CeleryExecutor"> |
| <code class="descname">CeleryExecutor</code><em class="property"> = CeleryExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.CeleryExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.CeleryExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.Executors.DaskExecutor"> |
| <code class="descname">DaskExecutor</code><em class="property"> = DaskExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.DaskExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.DaskExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.Executors.MesosExecutor"> |
| <code class="descname">MesosExecutor</code><em class="property"> = MesosExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.MesosExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.MesosExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.executors.Executors.KubernetesExecutor"> |
| <code class="descname">KubernetesExecutor</code><em class="property"> = KubernetesExecutor</em><a class="reference internal" href="../../../_modules/airflow/executors.html#Executors.KubernetesExecutor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors.Executors.KubernetesExecutor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="airflow.executors._get_executor"> |
| <code class="descclassname">airflow.executors.</code><code class="descname">_get_executor</code><span class="sig-paren">(</span><em>executor_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/executors.html#_get_executor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.executors._get_executor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a new instance of the named executor. |
| In case the executor name is not know in airflow, |
| look for it in the plugins</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="base_executor/index.html" class="btn btn-neutral float-right" title="airflow.executors.base_executor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../contrib/hooks/winrm_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.winrm_hook" 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>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
