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/27 16:26:43 UTC
[23/51] [partial] incubator-airflow-site git commit: 1.10.0
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/11437c14/_modules/airflow/contrib/operators/sqoop_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/sqoop_operator.html b/_modules/airflow/contrib/operators/sqoop_operator.html
new file mode 100644
index 0000000..31fafec
--- /dev/null
+++ b/_modules/airflow/contrib/operators/sqoop_operator.html
@@ -0,0 +1,467 @@
+
+
+<!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.sqoop_operator — Airflow Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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"/>
+
+
+ <script src="../../../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+
+ <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" role="navigation" 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.sqoop_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.sqoop_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="sd">"""</span>
+<span class="sd">This module contains a sqoop 1 operator</span>
+<span class="sd">"""</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">signal</span>
+
+<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.sqoop_hook</span> <span class="k">import</span> <span class="n">SqoopHook</span>
+<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</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="SqoopOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sqoop_operator.SqoopOperator">[docs]</a><span class="k">class</span> <span class="nc">SqoopOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Execute a Sqoop job.</span>
+<span class="sd"> Documentation for Apache Sqoop can be found here: https://sqoop.apache.org/docs/1.4.2/SqoopUserGuide.html.</span>
+<span class="sd"> """</span>
+ <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'conn_id'</span><span class="p">,</span> <span class="s1">'cmd_type'</span><span class="p">,</span> <span class="s1">'table'</span><span class="p">,</span> <span class="s1">'query'</span><span class="p">,</span> <span class="s1">'target_dir'</span><span class="p">,</span> <span class="s1">'file_type'</span><span class="p">,</span> <span class="s1">'columns'</span><span class="p">,</span> <span class="s1">'split_by'</span><span class="p">,</span>
+ <span class="s1">'where'</span><span class="p">,</span> <span class="s1">'export_dir'</span><span class="p">,</span> <span class="s1">'input_null_string'</span><span class="p">,</span> <span class="s1">'input_null_non_string'</span><span class="p">,</span> <span class="s1">'staging_table'</span><span class="p">,</span>
+ <span class="s1">'enclosed_by'</span><span class="p">,</span> <span class="s1">'escaped_by'</span><span class="p">,</span> <span class="s1">'input_fields_terminated_by'</span><span class="p">,</span> <span class="s1">'input_lines_terminated_by'</span><span class="p">,</span>
+ <span class="s1">'input_optionally_enclosed_by'</span><span class="p">,</span> <span class="s1">'properties'</span><span class="p">,</span> <span class="s1">'extra_import_options'</span><span class="p">,</span> <span class="s1">'driver'</span><span class="p">,</span>
+ <span class="s1">'extra_export_options'</span><span class="p">,</span> <span class="s1">'hcatalog_database'</span><span class="p">,</span> <span class="s1">'hcatalog_table'</span><span class="p">,)</span>
+ <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#7D8CA4'</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">conn_id</span><span class="o">=</span><span class="s1">'sqoop_default'</span><span class="p">,</span>
+ <span class="n">cmd_type</span><span class="o">=</span><span class="s1">'import'</span><span class="p">,</span>
+ <span class="n">table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">target_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">append</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">file_type</span><span class="o">=</span><span class="s1">'text'</span><span class="p">,</span>
+ <span class="n">columns</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">num_mappers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">split_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">where</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">export_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">input_null_string</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">input_null_non_string</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">staging_table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">clear_staging_table</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">enclosed_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">escaped_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">input_fields_terminated_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">input_lines_terminated_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">input_optionally_enclosed_by</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">batch</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">direct</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">driver</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">relaxed_isolation</span><span class="o">=</span><span class="kc">False</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">hcatalog_database</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">hcatalog_table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">create_hcatalog_table</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+ <span class="n">extra_import_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">extra_export_options</span><span class="o">=</span><span class="kc">None</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="sd">"""</span>
+<span class="sd"> :param conn_id: str</span>
+<span class="sd"> :param cmd_type: str specify command to execute "export" or "import"</span>
+<span class="sd"> :param table: Table to read</span>
+<span class="sd"> :param query: Import result of arbitrary SQL query. Instead of using the table,</span>
+<span class="sd"> columns and where arguments, you can specify a SQL statement with the query</span>
+<span class="sd"> argument. Must also specify a destination directory with target_dir.</span>
+<span class="sd"> :param target_dir: HDFS destination directory where the data</span>
+<span class="sd"> from the rdbms will be written</span>
+<span class="sd"> :param append: Append data to an existing dataset in HDFS</span>
+<span class="sd"> :param file_type: "avro", "sequence", "text" Imports data to</span>
+<span class="sd"> into the specified format. Defaults to text.</span>
+<span class="sd"> :param columns: <col,col,col> Columns to import from table</span>
+<span class="sd"> :param num_mappers: Use n mapper tasks to import/export in parallel</span>
+<span class="sd"> :param split_by: Column of the table used to split work units</span>
+<span class="sd"> :param where: WHERE clause to use during import</span>
+<span class="sd"> :param export_dir: HDFS Hive database directory to export to the rdbms</span>
+<span class="sd"> :param input_null_string: The string to be interpreted as null</span>
+<span class="sd"> for string columns</span>
+<span class="sd"> :param input_null_non_string: The string to be interpreted as null</span>
+<span class="sd"> for non-string columns</span>
+<span class="sd"> :param staging_table: The table in which data will be staged before</span>
+<span class="sd"> being inserted into the destination table</span>
+<span class="sd"> :param clear_staging_table: Indicate that any data present in the</span>
+<span class="sd"> staging table can be deleted</span>
+<span class="sd"> :param enclosed_by: Sets a required field enclosing character</span>
+<span class="sd"> :param escaped_by: Sets the escape character</span>
+<span class="sd"> :param input_fields_terminated_by: Sets the input field separator</span>
+<span class="sd"> :param input_lines_terminated_by: Sets the input end-of-line character</span>
+<span class="sd"> :param input_optionally_enclosed_by: Sets a field enclosing character</span>
+<span class="sd"> :param batch: Use batch mode for underlying statement execution</span>
+<span class="sd"> :param direct: Use direct export fast path</span>
+<span class="sd"> :param driver: Manually specify JDBC driver class to use</span>
+<span class="sd"> :param verbose: Switch to more verbose logging for debug purposes</span>
+<span class="sd"> :param relaxed_isolation: use read uncommitted isolation level</span>
+<span class="sd"> :param hcatalog_database: Specifies the database name for the HCatalog table</span>
+<span class="sd"> :param hcatalog_table: The argument value for this option is the HCatalog table</span>
+<span class="sd"> :param create_hcatalog_table: Have sqoop create the hcatalog table passed in or not</span>
+<span class="sd"> :param properties: additional JVM properties passed to sqoop</span>
+<span class="sd"> :param extra_import_options: Extra import options to pass as dict.</span>
+<span class="sd"> If a key doesn't have a value, just pass an empty string to it.</span>
+<span class="sd"> Don't include prefix of -- for sqoop options.</span>
+<span class="sd"> :param extra_export_options: Extra export options to pass as dict.</span>
+<span class="sd"> If a key doesn't have a value, just pass an empty string to it.</span>
+<span class="sd"> Don't include prefix of -- for sqoop options.</span>
+<span class="sd"> """</span>
+ <span class="nb">super</span><span class="p">(</span><span class="n">SqoopOperator</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">conn_id</span> <span class="o">=</span> <span class="n">conn_id</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">cmd_type</span> <span class="o">=</span> <span class="n">cmd_type</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="o">=</span> <span class="n">table</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">target_dir</span> <span class="o">=</span> <span class="n">target_dir</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">append</span> <span class="o">=</span> <span class="n">append</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">file_type</span> <span class="o">=</span> <span class="n">file_type</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="n">columns</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">num_mappers</span> <span class="o">=</span> <span class="n">num_mappers</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">split_by</span> <span class="o">=</span> <span class="n">split_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">where</span> <span class="o">=</span> <span class="n">where</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">export_dir</span> <span class="o">=</span> <span class="n">export_dir</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">input_null_string</span> <span class="o">=</span> <span class="n">input_null_string</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">input_null_non_string</span> <span class="o">=</span> <span class="n">input_null_non_string</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">staging_table</span> <span class="o">=</span> <span class="n">staging_table</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">clear_staging_table</span> <span class="o">=</span> <span class="n">clear_staging_table</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">enclosed_by</span> <span class="o">=</span> <span class="n">enclosed_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">escaped_by</span> <span class="o">=</span> <span class="n">escaped_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">input_fields_terminated_by</span> <span class="o">=</span> <span class="n">input_fields_terminated_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">input_lines_terminated_by</span> <span class="o">=</span> <span class="n">input_lines_terminated_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">input_optionally_enclosed_by</span> <span class="o">=</span> <span class="n">input_optionally_enclosed_by</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">batch</span> <span class="o">=</span> <span class="n">batch</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">direct</span> <span class="o">=</span> <span class="n">direct</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">driver</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="o">=</span> <span class="n">verbose</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">relaxed_isolation</span> <span class="o">=</span> <span class="n">relaxed_isolation</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">hcatalog_database</span> <span class="o">=</span> <span class="n">hcatalog_database</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">hcatalog_table</span> <span class="o">=</span> <span class="n">hcatalog_table</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">create_hcatalog_table</span> <span class="o">=</span> <span class="n">create_hcatalog_table</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">extra_import_options</span> <span class="o">=</span> <span class="n">extra_import_options</span> <span class="ow">or</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">extra_export_options</span> <span class="o">=</span> <span class="n">extra_export_options</span> <span class="ow">or</span> <span class="p">{}</span>
+
+<div class="viewcode-block" id="SqoopOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.sqoop_operator.SqoopOperator.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="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Execute sqoop job</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="n">SqoopHook</span><span class="p">(</span>
+ <span class="n">conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">conn_id</span><span class="p">,</span>
+ <span class="n">verbose</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">,</span>
+ <span class="n">num_mappers</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_mappers</span><span class="p">,</span>
+ <span class="n">hcatalog_database</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">hcatalog_database</span><span class="p">,</span>
+ <span class="n">hcatalog_table</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">hcatalog_table</span><span class="p">,</span>
+ <span class="n">properties</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">properties</span>
+ <span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmd_type</span> <span class="o">==</span> <span class="s1">'export'</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="n">export_table</span><span class="p">(</span>
+ <span class="n">table</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">,</span>
+ <span class="n">export_dir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">export_dir</span><span class="p">,</span>
+ <span class="n">input_null_string</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_null_string</span><span class="p">,</span>
+ <span class="n">input_null_non_string</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_null_non_string</span><span class="p">,</span>
+ <span class="n">staging_table</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">staging_table</span><span class="p">,</span>
+ <span class="n">clear_staging_table</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">clear_staging_table</span><span class="p">,</span>
+ <span class="n">enclosed_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">enclosed_by</span><span class="p">,</span>
+ <span class="n">escaped_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">escaped_by</span><span class="p">,</span>
+ <span class="n">input_fields_terminated_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_fields_terminated_by</span><span class="p">,</span>
+ <span class="n">input_lines_terminated_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_lines_terminated_by</span><span class="p">,</span>
+ <span class="n">input_optionally_enclosed_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">input_optionally_enclosed_by</span><span class="p">,</span>
+ <span class="n">batch</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">batch</span><span class="p">,</span>
+ <span class="n">relaxed_isolation</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">relaxed_isolation</span><span class="p">,</span>
+ <span class="n">extra_export_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">extra_export_options</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmd_type</span> <span class="o">==</span> <span class="s1">'import'</span><span class="p">:</span>
+ <span class="c1"># add create hcatalog table to extra import options if option passed</span>
+ <span class="c1"># if new params are added to constructor can pass them in here so don't modify sqoop_hook for each param</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_hcatalog_table</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">extra_import_options</span><span class="p">[</span><span class="s1">'create-hcatalog-table'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">''</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
+ <span class="s1">'Cannot specify query and table together. Need to specify either or.'</span>
+ <span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</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="n">import_table</span><span class="p">(</span>
+ <span class="n">table</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="p">,</span>
+ <span class="n">target_dir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">target_dir</span><span class="p">,</span>
+ <span class="n">append</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">,</span>
+ <span class="n">file_type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">file_type</span><span class="p">,</span>
+ <span class="n">columns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">columns</span><span class="p">,</span>
+ <span class="n">split_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">split_by</span><span class="p">,</span>
+ <span class="n">where</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">where</span><span class="p">,</span>
+ <span class="n">direct</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">direct</span><span class="p">,</span>
+ <span class="n">driver</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="p">,</span>
+ <span class="n">extra_import_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">extra_import_options</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</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="n">import_query</span><span class="p">(</span>
+ <span class="n">query</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
+ <span class="n">target_dir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">target_dir</span><span class="p">,</span>
+ <span class="n">append</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">,</span>
+ <span class="n">file_type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">file_type</span><span class="p">,</span>
+ <span class="n">split_by</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">split_by</span><span class="p">,</span>
+ <span class="n">direct</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">direct</span><span class="p">,</span>
+ <span class="n">driver</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="p">,</span>
+ <span class="n">extra_import_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">extra_import_options</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
+ <span class="s2">"Provide query or table parameter to import using Sqoop"</span>
+ <span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"cmd_type should be 'import' or 'export'"</span><span class="p">)</span></div>
+
+ <span class="k">def</span> <span class="nf">on_kill</span><span class="p">(</span><span class="bp">self</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 SIGTERM signal to bash process group'</span><span class="p">)</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">killpg</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpgid</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="n">sp</span><span class="o">.</span><span class="n">pid</span><span class="p">),</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">)</span></div>
+</pre></div>
+
+ </div>
+ <div class="articleComments">
+
+ </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/snide/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:'',
+ 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.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/11437c14/_modules/airflow/contrib/operators/ssh_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/ssh_operator.html b/_modules/airflow/contrib/operators/ssh_operator.html
new file mode 100644
index 0000000..d971825
--- /dev/null
+++ b/_modules/airflow/contrib/operators/ssh_operator.html
@@ -0,0 +1,394 @@
+
+
+<!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.ssh_operator — Airflow Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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"/>
+
+
+ <script src="../../../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+
+ <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" role="navigation" 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.ssh_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.ssh_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">base64</span> <span class="k">import</span> <span class="n">b64encode</span>
+<span class="kn">from</span> <span class="nn">select</span> <span class="k">import</span> <span class="n">select</span>
+
+<span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">configuration</span>
+<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.ssh_hook</span> <span class="k">import</span> <span class="n">SSHHook</span>
+<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</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="SSHOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.ssh_operator.SSHOperator">[docs]</a><span class="k">class</span> <span class="nc">SSHOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> SSHOperator to execute commands on given remote host using the ssh_hook.</span>
+
+<span class="sd"> :param ssh_hook: predefined ssh_hook to use for remote execution</span>
+<span class="sd"> :type ssh_hook: :class:`SSHHook`</span>
+<span class="sd"> :param ssh_conn_id: connection id from airflow Connections</span>
+<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 command: command to execute on remote host</span>
+<span class="sd"> :type command: str</span>
+<span class="sd"> :param timeout: timeout (in seconds) for executing the command.</span>
+<span class="sd"> :type timeout: int</span>
+<span class="sd"> :param do_xcom_push: return the stdout which also get set in xcom by airflow platform</span>
+<span class="sd"> :type do_xcom_push: bool</span>
+<span class="sd"> """</span>
+
+ <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'command'</span><span class="p">,)</span>
+ <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.sh'</span><span class="p">,)</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">ssh_hook</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">ssh_conn_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">remote_host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">command</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+ <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span>
+ <span class="n">do_xcom_push</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">SSHOperator</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">ssh_hook</span> <span class="o">=</span> <span class="n">ssh_hook</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ssh_conn_id</span> <span class="o">=</span> <span class="n">ssh_conn_id</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">remote_host</span> <span class="o">=</span> <span class="n">remote_host</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">command</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">do_xcom_push</span> <span class="o">=</span> <span class="n">do_xcom_push</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="k">try</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssh_conn_id</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span> <span class="o">=</span> <span class="n">SSHHook</span><span class="p">(</span><span class="n">ssh_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ssh_conn_id</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"can not operate without ssh_hook or ssh_conn_id"</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_host</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span><span class="o">.</span><span class="n">remote_host</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">remote_host</span>
+
+ <span class="n">ssh_client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"no command specified so nothing to execute here."</span><span class="p">)</span>
+
+ <span class="c1"># Auto apply tty when its required in case of sudo</span>
+ <span class="n">get_pty</span> <span class="o">=</span> <span class="kc">False</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'sudo'</span><span class="p">):</span>
+ <span class="n">get_pty</span> <span class="o">=</span> <span class="kc">True</span>
+
+ <span class="c1"># set timeout taken as params</span>
+ <span class="n">stdin</span><span class="p">,</span> <span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">ssh_client</span><span class="o">.</span><span class="n">exec_command</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span>
+ <span class="n">get_pty</span><span class="o">=</span><span class="n">get_pty</span><span class="p">,</span>
+ <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span>
+ <span class="p">)</span>
+ <span class="c1"># get channels</span>
+ <span class="n">channel</span> <span class="o">=</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span>
+
+ <span class="c1"># closing stdin</span>
+ <span class="n">stdin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">channel</span><span class="o">.</span><span class="n">shutdown_write</span><span class="p">()</span>
+
+ <span class="n">agg_stdout</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span>
+ <span class="n">agg_stderr</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">''</span>
+
+ <span class="c1"># capture any initial output in case channel is closed already</span>
+ <span class="n">stdout_buffer_length</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">in_buffer</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">stdout_buffer_length</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">agg_stdout</span> <span class="o">+=</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="n">stdout_buffer_length</span><span class="p">)</span>
+
+ <span class="c1"># read from both stdout and stderr</span>
+ <span class="k">while</span> <span class="ow">not</span> <span class="n">channel</span><span class="o">.</span><span class="n">closed</span> <span class="ow">or</span> <span class="n">channel</span><span class="o">.</span><span class="n">recv_ready</span><span class="p">()</span> <span class="ow">or</span> <span class="n">channel</span><span class="o">.</span><span class="n">recv_stderr_ready</span><span class="p">():</span>
+ <span class="n">readq</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">channel</span><span class="p">],</span> <span class="p">[],</span> <span class="p">[],</span> <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">readq</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">recv_ready</span><span class="p">():</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">in_buffer</span><span class="p">))</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="n">line</span>
+ <span class="n">agg_stdout</span> <span class="o">+=</span> <span class="n">line</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="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">recv_stderr_ready</span><span class="p">():</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="n">stderr</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv_stderr</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">in_stderr_buffer</span><span class="p">))</span>
+ <span class="n">line</span> <span class="o">=</span> <span class="n">line</span>
+ <span class="n">agg_stderr</span> <span class="o">+=</span> <span class="n">line</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">))</span>
+ <span class="k">if</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">exit_status_ready</span><span class="p">()</span>\
+ <span class="ow">and</span> <span class="ow">not</span> <span class="n">stderr</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv_stderr_ready</span><span class="p">()</span>\
+ <span class="ow">and</span> <span class="ow">not</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv_ready</span><span class="p">():</span>
+ <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">shutdown_read</span><span class="p">()</span>
+ <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="k">break</span>
+
+ <span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="n">exit_status</span> <span class="o">=</span> <span class="n">stdout</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">recv_exit_status</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">exit_status</span> <span class="ow">is</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="c1"># returning output if do_xcom_push is set</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">do_xcom_push</span><span class="p">:</span>
+ <span class="n">enable_pickling</span> <span class="o">=</span> <span class="n">configuration</span><span class="o">.</span><span class="n">conf</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span>
+ <span class="s1">'core'</span><span class="p">,</span> <span class="s1">'enable_xcom_pickling'</span>
+ <span class="p">)</span>
+ <span class="k">if</span> <span class="n">enable_pickling</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">agg_stdout</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">b64encode</span><span class="p">(</span><span class="n">agg_stdout</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
+
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">error_msg</span> <span class="o">=</span> <span class="n">agg_stderr</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"error running cmd: </span><span class="si">{0}</span><span class="s2">, error: </span><span class="si">{1}</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">command</span><span class="p">,</span> <span class="n">error_msg</span><span class="p">))</span>
+
+ <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"SSH operator error: </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)))</span>
+
+ <span class="k">return</span> <span class="kc">True</span>
+
+ <span class="k">def</span> <span class="nf">tunnel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">ssh_client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ssh_hook</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
+ <span class="n">ssh_client</span><span class="o">.</span><span class="n">get_transport</span><span class="p">()</span></div>
+</pre></div>
+
+ </div>
+ <div class="articleComments">
+
+ </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/snide/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:'',
+ 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.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/11437c14/_modules/airflow/contrib/operators/vertica_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/vertica_operator.html b/_modules/airflow/contrib/operators/vertica_operator.html
new file mode 100644
index 0000000..738cb18
--- /dev/null
+++ b/_modules/airflow/contrib/operators/vertica_operator.html
@@ -0,0 +1,284 @@
+
+
+<!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.vertica_operator — Airflow Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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"/>
+
+
+ <script src="../../../../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+
+ <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" role="navigation" 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.vertica_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.vertica_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.vertica_hook</span> <span class="k">import</span> <span class="n">VerticaHook</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="VerticaOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.vertica_operator.VerticaOperator">[docs]</a><span class="k">class</span> <span class="nc">VerticaOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Executes sql code in a specific Vertica database</span>
+
+<span class="sd"> :param vertica_conn_id: reference to a specific Vertica database</span>
+<span class="sd"> :type vertica_conn_id: string</span>
+<span class="sd"> :param sql: the sql code to be executed</span>
+<span class="sd"> :type sql: Can receive a str representing a sql statement,</span>
+<span class="sd"> a list of str (sql statements), or reference to a template file.</span>
+<span class="sd"> Template reference are recognized by str ending in '.sql'</span>
+<span class="sd"> """</span>
+
+ <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'sql'</span><span class="p">,)</span>
+ <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.sql'</span><span class="p">,)</span>
+ <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#b4e0ff'</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">sql</span><span class="p">,</span> <span class="n">vertica_conn_id</span><span class="o">=</span><span class="s1">'vertica_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="nb">super</span><span class="p">(</span><span class="n">VerticaOperator</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">vertica_conn_id</span> <span class="o">=</span> <span class="n">vertica_conn_id</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">sql</span> <span class="o">=</span> <span class="n">sql</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="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">'Executing: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql</span><span class="p">)</span>
+ <span class="n">hook</span> <span class="o">=</span> <span class="n">VerticaHook</span><span class="p">(</span><span class="n">vertica_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">vertica_conn_id</span><span class="p">)</span>
+ <span class="n">hook</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sql</span><span class="p">)</span></div>
+</pre></div>
+
+ </div>
+ <div class="articleComments">
+
+ </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/snide/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:'',
+ 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.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file