| |
| |
| |
| |
| <!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.contrib.hooks.spark_submit_hook — 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.contrib.hooks.sqoop_hook" href="../sqoop_hook/index.html" /> |
| <link rel="prev" title="airflow.contrib.hooks.spark_sql_hook" href="../spark_sql_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 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></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><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.spark_submit_hook</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../../_sources/_api/airflow/contrib/hooks/spark_submit_hook/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.contrib.hooks.spark_submit_hook"> |
| <span id="airflow-contrib-hooks-spark-submit-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.spark_submit_hook" title="airflow.contrib.hooks.spark_submit_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.spark_submit_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.spark_submit_hook" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="module-contents"> |
| <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> |
| <dl class="class"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook"> |
| <em class="property">class </em><code class="descclassname">airflow.contrib.hooks.spark_submit_hook.</code><code class="descname">SparkSubmitHook</code><span class="sig-paren">(</span><em>conf=None</em>, <em>conn_id='spark_default'</em>, <em>files=None</em>, <em>py_files=None</em>, <em>archives=None</em>, <em>driver_class_path=None</em>, <em>jars=None</em>, <em>java_class=None</em>, <em>packages=None</em>, <em>exclude_packages=None</em>, <em>repositories=None</em>, <em>total_executor_cores=None</em>, <em>executor_cores=None</em>, <em>executor_memory=None</em>, <em>driver_memory=None</em>, <em>keytab=None</em>, <em>principal=None</em>, <em>name='default-name'</em>, <em>num_executors=None</em>, <em>application_args=None</em>, <em>env_vars=None</em>, <em>verbose=False</em>, <em>spark_binary='spark-submit'</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases:<a class="reference internal" href="../../../hooks/base_hook/index.html#airflow.hooks.base_hook.BaseHook" title="airflow.hooks.base_hook.BaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.hooks.base_hook.BaseHook</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.utils.log.logging_mixin.LoggingMixin</span></code></p> |
| <p>This hook is a wrapper around the spark-submit binary to kick off a spark-submit job. |
| It requires that the “spark-submit” binary is in the PATH or the spark_home to be |
| supplied.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>conf</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Arbitrary Spark configuration properties</p></li> |
| <li><p><strong>conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The connection id as configured in Airflow administration. When an |
| invalid connection_id is supplied, it will default to yarn.</p></li> |
| <li><p><strong>files</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Upload additional files to the executor running the job, separated by a |
| comma. Files will be placed in the working directory of each executor. |
| For example, serialized objects.</p></li> |
| <li><p><strong>py_files</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Additional python files used by the job, can be .zip, .egg or .py.</p></li> |
| <li><p><strong>driver_class_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Additional, driver-specific, classpath settings.</p></li> |
| <li><p><strong>jars</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Submit additional jars to upload and place them in executor classpath.</p></li> |
| <li><p><strong>java_class</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 main class of the Java application</p></li> |
| <li><p><strong>packages</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Comma-separated list of maven coordinates of jars to include on the |
| driver and executor classpaths</p></li> |
| <li><p><strong>exclude_packages</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Comma-separated list of maven coordinates of jars to exclude |
| while resolving the dependencies provided in ‘packages’</p></li> |
| <li><p><strong>repositories</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Comma-separated list of additional remote repositories to search |
| for the maven coordinates given with ‘packages’</p></li> |
| <li><p><strong>total_executor_cores</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Standalone & Mesos only) Total cores for all executors |
| (Default: all the available cores on the worker)</p></li> |
| <li><p><strong>executor_cores</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – (Standalone, YARN and Kubernetes only) Number of cores per |
| executor (Default: 2)</p></li> |
| <li><p><strong>executor_memory</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Memory per executor (e.g. 1000M, 2G) (Default: 1G)</p></li> |
| <li><p><strong>driver_memory</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Memory allocated to the driver (e.g. 1000M, 2G) (Default: 1G)</p></li> |
| <li><p><strong>keytab</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Full path to the file that contains the keytab</p></li> |
| <li><p><strong>principal</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 name of the kerberos principal used for keytab</p></li> |
| <li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Name of the job (default airflow-spark)</p></li> |
| <li><p><strong>num_executors</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Number of executors to launch</p></li> |
| <li><p><strong>application_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) – Arguments for the application being submitted</p></li> |
| <li><p><strong>env_vars</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Environment variables for spark-submit. It |
| supports yarn and k8s mode too.</p></li> |
| <li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Whether to pass the verbose flag to spark-submit process for debugging</p></li> |
| <li><p><strong>spark_binary</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 use for spark submit. |
| Some distros may use spark2-submit.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Param</dt> |
| <dd class="field-even"><p>archives: Archives that spark should unzip (and possibly tag with #ALIAS) into |
| the application working directory.</p> |
| </dd> |
| </dl> |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._resolve_should_track_driver_status"> |
| <code class="descname">_resolve_should_track_driver_status</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._resolve_should_track_driver_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._resolve_should_track_driver_status" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Determines whether or not this hook should poll the spark driver status through |
| subsequent spark-submit status requests after the initial spark-submit request |
| :return: if the driver status should be tracked</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._resolve_connection"> |
| <code class="descname">_resolve_connection</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._resolve_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._resolve_connection" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.get_conn"> |
| <code class="descname">get_conn</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.get_conn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._get_spark_binary_path"> |
| <code class="descname">_get_spark_binary_path</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._get_spark_binary_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._get_spark_binary_path" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_spark_submit_command"> |
| <code class="descname">_build_spark_submit_command</code><span class="sig-paren">(</span><em>self</em>, <em>application</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._build_spark_submit_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_spark_submit_command" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Construct the spark-submit command to execute. |
| :param application: command to append to the spark-submit command |
| :type application: str |
| :return: full command to be executed</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_track_driver_status_command"> |
| <code class="descname">_build_track_driver_status_command</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._build_track_driver_status_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_track_driver_status_command" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Construct the command to poll the driver status.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns</dt> |
| <dd class="field-odd"><p>full command to be executed</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.submit"> |
| <code class="descname">submit</code><span class="sig-paren">(</span><em>self</em>, <em>application=''</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook.submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.submit" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Remote Popen to execute the spark-submit job</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>application</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Submitted application, jar or py file</p></li> |
| <li><p><strong>kwargs</strong> – extra arguments to Popen (see subprocess.Popen)</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._process_spark_submit_log"> |
| <code class="descname">_process_spark_submit_log</code><span class="sig-paren">(</span><em>self</em>, <em>itr</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._process_spark_submit_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._process_spark_submit_log" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Processes the log files and extracts useful information out of it.</p> |
| <p>If the deploy-mode is ‘client’, log the output of the submit command as those |
| are the output logs of the Spark worker directly.</p> |
| <p>Remark: If the driver needs to be tracked for its status, the log-level of the |
| spark deploy needs to be at least INFO (log4j.logger.org.apache.spark.deploy=INFO)</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>itr</strong> – An iterator which iterates over the input of the subprocess</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._process_spark_status_log"> |
| <code class="descname">_process_spark_status_log</code><span class="sig-paren">(</span><em>self</em>, <em>itr</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._process_spark_status_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._process_spark_status_log" title="Permalink to this definition">¶</a></dt> |
| <dd><p>parses the logs of the spark driver status query process</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>itr</strong> – An iterator which iterates over the input of the subprocess</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._start_driver_status_tracking"> |
| <code class="descname">_start_driver_status_tracking</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._start_driver_status_tracking"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._start_driver_status_tracking" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Polls the driver based on self._driver_id to get the status. |
| Finish successfully when the status is FINISHED. |
| Finish failed when the status is ERROR/UNKNOWN/KILLED/FAILED.</p> |
| <p>Possible status:</p> |
| <dl class="simple"> |
| <dt>SUBMITTED</dt><dd><p>Submitted but not yet scheduled on a worker</p> |
| </dd> |
| <dt>RUNNING</dt><dd><p>Has been allocated to a worker to run</p> |
| </dd> |
| <dt>FINISHED</dt><dd><p>Previously ran and exited cleanly</p> |
| </dd> |
| <dt>RELAUNCHING</dt><dd><p>Exited non-zero or due to worker failure, but has not yet |
| started running again</p> |
| </dd> |
| <dt>UNKNOWN</dt><dd><p>The status of the driver is temporarily not known due to |
| master failure recovery</p> |
| </dd> |
| <dt>KILLED</dt><dd><p>A user manually killed this driver</p> |
| </dd> |
| <dt>FAILED</dt><dd><p>The driver exited non-zero and was not supervised</p> |
| </dd> |
| <dt>ERROR</dt><dd><p>Unable to run or restart due to an unrecoverable error |
| (e.g. missing jar file)</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_spark_driver_kill_command"> |
| <code class="descname">_build_spark_driver_kill_command</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook._build_spark_driver_kill_command"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook._build_spark_driver_kill_command" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Construct the spark-submit command to kill a driver. |
| :return: full command to kill a driver</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.on_kill"> |
| <code class="descname">on_kill</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/spark_submit_hook.html#SparkSubmitHook.on_kill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook.on_kill" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../sqoop_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.sqoop_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../spark_sql_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.spark_sql_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> |
