| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.contrib.operators.qubole_operator — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../../search.html" /> |
| <link rel="next" title="airflow.contrib.operators.redis_publish_operator" href="../redis_publish_operator/index.html" /> |
| <link rel="prev" title="airflow.contrib.operators.qubole_check_operator" href="../qubole_check_operator/index.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.6 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../errors.html">Error Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">Python API Reference</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#operators">Operators</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#baseoperator">BaseOperator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#basesensoroperator">BaseSensorOperator</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#operators-packages">Operators packages</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../../../operators/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.sensors</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.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.sensors</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li> |
| <li class="toctree-l2"><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> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">Python API</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#operators">Operators</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#baseoperator">BaseOperator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#basesensoroperator">BaseSensorOperator</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#operators-packages">Operators packages</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../../../operators/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.sensors</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.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.sensors</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li> |
| <li class="toctree-l2"><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">Python API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.qubole_operator</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../../_sources/_api/airflow/contrib/operators/qubole_operator/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.operators.qubole_operator"> |
| <span id="airflow-contrib-operators-qubole-operator"></span><h1><a class="reference internal" href="#module-airflow.contrib.operators.qubole_operator" title="airflow.contrib.operators.qubole_operator"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.qubole_operator</span></code></a><a class="headerlink" href="#module-airflow.contrib.operators.qubole_operator" title="Permalink to this headline">¶</a></h1> |
| <p><p>Qubole operator</p> |
| </p> |
| <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.operators.qubole_operator.QDSLink"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.qubole_operator.</code><code class="sig-name descname">QDSLink</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QDSLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QDSLink" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/baseoperator/index.html#airflow.models.baseoperator.BaseOperatorLink" title="airflow.models.baseoperator.BaseOperatorLink"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.baseoperator.BaseOperatorLink</span></code></a></p> |
| <p>Link to QDS</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QDSLink.name"> |
| <code class="sig-name descname">name</code><em class="property"> = Go to QDS</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QDSLink.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QDSLink.name" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QDSLink.get_link"> |
| <code class="sig-name descname">get_link</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">operator</em>, <em class="sig-param">dttm</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QDSLink.get_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QDSLink.get_link" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.qubole_operator.</code><code class="sig-name descname">QuboleOperator</code><span class="sig-paren">(</span><em class="sig-param">qubole_conn_id='qubole_default'</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/baseoperator/index.html#airflow.models.baseoperator.BaseOperator" title="airflow.models.baseoperator.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.baseoperator.BaseOperator</span></code></a></p> |
| <p>Execute tasks (commands) on QDS (<a class="reference external" href="https://qubole.com">https://qubole.com</a>).</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters</dt> |
| <dd class="field-odd"><p><strong>qubole_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><em>str</em></a>) – Connection id which consists of qds auth_token</p> |
| </dd> |
| </dl> |
| <dl> |
| <dt>kwargs:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">command_type</dt> |
| <dd class="field-odd"><p>type of command to be executed, e.g. hivecmd, shellcmd, hadoopcmd</p> |
| </dd> |
| <dt class="field-even">tags</dt> |
| <dd class="field-even"><p>array of tags to be assigned with the command</p> |
| </dd> |
| <dt class="field-odd">cluster_label</dt> |
| <dd class="field-odd"><p>cluster label on which the command will be executed</p> |
| </dd> |
| <dt class="field-even">name</dt> |
| <dd class="field-even"><p>name to be given to command</p> |
| </dd> |
| <dt class="field-odd">notify</dt> |
| <dd class="field-odd"><p>whether to send email on command completion or not (default is False)</p> |
| </dd> |
| </dl> |
| <p><strong>Arguments specific to command types</strong></p> |
| <dl class="simple"> |
| <dt>hivecmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">query</dt> |
| <dd class="field-odd"><p>inline query statement</p> |
| </dd> |
| <dt class="field-even">script_location</dt> |
| <dd class="field-even"><p>s3 location containing query statement</p> |
| </dd> |
| <dt class="field-odd">sample_size</dt> |
| <dd class="field-odd"><p>size of sample in bytes on which to run query</p> |
| </dd> |
| <dt class="field-even">macros</dt> |
| <dd class="field-even"><p>macro values which were used in query</p> |
| </dd> |
| <dt class="field-odd">sample_size</dt> |
| <dd class="field-odd"><p>size of sample in bytes on which to run query</p> |
| </dd> |
| <dt class="field-even">hive-version</dt> |
| <dd class="field-even"><p>Specifies the hive version to be used. eg: 0.13,1.2,etc.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>prestocmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">query</dt> |
| <dd class="field-odd"><p>inline query statement</p> |
| </dd> |
| <dt class="field-even">script_location</dt> |
| <dd class="field-even"><p>s3 location containing query statement</p> |
| </dd> |
| <dt class="field-odd">macros</dt> |
| <dd class="field-odd"><p>macro values which were used in query</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>hadoopcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">sub_commnad</dt> |
| <dd class="field-odd"><p>must be one these [“jar”, “s3distcp”, “streaming”] followed by |
| 1 or more args</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>shellcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">script</dt> |
| <dd class="field-odd"><p>inline command with args</p> |
| </dd> |
| <dt class="field-even">script_location</dt> |
| <dd class="field-even"><p>s3 location containing query statement</p> |
| </dd> |
| <dt class="field-odd">files</dt> |
| <dd class="field-odd"><p>list of files in s3 bucket as file1,file2 format. These files will be |
| copied into the working directory where the qubole command is being |
| executed.</p> |
| </dd> |
| <dt class="field-even">archives</dt> |
| <dd class="field-even"><p>list of archives in s3 bucket as archive1,archive2 format. These |
| will be unarchived into the working directory where the qubole command is |
| being executed</p> |
| </dd> |
| <dt class="field-odd">parameters</dt> |
| <dd class="field-odd"><p>any extra args which need to be passed to script (only when |
| script_location is supplied)</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>pigcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">script</dt> |
| <dd class="field-odd"><p>inline query statement (latin_statements)</p> |
| </dd> |
| <dt class="field-even">script_location</dt> |
| <dd class="field-even"><p>s3 location containing pig query</p> |
| </dd> |
| <dt class="field-odd">parameters</dt> |
| <dd class="field-odd"><p>any extra args which need to be passed to script (only when |
| script_location is supplied</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>sparkcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">program</dt> |
| <dd class="field-odd"><p>the complete Spark Program in Scala, R, or Python</p> |
| </dd> |
| <dt class="field-even">cmdline</dt> |
| <dd class="field-even"><p>spark-submit command line, all required information must be specify |
| in cmdline itself.</p> |
| </dd> |
| <dt class="field-odd">sql</dt> |
| <dd class="field-odd"><p>inline sql query</p> |
| </dd> |
| <dt class="field-even">script_location</dt> |
| <dd class="field-even"><p>s3 location containing query statement</p> |
| </dd> |
| <dt class="field-odd">language</dt> |
| <dd class="field-odd"><p>language of the program, Scala, R, or Python</p> |
| </dd> |
| <dt class="field-even">app_id</dt> |
| <dd class="field-even"><p>ID of an Spark job server app</p> |
| </dd> |
| <dt class="field-odd">arguments</dt> |
| <dd class="field-odd"><p>spark-submit command line arguments</p> |
| </dd> |
| <dt class="field-even">user_program_arguments</dt> |
| <dd class="field-even"><p>arguments that the user program takes in</p> |
| </dd> |
| <dt class="field-odd">macros</dt> |
| <dd class="field-odd"><p>macro values which were used in query</p> |
| </dd> |
| <dt class="field-even">note_id</dt> |
| <dd class="field-even"><p>Id of the Notebook to run</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>dbtapquerycmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">db_tap_id</dt> |
| <dd class="field-odd"><p>data store ID of the target database, in Qubole.</p> |
| </dd> |
| <dt class="field-even">query</dt> |
| <dd class="field-even"><p>inline query statement</p> |
| </dd> |
| <dt class="field-odd">macros</dt> |
| <dd class="field-odd"><p>macro values which were used in query</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>dbexportcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">mode</dt> |
| <dd class="field-odd"><p>Can be 1 for Hive export or 2 for HDFS/S3 export</p> |
| </dd> |
| <dt class="field-even">schema</dt> |
| <dd class="field-even"><p>Db schema name assumed accordingly by database if not specified</p> |
| </dd> |
| <dt class="field-odd">hive_table</dt> |
| <dd class="field-odd"><p>Name of the hive table</p> |
| </dd> |
| <dt class="field-even">partition_spec</dt> |
| <dd class="field-even"><p>partition specification for Hive table.</p> |
| </dd> |
| <dt class="field-odd">dbtap_id</dt> |
| <dd class="field-odd"><p>data store ID of the target database, in Qubole.</p> |
| </dd> |
| <dt class="field-even">db_table</dt> |
| <dd class="field-even"><p>name of the db table</p> |
| </dd> |
| <dt class="field-odd">db_update_mode</dt> |
| <dd class="field-odd"><p>allowinsert or updateonly</p> |
| </dd> |
| <dt class="field-even">db_update_keys</dt> |
| <dd class="field-even"><p>columns used to determine the uniqueness of rows</p> |
| </dd> |
| <dt class="field-odd">export_dir</dt> |
| <dd class="field-odd"><p>HDFS/S3 location from which data will be exported.</p> |
| </dd> |
| <dt class="field-even">fields_terminated_by</dt> |
| <dd class="field-even"><p>hex of the char used as column separator in the dataset</p> |
| </dd> |
| <dt class="field-odd">use_customer_cluster</dt> |
| <dd class="field-odd"><p>To use cluster to run command</p> |
| </dd> |
| <dt class="field-even">customer_cluster_label</dt> |
| <dd class="field-even"><p>the label of the cluster to run the command on</p> |
| </dd> |
| <dt class="field-odd">additional_options</dt> |
| <dd class="field-odd"><p>Additional Sqoop options which are needed enclose options in |
| double or single quotes e.g. ‘–map-column-hive id=int,data=string’</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt>dbimportcmd:</dt><dd><dl class="field-list simple"> |
| <dt class="field-odd">mode</dt> |
| <dd class="field-odd"><p>1 (simple), 2 (advance)</p> |
| </dd> |
| <dt class="field-even">hive_table</dt> |
| <dd class="field-even"><p>Name of the hive table</p> |
| </dd> |
| <dt class="field-odd">schema</dt> |
| <dd class="field-odd"><p>Db schema name assumed accordingly by database if not specified</p> |
| </dd> |
| <dt class="field-even">hive_serde</dt> |
| <dd class="field-even"><p>Output format of the Hive Table</p> |
| </dd> |
| <dt class="field-odd">dbtap_id</dt> |
| <dd class="field-odd"><p>data store ID of the target database, in Qubole.</p> |
| </dd> |
| <dt class="field-even">db_table</dt> |
| <dd class="field-even"><p>name of the db table</p> |
| </dd> |
| <dt class="field-odd">where_clause</dt> |
| <dd class="field-odd"><p>where clause, if any</p> |
| </dd> |
| <dt class="field-even">parallelism</dt> |
| <dd class="field-even"><p>number of parallel db connections to use for extracting data</p> |
| </dd> |
| <dt class="field-odd">extract_query</dt> |
| <dd class="field-odd"><p>SQL query to extract data from db. $CONDITIONS must be part |
| of the where clause.</p> |
| </dd> |
| <dt class="field-even">boundary_query</dt> |
| <dd class="field-even"><p>Query to be used get range of row IDs to be extracted</p> |
| </dd> |
| <dt class="field-odd">split_column</dt> |
| <dd class="field-odd"><p>Column used as row ID to split data into ranges (mode 2)</p> |
| </dd> |
| <dt class="field-even">use_customer_cluster</dt> |
| <dd class="field-even"><p>To use cluster to run command</p> |
| </dd> |
| <dt class="field-odd">customer_cluster_label</dt> |
| <dd class="field-odd"><p>the label of the cluster to run the command on</p> |
| </dd> |
| <dt class="field-even">additional_options</dt> |
| <dd class="field-even"><p>Additional Sqoop options which are needed enclose options in |
| double or single quotes</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> :Iterable[str] = ['query', 'script_location', 'sub_command', 'script', 'files', 'archives', 'program', 'cmdline', 'sql', 'where_clause', 'tags', 'extract_query', 'boundary_query', 'macros', 'name', 'parameters', 'dbtap_id', 'hive_table', 'db_table', 'split_column', 'note_id', 'db_update_keys', 'export_dir', 'partition_spec', 'qubole_conn_id', 'arguments', 'user_program_arguments', 'cluster_label']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.template_ext"> |
| <code class="sig-name descname">template_ext</code><em class="property"> :Iterable[str] = ['.txt']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.template_ext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.template_ext" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #3064A1</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.ui_fgcolor"> |
| <code class="sig-name descname">ui_fgcolor</code><em class="property"> = #fff</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.ui_fgcolor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.ui_fgcolor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.qubole_hook_allowed_args_list"> |
| <code class="sig-name descname">qubole_hook_allowed_args_list</code><em class="property"> = ['command_type', 'qubole_conn_id', 'fetch_logs']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.qubole_hook_allowed_args_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.qubole_hook_allowed_args_list" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.operator_extra_links"> |
| <code class="sig-name descname">operator_extra_links</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.operator_extra_links"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.operator_extra_links" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator._get_filtered_args"> |
| <code class="sig-name descname">_get_filtered_args</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">all_kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator._get_filtered_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator._get_filtered_args" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.on_kill"> |
| <code class="sig-name descname">on_kill</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">ti=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.on_kill"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.on_kill" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.get_results"> |
| <code class="sig-name descname">get_results</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">ti=None</em>, <em class="sig-param">fp=None</em>, <em class="sig-param">inline=True</em>, <em class="sig-param">delim=None</em>, <em class="sig-param">fetch=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.get_results" title="Permalink to this definition">¶</a></dt> |
| <dd><p>get_results from Qubole</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.get_log"> |
| <code class="sig-name descname">get_log</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">ti</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.get_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.get_log" title="Permalink to this definition">¶</a></dt> |
| <dd><p>get_log from Qubole</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.get_jobs_id"> |
| <code class="sig-name descname">get_jobs_id</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">ti</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.get_jobs_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.get_jobs_id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>get jobs_id from Qubole</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.get_hook"> |
| <code class="sig-name descname">get_hook</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.get_hook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.get_hook" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reinitialising the hook, as some template fields might have changed</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.__getattribute__"> |
| <code class="sig-name descname">__getattribute__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.__getattribute__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.__getattribute__" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.qubole_operator.QuboleOperator.__setattr__"> |
| <code class="sig-name descname">__setattr__</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">name</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/qubole_operator.html#QuboleOperator.__setattr__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.qubole_operator.QuboleOperator.__setattr__" 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="../redis_publish_operator/index.html" class="btn btn-neutral float-right" title="airflow.contrib.operators.redis_publish_operator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../qubole_check_operator/index.html" class="btn btn-neutral float-left" title="airflow.contrib.operators.qubole_check_operator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
