You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2018/08/29 20:25:04 UTC
[36/48] incubator-airflow-site git commit: 1.10.0 with Updated Api
Reference
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/qubole_check_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/qubole_check_operator.html b/_modules/airflow/contrib/operators/qubole_check_operator.html
new file mode 100644
index 0000000..0d54850
--- /dev/null
+++ b/_modules/airflow/contrib/operators/qubole_check_operator.html
@@ -0,0 +1,443 @@
+
+
+<!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 — Airflow Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
+
+</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 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 & 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="../../../../lineage.html">Lineage</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="../../../../code.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> »</li>
+
+ <li><a href="../../../index.html">Module code</a> »</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"># "License"); 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"># "AS IS" 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="../../../../code.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">"""</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 Commmand</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 (``""``)</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's partition is</span>
+<span class="sd"> greater than yesterday'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"> """</span>
+
+ <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>
+ <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>
+ <span class="n">ui_fgcolor</span> <span class="o">=</span> <span class="s1">'#000'</span>
+
+ <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">"qubole_default"</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>
+
+ <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>
+
+ <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>
+
+ <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">'hook'</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>
+
+ <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">''</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>
+
+ <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 class="viewcode-block" id="QuboleValueCheckOperator"><a class="viewcode-back" href="../../../../code.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">"""</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/int/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/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"> """</span>
+
+ <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>
+ <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>
+ <span class="n">ui_fgcolor</span> <span class="o">=</span> <span class="s1">'#000'</span>
+
+ <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">"qubole_default"</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>
+
+ <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>
+
+ <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>
+
+ <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">'hook'</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>
+
+ <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">''</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>
+
+ <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>
+
+
+<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">''</span>
+ <span class="k">if</span> <span class="s1">'query'</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">'query'</span><span class="p">]</span>
+ <span class="k">elif</span> <span class="s1">'sql'</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">'sql'</span><span class="p">]</span>
+ <span class="k">return</span> <span class="n">sql</span>
+
+
+<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">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">'</span><span class="se">\n</span><span class="s1">Qubole Command Id: </span><span class="si">{qubole_command_id}</span><span class="s1">'</span> \
+ <span class="s1">'</span><span class="se">\n</span><span class="s1">Qubole Command Results:'</span> \
+ <span class="s1">'</span><span class="se">\n</span><span class="si">{qubole_command_results}</span><span class="s1">'</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="n">airflow_exception</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
+</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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../../',
+ VERSION:'',
+ LANGUAGE:'None',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </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/js/theme.js"></script>
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/qubole_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/qubole_operator.html b/_modules/airflow/contrib/operators/qubole_operator.html
index b14626b..9832afc 100644
--- a/_modules/airflow/contrib/operators/qubole_operator.html
+++ b/_modules/airflow/contrib/operators/qubole_operator.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../../index.html"/>
- <link rel="up" title="Module code" href="../../../index.html"/>
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># "License"); 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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
@@ -293,7 +283,7 @@
<span class="s1">'extract_query'</span><span class="p">,</span> <span class="s1">'boundary_query'</span><span class="p">,</span> <span class="s1">'macros'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'parameters'</span><span class="p">,</span>
<span class="s1">'dbtap_id'</span><span class="p">,</span> <span class="s1">'hive_table'</span><span class="p">,</span> <span class="s1">'db_table'</span><span class="p">,</span> <span class="s1">'split_column'</span><span class="p">,</span> <span class="s1">'note_id'</span><span class="p">,</span>
<span class="s1">'db_update_keys'</span><span class="p">,</span> <span class="s1">'export_dir'</span><span class="p">,</span> <span class="s1">'partition_spec'</span><span class="p">,</span> <span class="s1">'qubole_conn_id'</span><span class="p">,</span>
- <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'user_program_arguments'</span><span class="p">)</span>
+ <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'user_program_arguments'</span><span class="p">,</span> <span class="s1">'cluster_label'</span><span class="p">)</span>
<span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.txt'</span><span class="p">,)</span>
<span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#3064A1'</span>
@@ -348,9 +338,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -362,7 +350,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -381,6 +369,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -393,19 +382,13 @@
-
-
- <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/s3_list_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/s3_list_operator.html b/_modules/airflow/contrib/operators/s3_list_operator.html
index 531f835..d2167d2 100644
--- a/_modules/airflow/contrib/operators/s3_list_operator.html
+++ b/_modules/airflow/contrib/operators/s3_list_operator.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../../index.html"/>
- <link rel="up" title="Module code" href="../../../index.html"/>
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># "License"); 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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
@@ -200,12 +190,12 @@
<span class="sd"> This operator returns a python list with the name of objects which can be</span>
<span class="sd"> used by `xcom` in the downstream task.</span>
-<span class="sd"> :param bucket: The S3 bucket where to find the objects.</span>
+<span class="sd"> :param bucket: The S3 bucket where to find the objects. (templated)</span>
<span class="sd"> :type bucket: string</span>
<span class="sd"> :param prefix: Prefix string to filters the objects whose name begin with</span>
-<span class="sd"> such prefix</span>
+<span class="sd"> such prefix. (templated)</span>
<span class="sd"> :type prefix: string</span>
-<span class="sd"> :param delimiter: the delimiter marks key hierarchy.</span>
+<span class="sd"> :param delimiter: the delimiter marks key hierarchy. (templated)</span>
<span class="sd"> :type delimiter: string</span>
<span class="sd"> :param aws_conn_id: The connection ID to use when connecting to S3 storage.</span>
<span class="sd"> :type aws_conn_id: string</span>
@@ -254,9 +244,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -268,7 +256,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -287,6 +275,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -299,19 +288,13 @@
-
-
- <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/s3_to_gcs_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/s3_to_gcs_operator.html b/_modules/airflow/contrib/operators/s3_to_gcs_operator.html
index 754fcb2..bd351a6 100644
--- a/_modules/airflow/contrib/operators/s3_to_gcs_operator.html
+++ b/_modules/airflow/contrib/operators/s3_to_gcs_operator.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../../index.html"/>
- <link rel="up" title="Module code" href="../../../index.html"/>
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -203,12 +193,12 @@
<span class="sd"> Synchronizes an S3 key, possibly a prefix, with a Google Cloud Storage</span>
<span class="sd"> destination path.</span>
-<span class="sd"> :param bucket: The S3 bucket where to find the objects.</span>
+<span class="sd"> :param bucket: The S3 bucket where to find the objects. (templated)</span>
<span class="sd"> :type bucket: string</span>
<span class="sd"> :param prefix: Prefix string which filters objects whose name begin with</span>
-<span class="sd"> such prefix.</span>
+<span class="sd"> such prefix. (templated)</span>
<span class="sd"> :type prefix: string</span>
-<span class="sd"> :param delimiter: the delimiter marks key hierarchy.</span>
+<span class="sd"> :param delimiter: the delimiter marks key hierarchy. (templated)</span>
<span class="sd"> :type delimiter: string</span>
<span class="sd"> :param aws_conn_id: The source S3 connection</span>
<span class="sd"> :type aws_conn_id: string</span>
@@ -216,7 +206,7 @@
<span class="sd"> when connecting to Google Cloud Storage.</span>
<span class="sd"> :type dest_gcs_conn_id: string</span>
<span class="sd"> :param dest_gcs: The destination Google Cloud Storage bucket and prefix</span>
-<span class="sd"> where you want to store the files.</span>
+<span class="sd"> where you want to store the files. (templated)</span>
<span class="sd"> :type dest_gcs: string</span>
<span class="sd"> :param delegate_to: The account to impersonate, if any.</span>
<span class="sd"> For this to work, the service account making the request must have</span>
@@ -362,9 +352,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -376,7 +364,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -395,6 +383,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -407,19 +396,13 @@
-
-
- <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/segment_track_event_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/segment_track_event_operator.html b/_modules/airflow/contrib/operators/segment_track_event_operator.html
new file mode 100644
index 0000000..2338cd2
--- /dev/null
+++ b/_modules/airflow/contrib/operators/segment_track_event_operator.html
@@ -0,0 +1,287 @@
+
+
+<!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.segment_track_event_operator — Airflow Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
+
+</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 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 & 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="../../../../lineage.html">Lineage</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="../../../../code.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> »</li>
+
+ <li><a href="../../../index.html">Module code</a> »</li>
+
+ <li>airflow.contrib.operators.segment_track_event_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.segment_track_event_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"># "License"); 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"># "AS IS" 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="kn">from</span> <span class="nn">airflow.contrib.hooks.segment_hook</span> <span class="k">import</span> <span class="n">SegmentHook</span>
+<span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span>
+<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
+
+
+<div class="viewcode-block" id="SegmentTrackEventOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.segment_track_event_operator.SegmentTrackEventOperator">[docs]</a><span class="k">class</span> <span class="nc">SegmentTrackEventOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Send Track Event to Segment for a specified user_id and event</span>
+
+<span class="sd"> :param user_id: The ID for this user in your database. (templated)</span>
+<span class="sd"> :type user_id: string</span>
+<span class="sd"> :param event: The name of the event you're tracking. (templated)</span>
+<span class="sd"> :type event: string</span>
+<span class="sd"> :param properties: A dictionary of properties for the event. (templated)</span>
+<span class="sd"> :type properties: dict</span>
+<span class="sd"> :param segment_conn_id: The connection ID to use when connecting to Segment.</span>
+<span class="sd"> :type segment_conn_id: string</span>
+<span class="sd"> :param segment_debug_mode: Determines whether Segment should run in debug mode.</span>
+<span class="sd"> Defaults to False</span>
+<span class="sd"> :type segment_debug_mode: boolean</span>
+<span class="sd"> """</span>
+ <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'user_id'</span><span class="p">,</span> <span class="s1">'event'</span><span class="p">,</span> <span class="s1">'properties'</span><span class="p">)</span>
+ <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#ffd700'</span>
+
+ <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">user_id</span><span class="p">,</span>
+ <span class="n">event</span><span class="p">,</span>
+ <span class="n">properties</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">segment_conn_id</span><span class="o">=</span><span class="s1">'segment_default'</span><span class="p">,</span>
+ <span class="n">segment_debug_mode</span><span class="o">=</span><span class="kc">False</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="nb">super</span><span class="p">(</span><span class="n">SegmentTrackEventOperator</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="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">user_id</span> <span class="o">=</span> <span class="n">user_id</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">event</span> <span class="o">=</span> <span class="n">event</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="n">properties</span> <span class="ow">or</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="n">properties</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">segment_debug_mode</span> <span class="o">=</span> <span class="n">segment_debug_mode</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">segment_conn_id</span> <span class="o">=</span> <span class="n">segment_conn_id</span>
+
+ <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="p">):</span>
+ <span class="n">hook</span> <span class="o">=</span> <span class="n">SegmentHook</span><span class="p">(</span><span class="n">segment_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">segment_conn_id</span><span class="p">,</span>
+ <span class="n">segment_debug_mode</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">segment_debug_mode</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
+ <span class="s1">'Sending track event (</span><span class="si">{0}</span><span class="s1">) for user id: </span><span class="si">{1}</span><span class="s1"> with properties: </span><span class="si">{2}</span><span class="s1">'</span><span class="o">.</span>
+ <span class="nb">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">event</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">user_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="p">))</span>
+
+ <span class="n">hook</span><span class="o">.</span><span class="n">track</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">user_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">event</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../../',
+ VERSION:'',
+ LANGUAGE:'None',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </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/js/theme.js"></script>
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/sftp_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/sftp_operator.html b/_modules/airflow/contrib/operators/sftp_operator.html
index 128db98..cc674da 100644
--- a/_modules/airflow/contrib/operators/sftp_operator.html
+++ b/_modules/airflow/contrib/operators/sftp_operator.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../../index.html"/>
- <link rel="up" title="Module code" href="../../../index.html"/>
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># "License"); 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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
@@ -210,9 +200,9 @@
<span class="sd"> :type ssh_conn_id: str</span>
<span class="sd"> :param remote_host: remote host to connect</span>
<span class="sd"> :type remote_host: str</span>
-<span class="sd"> :param local_filepath: local file path to get or put</span>
+<span class="sd"> :param local_filepath: local file path to get or put. (templated)</span>
<span class="sd"> :type local_filepath: str</span>
-<span class="sd"> :param remote_filepath: remote file path to get or put</span>
+<span class="sd"> :param remote_filepath: remote file path to get or put. (templated)</span>
<span class="sd"> :type remote_filepath: str</span>
<span class="sd"> :param operation: specify operation 'get' or 'put', defaults to get</span>
<span class="sd"> :type get: bool</span>
@@ -236,7 +226,8 @@
<span class="bp">self</span><span class="o">.</span><span class="n">local_filepath</span> <span class="o">=</span> <span class="n">local_filepath</span>
<span class="bp">self</span><span class="o">.</span><span class="n">remote_filepath</span> <span class="o">=</span> <span class="n">remote_filepath</span>
<span class="bp">self</span><span class="o">.</span><span class="n">operation</span> <span class="o">=</span> <span class="n">operation</span>
- <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operation</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">GET</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">PUT</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operation</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">GET</span> <span class="ow">or</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">operation</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">PUT</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"unsupported operation value </span><span class="si">{0}</span><span class="s2">, expected </span><span class="si">{1}</span><span class="s2"> or </span><span class="si">{2}</span><span class="s2">"</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operation</span><span class="p">,</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">GET</span><span class="p">,</span> <span class="n">SFTPOperation</span><span class="o">.</span><span class="n">PUT</span><span class="p">))</span>
@@ -273,9 +264,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -287,7 +276,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -306,6 +295,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -318,19 +308,13 @@
-
-
- <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/contrib/operators/slack_webhook_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/slack_webhook_operator.html b/_modules/airflow/contrib/operators/slack_webhook_operator.html
index 51eae15..a3635cb 100644
--- a/_modules/airflow/contrib/operators/slack_webhook_operator.html
+++ b/_modules/airflow/contrib/operators/slack_webhook_operator.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../../index.html"/>
- <link rel="up" title="Module code" href="../../../index.html"/>
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># "License"); 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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
@@ -264,9 +254,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -278,7 +266,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -297,6 +285,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -309,19 +298,13 @@
-
-
- <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file