Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _modules / airflow / contrib / operators / qubole_check_operator.html
blob: 2357e6bf14776e0ac4ac226fafc04cd036e6708b [file] [log] [blame]
<!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_check_operator &mdash; 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" />
<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>
<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 &amp; 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"><a class="reference internal" href="../../../../_api/index.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../operators.html">airflow.contrib.operators</a> &raquo;</li>
<li>airflow.contrib.operators.qubole_check_operator</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for airflow.contrib.operators.qubole_check_operator</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.operators.qubole_operator</span> <span class="k">import</span> <span class="n">QuboleOperator</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.qubole_check_hook</span> <span class="k">import</span> <span class="n">QuboleCheckHook</span>
<span class="kn">from</span> <span class="nn">airflow.operators.check_operator</span> <span class="k">import</span> <span class="n">CheckOperator</span><span class="p">,</span> <span class="n">ValueCheckOperator</span>
<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span>
<div class="viewcode-block" id="QuboleCheckOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator">[docs]</a><span class="k">class</span> <span class="nc">QuboleCheckOperator</span><span class="p">(</span><span class="n">CheckOperator</span><span class="p">,</span> <span class="n">QuboleOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Performs checks against Qubole Commands. ``QuboleCheckOperator`` expects</span>
<span class="sd"> a command that will be executed on QDS.</span>
<span class="sd"> By default, each value on first row of the result of this Qubole Command</span>
<span class="sd"> is evaluated using python ``bool`` casting. If any of the</span>
<span class="sd"> values return ``False``, the check is failed and errors out.</span>
<span class="sd"> Note that Python bool casting evals the following as ``False``:</span>
<span class="sd"> * ``False``</span>
<span class="sd"> * ``0``</span>
<span class="sd"> * Empty string (``&quot;&quot;``)</span>
<span class="sd"> * Empty list (``[]``)</span>
<span class="sd"> * Empty dictionary or set (``{}``)</span>
<span class="sd"> Given a query like ``SELECT COUNT(*) FROM foo``, it will fail only if</span>
<span class="sd"> the count ``== 0``. You can craft much more complex query that could,</span>
<span class="sd"> for instance, check that the table has the same number of rows as</span>
<span class="sd"> the source table upstream, or that the count of today&#39;s partition is</span>
<span class="sd"> greater than yesterday&#39;s partition, or that a set of metrics are less</span>
<span class="sd"> than 3 standard deviation for the 7 day average.</span>
<span class="sd"> This operator can be used as a data quality check in your pipeline, and</span>
<span class="sd"> depending on where you put it in your DAG, you have the choice to</span>
<span class="sd"> stop the critical path, preventing from</span>
<span class="sd"> publishing dubious data, or on the side and receive email alerts</span>
<span class="sd"> without stopping the progress of the DAG.</span>
<span class="sd"> :param qubole_conn_id: Connection id which consists of qds auth_token</span>
<span class="sd"> :type qubole_conn_id: str</span>
<span class="sd"> kwargs:</span>
<span class="sd"> Arguments specific to Qubole command can be referred from QuboleOperator docs.</span>
<span class="sd"> :results_parser_callable: This is an optional parameter to</span>
<span class="sd"> extend the flexibility of parsing the results of Qubole</span>
<span class="sd"> command to the users. This is a python callable which</span>
<span class="sd"> can hold the logic to parse list of rows returned by Qubole command.</span>
<span class="sd"> By default, only the values on first row are used for performing checks.</span>
<span class="sd"> This callable should return a list of records on</span>
<span class="sd"> which the checks have to be performed.</span>
<span class="sd"> .. note:: All fields in common with template fields of</span>
<span class="sd"> QuboleOperator and CheckOperator are template-supported.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="QuboleCheckOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_fields</span> <span class="o">+</span> <span class="n">CheckOperator</span><span class="o">.</span><span class="n">template_fields</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_ext</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.ui_fgcolor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.ui_fgcolor">[docs]</a> <span class="n">ui_fgcolor</span> <span class="o">=</span> <span class="s1">&#39;#000&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">qubole_conn_id</span><span class="o">=</span><span class="s2">&quot;qubole_default&quot;</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">get_sql_from_qbol_cmd</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">QuboleCheckOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>\
<span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">qubole_conn_id</span><span class="o">=</span><span class="n">qubole_conn_id</span><span class="p">,</span> <span class="n">sql</span><span class="o">=</span><span class="n">sql</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_failure_callback</span> <span class="o">=</span> <span class="n">QuboleCheckHook</span><span class="o">.</span><span class="n">handle_failure_retry</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_retry_callback</span> <span class="o">=</span> <span class="n">QuboleCheckHook</span><span class="o">.</span><span class="n">handle_failure_retry</span>
<div class="viewcode-block" id="QuboleCheckOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">QuboleCheckOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
<span class="k">except</span> <span class="n">AirflowException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">handle_airflow_exception</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">())</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.get_db_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.get_db_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_db_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.get_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.get_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;hook&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">QuboleCheckHook</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.__getattribute__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.__getattribute__">[docs]</a> <span class="k">def</span> <span class="nf">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleCheckOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
<div class="viewcode-block" id="QuboleCheckOperator.__setattr__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleCheckOperator.__setattr__">[docs]</a> <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleCheckOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="QuboleValueCheckOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator">[docs]</a><span class="k">class</span> <span class="nc">QuboleValueCheckOperator</span><span class="p">(</span><span class="n">ValueCheckOperator</span><span class="p">,</span> <span class="n">QuboleOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Performs a simple value check using Qubole command.</span>
<span class="sd"> By default, each value on the first row of this</span>
<span class="sd"> Qubole command is compared with a pre-defined value.</span>
<span class="sd"> The check fails and errors out if the output of the command</span>
<span class="sd"> is not within the permissible limit of expected value.</span>
<span class="sd"> :param qubole_conn_id: Connection id which consists of qds auth_token</span>
<span class="sd"> :type qubole_conn_id: str</span>
<span class="sd"> :param pass_value: Expected value of the query results.</span>
<span class="sd"> :type pass_value: str or int or float</span>
<span class="sd"> :param tolerance: Defines the permissible pass_value range, for example if</span>
<span class="sd"> tolerance is 2, the Qubole command output can be anything between</span>
<span class="sd"> -2*pass_value and 2*pass_value, without the operator erring out.</span>
<span class="sd"> :type tolerance: int or float</span>
<span class="sd"> kwargs:</span>
<span class="sd"> Arguments specific to Qubole command can be referred from QuboleOperator docs.</span>
<span class="sd"> :results_parser_callable: This is an optional parameter to</span>
<span class="sd"> extend the flexibility of parsing the results of Qubole</span>
<span class="sd"> command to the users. This is a python callable which</span>
<span class="sd"> can hold the logic to parse list of rows returned by Qubole command.</span>
<span class="sd"> By default, only the values on first row are used for performing checks.</span>
<span class="sd"> This callable should return a list of records on</span>
<span class="sd"> which the checks have to be performed.</span>
<span class="sd"> .. note:: All fields in common with template fields of</span>
<span class="sd"> QuboleOperator and ValueCheckOperator are template-supported.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="QuboleValueCheckOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_fields</span> <span class="o">+</span> <span class="n">ValueCheckOperator</span><span class="o">.</span><span class="n">template_fields</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="n">QuboleOperator</span><span class="o">.</span><span class="n">template_ext</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.ui_fgcolor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.ui_fgcolor">[docs]</a> <span class="n">ui_fgcolor</span> <span class="o">=</span> <span class="s1">&#39;#000&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pass_value</span><span class="p">,</span> <span class="n">tolerance</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">qubole_conn_id</span><span class="o">=</span><span class="s2">&quot;qubole_default&quot;</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">get_sql_from_qbol_cmd</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">QuboleValueCheckOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
<span class="n">qubole_conn_id</span><span class="o">=</span><span class="n">qubole_conn_id</span><span class="p">,</span>
<span class="n">sql</span><span class="o">=</span><span class="n">sql</span><span class="p">,</span> <span class="n">pass_value</span><span class="o">=</span><span class="n">pass_value</span><span class="p">,</span> <span class="n">tolerance</span><span class="o">=</span><span class="n">tolerance</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_failure_callback</span> <span class="o">=</span> <span class="n">QuboleCheckHook</span><span class="o">.</span><span class="n">handle_failure_retry</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_retry_callback</span> <span class="o">=</span> <span class="n">QuboleCheckHook</span><span class="o">.</span><span class="n">handle_failure_retry</span>
<div class="viewcode-block" id="QuboleValueCheckOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">QuboleValueCheckOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">)</span>
<span class="k">except</span> <span class="n">AirflowException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">handle_airflow_exception</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">())</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.get_db_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.get_db_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_db_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.get_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.get_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;hook&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">QuboleCheckHook</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">context</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.__getattribute__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.__getattribute__">[docs]</a> <span class="k">def</span> <span class="nf">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleValueCheckOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">&#39;&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
<div class="viewcode-block" id="QuboleValueCheckOperator.__setattr__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.QuboleValueCheckOperator.__setattr__">[docs]</a> <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">QuboleValueCheckOperator</span><span class="o">.</span><span class="n">template_fields</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="get_sql_from_qbol_cmd"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.get_sql_from_qbol_cmd">[docs]</a><span class="k">def</span> <span class="nf">get_sql_from_qbol_cmd</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
<span class="n">sql</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="k">if</span> <span class="s1">&#39;query&#39;</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;query&#39;</span><span class="p">]</span>
<span class="k">elif</span> <span class="s1">&#39;sql&#39;</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;sql&#39;</span><span class="p">]</span>
<span class="k">return</span> <span class="n">sql</span></div>
<div class="viewcode-block" id="handle_airflow_exception"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/qubole_check_operator/index.html#airflow.contrib.operators.qubole_check_operator.handle_airflow_exception">[docs]</a><span class="k">def</span> <span class="nf">handle_airflow_exception</span><span class="p">(</span><span class="n">airflow_exception</span><span class="p">,</span> <span class="n">hook</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">cmd</span>
<span class="k">if</span> <span class="n">cmd</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">cmd</span><span class="o">.</span><span class="n">is_success</span><span class="p">(</span><span class="n">cmd</span><span class="o">.</span><span class="n">status</span><span class="p">):</span>
<span class="n">qubole_command_results</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">get_query_results</span><span class="p">()</span>
<span class="n">qubole_command_id</span> <span class="o">=</span> <span class="n">cmd</span><span class="o">.</span><span class="n">id</span>
<span class="n">exception_message</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Qubole Command Id: </span><span class="si">{qubole_command_id}</span><span class="s1">&#39;</span> \
<span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Qubole Command Results:&#39;</span> \
<span class="s1">&#39;</span><span class="se">\n</span><span class="si">{qubole_command_results}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="nb">locals</span><span class="p">())</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">airflow_exception</span><span class="p">)</span> <span class="o">+</span> <span class="n">exception_message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">airflow_exception</span><span class="p">))</span></div>
</pre></div>
</div>
</div>
<footer>
<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>