http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/28a3eb60/cli.html ---------------------------------------------------------------------- diff --git a/cli.html b/cli.html index 60008af..5e422ad 100644 --- a/cli.html +++ b/cli.html @@ -13,6 +13,8 @@ + + @@ -81,7 +83,10 @@ - <ul class="current"> + + + + <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> @@ -91,7 +96,118 @@ <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 current"><a class="current reference internal" href="#">Command Line Interface</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Command Line Interface</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#Positional Arguments">Positional Arguments</a></li> +<li class="toctree-l2"><a class="reference internal" href="#Sub-commands:">Sub-commands:</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#resetdb">resetdb</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#render">render</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat1">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat1">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#variables">variables</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat2">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#connections">connections</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat3">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#pause">pause</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat2">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat4">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#task_failed_deps">task_failed_deps</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat3">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat5">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#version">version</a></li> +<li class="toctree-l3"><a class="reference internal" href="#trigger_dag">trigger_dag</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat4">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat6">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#initdb">initdb</a></li> +<li class="toctree-l3"><a class="reference internal" href="#test">test</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat5">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat7">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#unpause">unpause</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat6">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat8">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#dag_state">dag_state</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat7">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat9">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#run">run</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat8">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat10">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#list_tasks">list_tasks</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat9">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat11">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#backfill">backfill</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat10">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat12">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#list_dags">list_dags</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat13">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#kerberos">kerberos</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat11">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat14">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#worker">worker</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat15">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#webserver">webserver</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat16">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#flower">flower</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat17">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#scheduler">scheduler</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat18">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#task_state">task_state</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat12">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat19">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#pool">pool</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat20">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#serve_logs">serve_logs</a></li> +<li class="toctree-l3"><a class="reference internal" href="#clear">clear</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#Positional Arguments_repeat13">Positional Arguments</a></li> +<li class="toctree-l4"><a class="reference internal" href="#Named Arguments_repeat21">Named Arguments</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#upgradedb">upgradedb</a></li> +</ul> +</li> +</ul> +</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> @@ -172,1032 +288,1159 @@ development and testing.</p> <span class="o">...</span> </pre></div> </div> -<dl class="docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments"> +<h2>Positional Arguments<a class="headerlink" href="#Positional Arguments" title="Permalink to this headline">¶</a></h2> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">subcommand</span></kbd></td> -<td><p class="first">sub-command help</p> -<p class="last">Possible choices: resetdb, render, variables, connections, pause, task_failed_deps, version, trigger_dag, initdb, test, unpause, dag_state, run, list_tasks, backfill, list_dags, kerberos, worker, webserver, flower, scheduler, task_state, pool, serve_logs, clear, upgradedb</p> +<kbd>subcommand</kbd></td> +<td><p class="first">Possible choices: resetdb, render, variables, connections, pause, task_failed_deps, version, trigger_dag, initdb, test, unpause, dag_state, run, list_tasks, backfill, list_dags, kerberos, worker, webserver, flower, scheduler, task_state, pool, serve_logs, clear, upgradedb</p> +<p class="last">sub-command help</p> </td></tr> </tbody> </table> -</dd> -<dt>Sub-commands:</dt> -<dd><dl class="first last docutils"> -<dt><strong>resetdb</strong></dt> -<dd><p class="first">Burn down and rebuild the metadata database</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">resetdb</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">y</span><span class="p">]</span> +</div> +<div class="section" id="Sub-commands:"> +<h2>Sub-commands:<a class="headerlink" href="#Sub-commands:" title="Permalink to this headline">¶</a></h2> +<div class="section" id="resetdb"> +<h3>resetdb<a class="headerlink" href="#resetdb" title="Permalink to this headline">¶</a></h3> +<p>Burn down and rebuild the metadata database</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">resetdb</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">y</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Named Arguments"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-y=False</span>, <span class="option">--yes=False</span></kbd></td> -</tr> -<tr><td> </td><td>Do not prompt to confirm reset. Use with care!</td></tr> +<tr><td class="option-group"> +<kbd>-y, --yes</kbd></td> +<td><p class="first">Do not prompt to confirm reset. Use with care!</p> +<p class="last">Default: False</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>render</strong></dt> -<dd><p class="first">Render a task instance’s template(s)</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">render</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> +</div> +</div> +<div class="section" id="render"> +<h3>render<a class="headerlink" href="#render" title="Permalink to this headline">¶</a></h3> +<p>Render a task instanceâs template(s)</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">render</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat1"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat1" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">task_id</span></kbd></td> +<kbd>task_id</kbd></td> <td>The id of the task</td></tr> <tr><td class="option-group"> -<kbd><span class="option">execution_date</span></kbd></td> +<kbd>execution_date</kbd></td> <td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat1"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat1" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>variables</strong></dt> -<dd><p class="first">CRUD operations on variables</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">variables</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">KEY</span> <span class="n">VAL</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">g</span> <span class="n">KEY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span> <span class="n">VAL</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">FILEPATH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">FILEPATH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">x</span> <span class="n">KEY</span><span class="p">]</span> +</div> +</div> +<div class="section" id="variables"> +<h3>variables<a class="headerlink" href="#variables" title="Permalink to this headline">¶</a></h3> +<p>CRUD operations on variables</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">variables</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">KEY</span> <span class="n">VAL</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">g</span> <span class="n">KEY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span> <span class="n">VAL</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">i</span> <span class="n">FILEPATH</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">FILEPATH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">x</span> <span class="n">KEY</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Named Arguments_repeat2"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat2" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">-s</span>, <span class="option">--set</span></kbd></td> +<kbd>-s, --set</kbd></td> <td>Set a variable</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-g</span>, <span class="option">--get</span></kbd></td> +<kbd>-g, --get</kbd></td> <td>Get value of a variable</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-j=False</span>, <span class="option">--json=False</span></kbd></td> -</tr> -<tr><td> </td><td>Deserialize JSON variable</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-d</span>, <span class="option">--default</span></kbd></td> +<kbd>-j, --json</kbd></td> +<td><p class="first">Deserialize JSON variable</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-d, --default</kbd></td> <td>Default value returned if variable does not exist</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-i</span>, <span class="option">--import</span></kbd></td> +<kbd>-i, --import</kbd></td> <td>Import variables from JSON file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-e</span>, <span class="option">--export</span></kbd></td> +<kbd>-e, --export</kbd></td> <td>Export variables to JSON file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-x</span>, <span class="option">--delete</span></kbd></td> +<kbd>-x, --delete</kbd></td> <td>Delete a variable</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>connections</strong></dt> -<dd><p class="first">List/Add/Delete connections</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">connections</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_id</span> <span class="n">CONN_ID</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">conn_uri</span> <span class="n">CONN_URI</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_extra</span> <span class="n">CONN_EXTRA</span><span class="p">]</span> +</div> +</div> +<div class="section" id="connections"> +<h3>connections<a class="headerlink" href="#connections" title="Permalink to this headline">¶</a></h3> +<p>List/Add/Delete connections</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">connections</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_id</span> <span class="n">CONN_ID</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">conn_uri</span> <span class="n">CONN_URI</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_extra</span> <span class="n">CONN_EXTRA</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">conn_type</span> <span class="n">CONN_TYPE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_host</span> <span class="n">CONN_HOST</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">conn_login</span> <span class="n">CONN_LOGIN</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_password</span> <span class="n">CONN_PASSWORD</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">conn_schema</span> <span class="n">CONN_SCHEMA</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">conn_port</span> <span class="n">CONN_PORT</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Named Arguments_repeat3"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat3" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-l=False</span>, <span class="option">--list=False</span></kbd></td> -</tr> -<tr><td> </td><td>List all connections</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-a=False</span>, <span class="option">--add=False</span></kbd></td> -</tr> -<tr><td> </td><td>Add a connection</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-d=False</span>, <span class="option">--delete=False</span></kbd></td> -</tr> -<tr><td> </td><td>Delete a connection</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--conn_id</span></kbd></td> +<kbd>-l, --list</kbd></td> +<td><p class="first">List all connections</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-a, --add</kbd></td> +<td><p class="first">Add a connection</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-d, --delete</kbd></td> +<td><p class="first">Delete a connection</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--conn_id</kbd></td> <td>Connection id, required to add/delete a connection</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--conn_uri</span></kbd></td> -<td>Connection URI, required to add a connection</td></tr> +<kbd>--conn_uri</kbd></td> +<td>Connection URI, required to add a connection without conn_type</td></tr> +<tr><td class="option-group"> +<kbd>--conn_extra</kbd></td> +<td>Connection <cite>Extra</cite> field, optional when adding a connection</td></tr> +<tr><td class="option-group"> +<kbd>--conn_type</kbd></td> +<td>Connection type, required to add a connection without conn_uri</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--conn_extra</span></kbd></td> -<td>Connection `Extra` field, optional when adding a connection</td></tr> +<kbd>--conn_host</kbd></td> +<td>Connection host, optional when adding a connection</td></tr> +<tr><td class="option-group"> +<kbd>--conn_login</kbd></td> +<td>Connection login, optional when adding a connection</td></tr> +<tr><td class="option-group" colspan="2"> +<kbd>--conn_password</kbd></td> +</tr> +<tr><td> </td><td>Connection password, optional when adding a connection</td></tr> +<tr><td class="option-group"> +<kbd>--conn_schema</kbd></td> +<td>Connection schema, optional when adding a connection</td></tr> +<tr><td class="option-group"> +<kbd>--conn_port</kbd></td> +<td>Connection port, optional when adding a connection</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>pause</strong></dt> -<dd><p class="first">Pause a DAG</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">pause</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> +</div> +</div> +<div class="section" id="pause"> +<h3>pause<a class="headerlink" href="#pause" title="Permalink to this headline">¶</a></h3> +<p>Pause a DAG</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">pause</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat2"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat2" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat4"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat4" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>task_failed_deps</strong></dt> -<dd><p class="first">Returns the unmet dependencies for a task instance from the perspective of the scheduler. In other words, why a task instance doesn’t get scheduled and then queued by the scheduler, and then run by an executor).</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">task_failed_deps</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> - <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> +</div> +</div> +<div class="section" id="task_failed_deps"> +<h3>task_failed_deps<a class="headerlink" href="#task_failed_deps" title="Permalink to this headline">¶</a></h3> +<p>Returns the unmet dependencies for a task instance from the perspective of the scheduler. In other words, why a task instance doesnât get scheduled and then queued by the scheduler, and then run by an executor).</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">task_failed_deps</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat3"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat3" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">task_id</span></kbd></td> +<kbd>task_id</kbd></td> <td>The id of the task</td></tr> <tr><td class="option-group"> -<kbd><span class="option">execution_date</span></kbd></td> +<kbd>execution_date</kbd></td> <td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat5"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat5" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>version</strong></dt> -<dd><p class="first">Show the version</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">version</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> +</div> +</div> +<div class="section" id="version"> +<h3>version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h3> +<p>Show the version</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">version</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -</dl> -</dd> -<dt><strong>trigger_dag</strong></dt> -<dd><p class="first">Trigger a DAG run</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">trigger_dag</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span> <span class="n">RUN_ID</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONF</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">EXEC_DATE</span><span class="p">]</span> - <span class="n">dag_id</span> +</div> +<div class="section" id="trigger_dag"> +<h3>trigger_dag<a class="headerlink" href="#trigger_dag" title="Permalink to this headline">¶</a></h3> +<p>Trigger a DAG run</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">trigger_dag</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span> <span class="n">RUN_ID</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONF</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">EXEC_DATE</span><span class="p">]</span> + <span class="n">dag_id</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat4"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat4" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat6"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat6" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-r</span>, <span class="option">--run_id</span></kbd></td> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-r, --run_id</kbd></td> <td>Helps to identify this run</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-c</span>, <span class="option">--conf</span></kbd></td> -<td>JSON string that gets pickled into the DagRun’s conf attribute</td></tr> +<kbd>-c, --conf</kbd></td> +<td>JSON string that gets pickled into the DagRunâs conf attribute</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-e</span>, <span class="option">--exec_date</span></kbd></td> +<kbd>-e, --exec_date</kbd></td> </tr> <tr><td> </td><td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>initdb</strong></dt> -<dd><p class="first">Initialize the metadata database</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">initdb</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> +</div> +</div> +<div class="section" id="initdb"> +<h3>initdb<a class="headerlink" href="#initdb" title="Permalink to this headline">¶</a></h3> +<p>Initialize the metadata database</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">initdb</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -</dl> -</dd> -<dt><strong>test</strong></dt> -<dd><p class="first">Test a task instance. This will run a task without checking for dependencies or recording it’s state in the database.</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">test</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">dr</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">tp</span> <span class="n">TASK_PARAMS</span><span class="p">]</span> - <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> +</div> +<div class="section" id="test"> +<h3>test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h3> +<p>Test a task instance. This will run a task without checking for dependencies or recording itâs state in the database.</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">test</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">dr</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">tp</span> <span class="n">TASK_PARAMS</span><span class="p">]</span> + <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat5"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat5" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">task_id</span></kbd></td> +<kbd>task_id</kbd></td> <td>The id of the task</td></tr> <tr><td class="option-group"> -<kbd><span class="option">execution_date</span></kbd></td> +<kbd>execution_date</kbd></td> <td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat7"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat7" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-dr, --dry_run</kbd></td> +<td><p class="first">Perform a dry run</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-dr=False</span>, <span class="option">--dry_run=False</span></kbd></td> -</tr> -<tr><td> </td><td>Perform a dry run</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-tp</span>, <span class="option">--task_params</span></kbd></td> +<kbd>-tp, --task_params</kbd></td> </tr> <tr><td> </td><td>Sends a JSON params dict to the task</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>unpause</strong></dt> -<dd><p class="first">Resume a paused DAG</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">unpause</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> +</div> +</div> +<div class="section" id="unpause"> +<h3>unpause<a class="headerlink" href="#unpause" title="Permalink to this headline">¶</a></h3> +<p>Resume a paused DAG</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">unpause</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat6"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat6" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat8"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat8" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>dag_state</strong></dt> -<dd><p class="first">Get the status of a dag run</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">dag_state</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> <span class="n">execution_date</span> +</div> +</div> +<div class="section" id="dag_state"> +<h3>dag_state<a class="headerlink" href="#dag_state" title="Permalink to this headline">¶</a></h3> +<p>Get the status of a dag run</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">dag_state</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> <span class="n">execution_date</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat7"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat7" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">execution_date</span></kbd></td> +<kbd>execution_date</kbd></td> <td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat9"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat9" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>run</strong></dt> -<dd><p class="first">Run a single task instance</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">run</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">f</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pool</span> <span class="n">POOL</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">cfg_path</span> <span class="n">CFG_PATH</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">A</span> <span class="n">IGNORE_ALL_DEPENDENCIES</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">i</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ship_dag</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PICKLE</span><span class="p">]</span> - <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> +</div> +</div> +<div class="section" id="run"> +<h3>run<a class="headerlink" href="#run" title="Permalink to this headline">¶</a></h3> +<p>Run a single task instance</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">run</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">f</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pool</span> <span class="n">POOL</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">cfg_path</span> <span class="n">CFG_PATH</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">A</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">i</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ship_dag</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PICKLE</span><span class="p">]</span> + <span class="n">dag_id</span> <span class="n">task_id</span> <span class="n">execution_date</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat8"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat8" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> <tr><td class="option-group"> -<kbd><span class="option">task_id</span></kbd></td> +<kbd>task_id</kbd></td> <td>The id of the task</td></tr> <tr><td class="option-group"> -<kbd><span class="option">execution_date</span></kbd></td> +<kbd>execution_date</kbd></td> <td>The execution date of the DAG</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat10"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat10" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-m=False</span>, <span class="option">--mark_success=False</span></kbd></td> -</tr> -<tr><td> </td><td>Mark jobs as succeeded without running them</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-f=False</span>, <span class="option">--force=False</span></kbd></td> +<kbd>-m, --mark_success</kbd></td> </tr> -<tr><td> </td><td>Ignore previous task instance state, rerun regardless if task already succeeded/failed</td></tr> +<tr><td> </td><td><p class="first">Mark jobs as succeeded without running them</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--pool</span></kbd></td> +<kbd>-f, --force</kbd></td> +<td><p class="first">Ignore previous task instance state, rerun regardless if task already succeeded/failed</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--pool</kbd></td> <td>Resource pool to use</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--cfg_path</span></kbd></td> +<kbd>--cfg_path</kbd></td> <td>Path to config file to use instead of airflow.cfg</td></tr> +<tr><td class="option-group"> +<kbd>-l, --local</kbd></td> +<td><p class="first">Run the task using the LocalExecutor</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-l=False</span>, <span class="option">--local=False</span></kbd></td> -</tr> -<tr><td> </td><td>Run the task using the LocalExecutor</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-A</span>, <span class="option">--ignore_all_dependencies</span></kbd></td> -</tr> -<tr><td> </td><td>Ignores all non-critical dependencies, including ignore_ti_state and ignore_task_depsstore_true</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-i=False</span>, <span class="option">--ignore_dependencies=False</span></kbd></td> +<kbd>-A, --ignore_all_dependencies</kbd></td> </tr> -<tr><td> </td><td>Ignore task-specific dependencies, e.g. upstream, depends_on_past, and retry delay dependencies</td></tr> +<tr><td> </td><td><p class="first">Ignores all non-critical dependencies, including ignore_ti_state and ignore_task_deps</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-I=False</span>, <span class="option">--ignore_depends_on_past=False</span></kbd></td> +<kbd>-i, --ignore_dependencies</kbd></td> </tr> -<tr><td> </td><td>Ignore depends_on_past dependencies (but respect upstream dependencies)</td></tr> +<tr><td> </td><td><p class="first">Ignore task-specific dependencies, e.g. upstream, depends_on_past, and retry delay dependencies</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">--ship_dag=False</span></kbd></td> +<kbd>-I, --ignore_depends_on_past</kbd></td> </tr> -<tr><td> </td><td>Pickles (serializes) the DAG and ships it to the worker</td></tr> +<tr><td> </td><td><p class="first">Ignore depends_on_past dependencies (but respect upstream dependencies)</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-p</span>, <span class="option">--pickle</span></kbd></td> +<kbd>--ship_dag</kbd></td> +<td><p class="first">Pickles (serializes) the DAG and ships it to the worker</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-p, --pickle</kbd></td> <td>Serialized pickle object of the entire dag (used internally)</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>list_tasks</strong></dt> -<dd><p class="first">List the tasks within a DAG</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">list_tasks</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> +</div> +</div> +<div class="section" id="list_tasks"> +<h3>list_tasks<a class="headerlink" href="#list_tasks" title="Permalink to this headline">¶</a></h3> +<p>List the tasks within a DAG</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">list_tasks</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="n">dag_id</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat9"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat9" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat11"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat11" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-t=False</span>, <span class="option">--tree=False</span></kbd></td> -</tr> -<tr><td> </td><td>Tree view</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td class="option-group"> +<kbd>-t, --tree</kbd></td> +<td><p class="first">Tree view</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>backfill</strong></dt> -<dd><p class="first">Run subsections of a DAG for a specified date range</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">backfill</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TASK_REGEX</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">START_DATE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">END_DATE</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">m</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">x</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">i</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">pool</span> <span class="n">POOL</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">dr</span><span class="p">]</span> - <span class="n">dag_id</span> +</div> +</div> +<div class="section" id="backfill"> +<h3>backfill<a class="headerlink" href="#backfill" title="Permalink to this headline">¶</a></h3> +<p>Run subsections of a DAG for a specified date range</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">backfill</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">TASK_REGEX</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">START_DATE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">e</span> <span class="n">END_DATE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">m</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">x</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">i</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">I</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pool</span> <span class="n">POOL</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">delay_on_limit</span> <span class="n">DELAY_ON_LIMIT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">dr</span><span class="p">]</span> + <span class="n">dag_id</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat10"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat10" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group"> -<kbd><span class="option">dag_id</span></kbd></td> +<kbd>dag_id</kbd></td> <td>The id of the dag</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat12"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat12" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-t</span>, <span class="option">--task_regex</span></kbd></td> +<kbd>-t, --task_regex</kbd></td> </tr> <tr><td> </td><td>The regex to filter specific task_ids to backfill (optional)</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-s</span>, <span class="option">--start_date</span></kbd></td> +<kbd>-s, --start_date</kbd></td> </tr> <tr><td> </td><td>Override start_date YYYY-MM-DD</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-e</span>, <span class="option">--end_date</span></kbd></td> +<kbd>-e, --end_date</kbd></td> <td>Override end_date YYYY-MM-DD</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-m=False</span>, <span class="option">--mark_success=False</span></kbd></td> -</tr> -<tr><td> </td><td>Mark jobs as succeeded without running them</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-l=False</span>, <span class="option">--local=False</span></kbd></td> +<kbd>-m, --mark_success</kbd></td> </tr> -<tr><td> </td><td>Run the task using the LocalExecutor</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-x=False</span>, <span class="option">--donot_pickle=False</span></kbd></td> -</tr> -<tr><td> </td><td>Do not attempt to pickle the DAG object to send over to the workers, just tell the workers to run their version of the code.</td></tr> +<tr><td> </td><td><p class="first">Mark jobs as succeeded without running them</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-l, --local</kbd></td> +<td><p class="first">Run the task using the LocalExecutor</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-a=False</span>, <span class="option">--include_adhoc=False</span></kbd></td> +<kbd>-x, --donot_pickle</kbd></td> </tr> -<tr><td> </td><td>Include dags with the adhoc parameter.</td></tr> +<tr><td> </td><td><p class="first">Do not attempt to pickle the DAG object to send over to the workers, just tell the workers to run their version of the code.</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-i=False</span>, <span class="option">--ignore_dependencies=False</span></kbd></td> +<kbd>-a, --include_adhoc</kbd></td> </tr> -<tr><td> </td><td>Skip upstream tasks, run only the tasks matching the regexp. Only works in conjunction with task_regex</td></tr> +<tr><td> </td><td><p class="first">Include dags with the adhoc parameter.</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-I=False</span>, <span class="option">--ignore_first_depends_on_past=False</span></kbd></td> +<kbd>-i, --ignore_dependencies</kbd></td> </tr> -<tr><td> </td><td>Ignores depends_on_past dependencies for the first set of tasks only (subsequent executions in the backfill DO respect depends_on_past).</td></tr> +<tr><td> </td><td><p class="first">Skip upstream tasks, run only the tasks matching the regexp. Only works in conjunction with task_regex</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> +<kbd>-I, --ignore_first_depends_on_past</kbd></td> </tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> +<tr><td> </td><td><p class="first">Ignores depends_on_past dependencies for the first set of tasks only (subsequent executions in the backfill DO respect depends_on_past).</p> +<p class="last">Default: False</p> +</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--pool</span></kbd></td> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--pool</kbd></td> <td>Resource pool to use</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-dr=False</span>, <span class="option">--dry_run=False</span></kbd></td> +<kbd>--delay_on_limit</kbd></td> </tr> -<tr><td> </td><td>Perform a dry run</td></tr> +<tr><td> </td><td><p class="first">Amount of time in seconds to wait when the limit on maximum active dag runs (max_active_runs) has been reached before trying to execute a dag run again.</p> +<p class="last">Default: 1.0</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-dr, --dry_run</kbd></td> +<td><p class="first">Perform a dry run</p> +<p class="last">Default: False</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>list_dags</strong></dt> -<dd><p class="first">List all the DAGs</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">list_dags</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span> +</div> +</div> +<div class="section" id="list_dags"> +<h3>list_dags<a class="headerlink" href="#list_dags" title="Permalink to this headline">¶</a></h3> +<p>List all the DAGs</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">list_dags</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">sd</span> <span class="n">SUBDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">r</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Named Arguments_repeat13"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat13" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-sd=/Users/maxime_beauchemin/dags</span>, <span class="option">--subdir=/Users/maxime_beauchemin/dags</span></kbd></td> -</tr> -<tr><td> </td><td>File location or directory from which to look for the dag</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-r=False</span>, <span class="option">--report=False</span></kbd></td> -</tr> -<tr><td> </td><td>Show DagBag loading report</td></tr> +<tr><td class="option-group"> +<kbd>-sd, --subdir</kbd></td> +<td><p class="first">File location or directory from which to look for the dag</p> +<p class="last">Default: /Users/chrisr/airflow/dags</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-r, --report</kbd></td> +<td><p class="first">Show DagBag loading report</p> +<p class="last">Default: False</p> +</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>kerberos</strong></dt> -<dd><p class="first">Start a kerberos ticket renewer</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">kerberos</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">kt</span> <span class="p">[</span><span class="n">KEYTAB</span><span class="p">]]</span> <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span> <span class="n">LOG_FILE</span><span class="p">]</span> - <span class="p">[</span><span class="n">principal</span><span class="p">]</span> +</div> +</div> +<div class="section" id="kerberos"> +<h3>kerberos<a class="headerlink" href="#kerberos" title="Permalink to this headline">¶</a></h3> +<p>Start a kerberos ticket renewer</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">kerberos</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">kt</span> <span class="p">[</span><span class="n">KEYTAB</span><span class="p">]]</span> <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span> <span class="n">LOG_FILE</span><span class="p">]</span> + <span class="p">[</span><span class="n">principal</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Required Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Positional Arguments_repeat11"> +<h4>Positional Arguments<a class="headerlink" href="#Positional Arguments_repeat11" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">principal=airflow</span></kbd></td> -</tr> -<tr><td> </td><td>kerberos principal</td></tr> +<tr><td class="option-group"> +<kbd>principal</kbd></td> +<td><p class="first">kerberos principal</p> +<p class="last">Default: airflow</p> +</td></tr> </tbody> </table> -</dd> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +</div> +<div class="section" id="Named Arguments_repeat14"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat14" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-kt=airflow.keytab</span>, <span class="option">--keytab=airflow.keytab</span></kbd></td> -</tr> -<tr><td> </td><td>keytab</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--pid</span></kbd></td> +<kbd>-kt, --keytab</kbd></td> +<td><p class="first">keytab</p> +<p class="last">Default: airflow.keytab</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--pid</kbd></td> <td>PID file location</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-D=False</span>, <span class="option">--daemon=False</span></kbd></td> -</tr> -<tr><td> </td><td>Daemonize instead of running in the foreground</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--stdout</span></kbd></td> +<kbd>-D, --daemon</kbd></td> +<td><p class="first">Daemonize instead of running in the foreground</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--stdout</kbd></td> <td>Redirect stdout to this file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--stderr</span></kbd></td> +<kbd>--stderr</kbd></td> <td>Redirect stderr to this file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-l</span>, <span class="option">--log-file</span></kbd></td> +<kbd>-l, --log-file</kbd></td> <td>Location of the log file</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>worker</strong></dt> -<dd><p class="first">Start a Celery worker node</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">worker</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">q</span> <span class="n">QUEUES</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONCURRENCY</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> - <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span> <span class="n">LOG_FILE</span><span class="p">]</span> +</div> +</div> +<div class="section" id="worker"> +<h3>worker<a class="headerlink" href="#worker" title="Permalink to this headline">¶</a></h3> +<p>Start a Celery worker node</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">worker</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">q</span> <span class="n">QUEUES</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">c</span> <span class="n">CONCURRENCY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">cn</span> <span class="n">CELERY_HOSTNAME</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">l</span> <span class="n">LOG_FILE</span><span class="p">]</span> </pre></div> </div> -<dl class="last docutils"> -<dt>Optional Arguments</dt> -<dd><table class="first last docutils option-list" frame="void" rules="none"> +<div class="section" id="Named Arguments_repeat15"> +<h4>Named Arguments<a class="headerlink" href="#Named Arguments_repeat15" title="Permalink to this headline">¶</a></h4> +<table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> <tbody valign="top"> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-p=False</span>, <span class="option">--do_pickle=False</span></kbd></td> +<kbd>-p, --do_pickle</kbd></td> </tr> -<tr><td> </td><td>Attempt to pickle the DAG object to send over to the workers, instead of letting workers run their version of the code.</td></tr> +<tr><td> </td><td><p class="first">Attempt to pickle the DAG object to send over to the workers, instead of letting workers run their version of the code.</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>-q, --queues</kbd></td> +<td><p class="first">Comma delimited list of queues to serve</p> +<p class="last">Default: default</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-q=default</span>, <span class="option">--queues=default</span></kbd></td> +<kbd>-c, --concurrency</kbd></td> </tr> -<tr><td> </td><td>Comma delimited list of queues to serve</td></tr> +<tr><td> </td><td><p class="first">The number of worker processes</p> +<p class="last">Default: 16</p> +</td></tr> <tr><td class="option-group" colspan="2"> -<kbd><span class="option">-c=16</span>, <span class="option">--concurrency=16</span></kbd></td> +<kbd>-cn, --celery_hostname</kbd></td> </tr> -<tr><td> </td><td>The number of worker processes</td></tr> +<tr><td> </td><td>Set the hostname of celery worker if you have multiple workers on a single machine.</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--pid</span></kbd></td> +<kbd>--pid</kbd></td> <td>PID file location</td></tr> -<tr><td class="option-group" colspan="2"> -<kbd><span class="option">-D=False</span>, <span class="option">--daemon=False</span></kbd></td> -</tr> -<tr><td> </td><td>Daemonize instead of running in the foreground</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--stdout</span></kbd></td> +<kbd>-D, --daemon</kbd></td> +<td><p class="first">Daemonize instead of running in the foreground</p> +<p class="last">Default: False</p> +</td></tr> +<tr><td class="option-group"> +<kbd>--stdout</kbd></td> <td>Redirect stdout to this file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">--stderr</span></kbd></td> +<kbd>--stderr</kbd></td> <td>Redirect stderr to this file</td></tr> <tr><td class="option-group"> -<kbd><span class="option">-l</span>, <span class="option">--log-file</span></kbd></td> +<kbd>-l, --log-file</kbd></td> <td>Location of the log file</td></tr> </tbody> </table> -</dd> -</dl> -</dd> -<dt><strong>webserver</strong></dt> -<dd><p class="first">Start a Airflow webserver instance</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">airflow</span> <span class="n">webserver</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PORT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">w</span> <span class="n">WORKERS</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">k</span> <span class="p">{</span><span class="n">sync</span><span class="p">,</span><span class="n">eventlet</span><span class="p">,</span><span class="n">gevent</span><span class="p">,</span><span class="n">tornado</span><span class="p">}]</span> - <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">WORKER_TIMEOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">hn</span> <span class="n">HOSTNAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> - <span class="p">[</span><span class="o">-</span><span class="n">A</span> <span class="n">ACCESS_LOGFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">E</span> <span class="n">ERROR_LOGFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">l</span> <span class="n">LOG_FILE</span><span class="p">]</span> - <span class="p">[</span><span class="o">--</span><span class="n">ssl_cert</span> <span class="n">SSL_CERT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ssl_key</span> <span class="n">SSL_KEY</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">d</span><span class="p">]</span> +</div> +</div> +<div class="section" id="webserver"> +<h3>webserver<a class="headerlink" href="#webserver" title="Permalink to this headline">¶</a></h3> +<p>Start a Airflow webserver instance</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">airflow</span> <span class="n">webserver</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">p</span> <span class="n">PORT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">w</span> <span class="n">WORKERS</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">k</span> <span class="p">{</span><span class="n">sync</span><span class="p">,</span><span class="n">eventlet</span><span class="p">,</span><span class="n">gevent</span><span class="p">,</span><span class="n">tornado</span><span class="p">}]</span> <span class="p">[</span><span class="o">-</span><span class="n">t</span> <span class="n">WORKER_TIMEOUT</span><span class="p">]</span> + <span class="p">[</span><span class="o">-</span><span class="n">hn</span> <span class="n">HOSTNAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">pid</span> <span class="p">[</span><span class="n">PID</span><span class="p">]]</span> <span class="p">[</span><span class="o">-</span><span class="n">D</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">stdout</span> <span class="n">STDOUT</span><span class="p">]</span> + <span class="p">[</span><span class="o">--</span><span class="n">stderr</span> <span class="n">STDERR</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">A</span> <span class="n">ACCESS_LOGFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">E</span> <span class="n">ERROR_LOGFILE</span><sp
<TRUNCATED>
